Staircase¶

(Source code, png, hires.png, pdf)

class Staircase(*args)¶

Staircase.

Available constructors:

Staircase(data, legend=’ ‘)

Staircase(data, color, lineStyle, lineWidth, pattern, legend=’ ‘)

Staircase(data, color, lineStyle, pattern, legend=’ ‘)

Parameters

data2-d sequence of float: Points from which the Staircase is built, must be of dimension 2: the discontinuous points and their corresponding height.
legendstr: Legend of the Staircase.
colorstr: Color of the curve. If not specified, by default it is ‘blue’.
lineStylestr: Style of the curve. If not specified, by default it is ‘solid’.
lineWidthfloat: Width of the curve. If not specified, by default it is 1.
patternstr: Pattern which is ‘S’ or ‘s’. By default the pattern is equal to ‘s’. Going from $(x_1, y_1)$ to $(x_2, y_2)$ with $x_1<x_2$ , pattern=’s’ moves first horizontal then vertical, whereas pattern=’S’ moves the other way around.

Examples

>>> import openturns as ot
>>> distribution = ot.Normal([0.5], [2.], ot.CorrelationMatrix(1))
>>> sample = distribution.getSample(200)
>>> # Construct empirical CDF for the sample
>>> data = ot.Sample(20, 2)
>>> cursor = ot.Point(2)
>>> for i in range(20):
...     cursor[0] = 13.0 * i / 20.0 - 6.5
...     count = 0
...     for j in range(200):
...         if(sample[j, 0] < cursor[0]):
...             count += 1
...     cursor[1] = count / 200.0
...     data[i] = cursor
>>> # Create an empty graph
>>> myGraph = ot.Graph('A staircase', 'x1', 'x2', True, 'topleft')
>>> # Create the staircase
>>> myStaircase = ot.Staircase(data, 'blue', 'solid', 's', 'Normal CDF')
>>> myGraph.add(myStaircase)

Methods

`BuildDefaultPalette`(size)	Build default palette.
`BuildRainbowPalette`(size)	Build rainbow palette.
`BuildTableauPalette`(size)	Build tableau palette.
`ConvertFromHSV`(hue, saturation, value)	Convert an HSV triplet to a valid hexadecimal code.
`ConvertFromHSVA`(hue, saturation, value, alpha)	Convert an HSVA quadruplet to a valid hexadecimal code.
`ConvertFromHSVIntoRGB`(hue, saturation, value)	Convert an HSV triplet into an RGB triplet.
`ConvertFromName`(name)	Convert a color name to a valid hexadecimal code.
`ConvertFromRGB`(*args)	Convert an RGB triplet to a valid hexadecimal code.
`ConvertFromRGBA`(*args)	Convert an RGBA quadruplet to a valid hexadecimal code.
`ConvertFromRGBIntoHSV`(*args)	Convert an RGB triplet to HSV triplet.
`ConvertToRGB`(key)	Convert an hexadecimal code into an RGB triplet.
`ConvertToRGBA`(key)	Convert an hexadecimal code into an RGBA quadruplet.
`GetValidColors`()	Return the list of the valid colors of the drawable element.
`GetValidFillStyles`()	Return the list of the valid fill styles of the drawable element.
`GetValidLineStyles`()	Return the list of the valid line styles of the drawable element.
`GetValidPointStyles`()	Return the list of the valid point styles of the drawable element.
`clean`()	Clean all the temporary data created by `draw()` method.
`draw`()	Generate R command for plotting through R.
`getBoundingBox`()	Accessor to the bounding box of the whole plot.
`getCenter`()	Accessor to the center of the Pie inside the bounding box.
`getClassName`()	Accessor to the object’s name.
`getColor`()	Accessor to the color of the drawable element.
`getColorCode`()	Accessor to the code of the color of the drawable element.
`getData`()	Accessor to the data from which the Drawable is built.
`getDrawLabels`()	Accessor to the indication of data labels’ presence within the drawable element.
`getEdgeColor`()	Accessor to the color of the Polygon edge.
`getFillStyle`()	Accessor to the fill style of the drawable element.
`getId`()	Accessor to the object’s id.
`getLabels`()	Accessor to the labels of data.
`getLegend`()	Accessor to the legend of the drawable element.
`getLevels`()	Accessor to the levels of the Contour.
`getLineStyle`()	Accessor to the line style of the drawable element.
`getLineWidth`()	Accessor to the line width of the drawable element.
`getName`()	Accessor to the object’s name.
`getOrigin`()	Accessor to the origin of the BarPlot.
`getPalette`()	Accessor to the names of the colors used for the Drawable.
`getPaletteAsNormalizedRGBA`()	Accessor to the Red, Green, Blue, Alpha components of the palette on a unit scale.
`getPattern`()	Accessor to the pattern of the Staircase.
`getPointCode`(key)	Accessor to the code of the points style.
`getPointStyle`()	Accessor to the point style of the drawable element.
`getRadius`()	Accessor to the radius of the Pie.
`getShadowedId`()	Accessor to the object’s shadowed id.
`getTextAnnotations`()	Accessor to the annotations of the Text.
`getTextPositions`()	Accessor to the position of annotations.
`getTextSize`()	Accessor to the text size.
`getVisibility`()	Accessor to the object’s visibility state.
`getX`()	Accessor to the first coordinate.
`getY`()	Accessor to the second coordinate.
`hasName`()	Test if the object is named.
`hasVisibleName`()	Test if the object has a distinguishable name.
`setCenter`(center)	Accessor to the center of the Pie inside the bounding box.
`setColor`(color)	Accessor to the color of the drawable element.
`setDrawLabels`(drawLabels)	Accessor to the indication of data labels’ presence within the drawable element.
`setFillStyle`(fillStyle)	Accessor to the fill style of the drawable element.
`setLabels`(labels)	Accessor to the labels of data.
`setLegend`(legend)	Accessor to the legend of the drawable element.
`setLevels`(levels)	Accessor to the levels of the Contour.
`setLineStyle`(lineStyle)	Accessor to the line style of the drawable element.
`setLineWidth`(lineWidth)	Accessor to the line width of the drawable element.
`setName`(name)	Accessor to the object’s name.
`setOrigin`(origin)	Accessor to the origin of the BarPlot.
`setPalette`(palette)	Accessor to the names of the colors used for the Pie.
`setPattern`(style)	Accessor to the pattern of the Staircase.
`setPointStyle`(pointStyle)	Accessor to the point style of the drawable element.
`setRadius`(radius)	Accessor to the radius of the Pie.
`setShadowedId`(id)	Accessor to the object’s shadowed id.
`setTextAnnotations`(textAnnotations)	Accessor to the annotations of the Text.
`setTextPositions`(textPositions)	Accessor to the position of annotations.
`setTextSize`(size)	Accessor to the text size.
`setVisibility`(visible)	Accessor to the object’s visibility state.
`setX`(x)	Accessor to the first coordinate.
`setY`(y)	Accessor to the second coordinate.

__init__(*args)¶: Initialize self. See help(type(self)) for accurate signature.

static BuildDefaultPalette(size)¶

Build default palette.

Parameters

nint $n > 0$: Number of colors needed.

Returns

listColorsDescription: List of n color codes defined according to the default palette.

Notes

This function uses the ‘Drawable-DefaultPaletteName’ key of the ResourceMap, which can be equal to either ‘Tableau’ or ‘Rainbow’.

Examples

>>> import openturns as ot
>>> print(ot.Drawable().BuildDefaultPalette(4))
[#1f77b4,#ff7f0e,#2ca02c,#d62728]
>>> name = ot.ResourceMap.GetAsString('Drawable-DefaultPaletteName')
>>> ot.ResourceMap.SetAsString('Drawable-DefaultPaletteName', 'Rainbow')
>>> print(ot.Drawable.BuildDefaultPalette(4))
[#ff0000,#ccff00,#00ff66,#0066ff]
>>> ot.ResourceMap.SetAsString('Drawable-DefaultPaletteName', 'Tableau')
>>> print(ot.Drawable.BuildDefaultPalette(4))
[#1f77b4,#ff7f0e,#2ca02c,#d62728]

static BuildRainbowPalette(size)¶

Build rainbow palette.

Parameters

nint $n > 0$: Number of colors needed.

Returns

listColorsDescription: List of n color codes defined according to the rainbow palette.

Notes

The colors are generated in the HSV space, with H (the hue) varying in a number of different values given by ‘Drawable-DefaultPalettePhase’ in ResourceMap and V (the value) being decreased linearly at each cycle of the hue.

Examples

>>> import openturns as ot
>>> print(ot.Drawable().BuildRainbowPalette(4))
[#ff0000,#ccff00,#00ff66,#0066ff]

static BuildTableauPalette(size)¶

Build tableau palette.

Parameters

nint $n > 0$ and $n < 10$: Number of colors needed.

Returns

listColorsDescription: List of n color codes defined according to the tableau palette.

Notes

The colors are generated in the HSV space. When the number of colors is greater than 10, the value V decreases linearily depending on the ‘Drawable-DefaultPalettePhase’ key of the ResourceMap for each block of 10 colors.

Examples

>>> import openturns as ot
>>> print(ot.Drawable().BuildTableauPalette(4))
[#1f77b4,#ff7f0e,#2ca02c,#d62728]

static ConvertFromHSV(hue, saturation, value)¶

Convert an HSV triplet to a valid hexadecimal code.

Parameters

huefloat: Hue.
saturationfloat: Saturation.
valuefloat: Value.

Returns

codestr: Hexadecimal code of the color.

static ConvertFromHSVA(hue, saturation, value, alpha)¶

Convert an HSVA quadruplet to a valid hexadecimal code.

Parameters

huefloat: Hue.
saturationfloat: Saturation.
valuefloat: Value.
alphafloat: Alpha component.

Returns

codestr: Hexadecimal code of the color.

static ConvertFromHSVIntoRGB(hue, saturation, value)¶

Convert an HSV triplet into an RGB triplet.

Parameters

huefloat: Hue with 0<=hue<=360.
saturationfloat: Saturation with 0<=saturation<=1.
valuefloat: Value with 0<=value<=1.

Returns

RGBComponentsPoint: RGB (Red, Green and Blue) components of the color.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.ConvertFromHSVIntoRGB(215.0, 0.2, 0.3))
[0.24,0.265,0.3]

static ConvertFromName(name)¶

Convert a color name to a valid hexadecimal code.

Parameters

namestr: Name of the color. The valid color names are given by the GetValidColors() method.

Returns

codestr: Hexadecimal code of the color.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.ConvertFromName('red'))
#FF0000

static ConvertFromRGB(*args)¶

Convert an RGB triplet to a valid hexadecimal code.

Parameters

red, green and blueeither three nonnegative integers or three nonnegative floats: These values are the Red, Green and Blue components of a color, a value of 0 (or 0.0) meaning that the component is absent in the color, a value of 255 (or 1.0) meaning that the component is fully saturated.

Returns

codestr: Hexadecimal code of the color.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.ConvertFromRGB(255,0,0))
#ff0000

static ConvertFromRGBA(*args)¶

Convert an RGBA quadruplet to a valid hexadecimal code.

Parameters

red, green and blueeither three nonnegative integers or three nonnegative floats: These values are the Red, Green and Blue components of a color, a value of 0 (or 0.0) meaning that the component is absent in the color, a value of 255 (or 1.0) meaning that the component is fully saturated.
alphaeither nonnegative integer or nonnegative float: Level of the color’s transparency, 0 (or 0.0) meaning that the color is fully transparent and 255 (or 1.0) meaning that the color is fully opaque. The alpha channel is only supported by a few devices, namely the PDF and PNG formats, for the other format the color is fully transparent as soon as its alpha channel is less than 255 (or 1.0).

Returns

codestr: Hexadecimal code of the color.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.ConvertFromRGBA(255,0,0,255))
#ff0000ff

static ConvertFromRGBIntoHSV(*args)¶

Convert an RGB triplet to HSV triplet.

Parameters

redfloat: Red with 0<=red<=1.
greenfloat: Green with 0<=green<=1.
bluefloat: Blue with 0<=blue<=1.

Returns

HSVComponentsPoint: HSV (hue, saturation and value) components of the color where 0<=hue<=360, 0<=saturation<=1, 0<=value<=255.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.ConvertFromRGBIntoHSV(0.8, 0.6, 0.4))
[30,0.5,0.8]

static ConvertToRGB(key)¶

Convert an hexadecimal code into an RGB triplet.

Parameters

codestr: Hexadecimal code of the color.

Returns

RGBComponentsIndices: List containing the RGB (Red, Green and Blue) components of the color. A value of 0 meaning that the component is absent in the color, a value of 255 meaning that the component is fully saturated.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.ConvertToRGB('#ff0000'))
[255,0,0]

static ConvertToRGBA(key)¶

Convert an hexadecimal code into an RGBA quadruplet.

Parameters

codestr: Hexadecimal code of the color.

Returns

RGBAComponentsIndices: List containing the RGB (Red, Green and Blue) components. A value of 0 meaning that the component is absent in the color, a value of 255 meaning that the component is fully saturated. It contains also alpha, the level of transparency of the color. Alpha equal to 0 meaning that the color is fully transparent and 255 meaning that the color is fully opaque.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.ConvertToRGBA('#ff0000'))
[255,0,0,255]

static GetValidColors()¶

Return the list of the valid colors of the drawable element.

Returns

validColorsDescription: List of the valid colors of the drawable element.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.GetValidColors()[:5])
[aliceblue,antiquewhite,antiquewhite1,antiquewhite2,antiquewhite3]

static GetValidFillStyles()¶

Return the list of the valid fill styles of the drawable element.

Returns

validFillStylesDescription: List of the valid fill styles of the drawable element.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.GetValidFillStyles()[:2])
[solid,shaded]

static GetValidLineStyles()¶

Return the list of the valid line styles of the drawable element.

Returns

validLineStylesDescription: List of the valid line styles of the drawable element.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.GetValidLineStyles())
[blank,solid,dashed,dotted,dotdash,longdash,twodash]

static GetValidPointStyles()¶

Return the list of the valid point styles of the drawable element.

Returns

validPointStylesDescription: List of the valid point styles of the drawable element.

Examples

>>> import openturns as ot
>>> print(ot.Drawable().GetValidPointStyles()[:5])
[bullet,circle,diamond,dot,fcircle]

clean()¶: Clean all the temporary data created by draw() method.

draw()¶

Generate R command for plotting through R.

Returns

commandstr: R command used mainly by the draw method of Graph.

getBoundingBox()¶

Accessor to the bounding box of the whole plot.

Returns

boundingBoxInterval of dimension 2: Bounding box of the drawable element

getCenter()¶

Accessor to the center of the Pie inside the bounding box.

Returns

centerPoint: Center of the Pie inside the bounding box.

getClassName()¶

Accessor to the object’s name.

Returns

class_namestr: The object class name (object.__class__.__name__).

getColor()¶

Accessor to the color of the drawable element.

Returns

colorstr: Name of the color of the lines within the drawable element. It can be either the name of a color (e.g. ‘red’) or an hexadecimal code corresponding to the RGB (Red, Green, Blue) components of the color (e.g. ‘#A1B2C3’) or the RGBA (Red, Green, Blue, Alpha) components of the color (e.g. ‘#A1B2C3D4’). The alpha channel is taken into account only by the PDF and PNG formats, for the other format the color is fully transparent as soon as its alpha channel is less than 255 (or 1.0). Use GetValidColors() for a list of available values.

See also

setColor, getColor, GetValidColors, setColorCode

Examples

>>> import openturns as ot
>>> print(ot.Drawable().getColorCode())
#0000FF

getData()¶

Accessor to the data from which the Drawable is built.

Returns

dataSample: Data from which the Drawable is built.

getDrawLabels()¶

Accessor to the indication of data labels’ presence within the drawable element.

Returns

drawLabelsbool: True to draw the data labels, False to hide them.

getEdgeColor()¶

Accessor to the color of the Polygon edge.

Returns

edgeColorstr: Color of the edge of the Polygon.

getFillStyle()¶

Accessor to the fill style of the drawable element.

Returns

fillStylestr: Fill style of the surfaces within the drawable element. Use GetValidFillStyles() for a list of available values.

Examples

>>> import openturns as ot
>>> print(ot.Drawable().getFillStyle())
solid

getId()¶

Accessor to the object’s id.

Returns

idint: Internal unique identifier.

getLabels()¶

Accessor to the labels of data.

Returns

labelsDescription: Describes the data within the drawable element.

getLegend()¶

Accessor to the legend of the drawable element.

Returns

legendstr: Legend of the drawable element.

getLevels()¶

Accessor to the levels of the Contour.

Returns

levelsPoint: Different levels where the iso-curves of the Contour will be drawn.

getLineStyle()¶

Accessor to the line style of the drawable element.

Returns

lineStylestr: Style of the line within the drawable element. Use GetValidLineStyles() for a list of available values.

Examples

>>> import openturns as ot
>>> print(ot.Drawable().getLineStyle())
solid

getLineWidth()¶

Accessor to the line width of the drawable element.

Returns

lineWidthfloat: Width of the line within the drawable element.

getName()¶

Accessor to the object’s name.

Returns

namestr: The name of the object.

getOrigin()¶

Accessor to the origin of the BarPlot.

Returns

originfloat: Value where the BarPlot begins.

getPalette()¶

Accessor to the names of the colors used for the Drawable.

Returns

paletteDescription: Names of the colors used for the Drawable. It can be either the name of a color (e.g. ‘red’) or an hexadecimal code corresponding to the RGB (Red, Green, Blue) components of the color (e.g. ‘#A1B2C3’) or the RGBA (Red, Green, Blue, Alpha) components of the color (e.g. ‘#A1B2C3D4’).

getPaletteAsNormalizedRGBA()¶

Accessor to the Red, Green, Blue, Alpha components of the palette on a unit scale.

Returns

normalizedRGBAPaletteSample: Sample of the four components of each color of the palette on a unit $[0,1]$ scale.

getPattern()¶

Accessor to the pattern of the Staircase.

Returns

patternstr: Pattern of the Staircase which is ‘S’ or ‘s’. By default the pattern is equal to ‘s’. Going from $(x_1, y_1)$ to $(x_2, y_2)$ with $x_1<x_2$ , pattern=’s’ moves first horizontal then vertical, whereas pattern=’S’ moves the other way around.

getPointCode(key)¶

Accessor to the code of the points style.

Parameters

pointStylestr: Style point to be changed in code.

Returns

codeint: Code of the style of the points within the drawable element.

getPointStyle()¶

Accessor to the point style of the drawable element.

Returns

pointStylestr: Style of the points within the drawable element. Use :meth:GetValidPointStyles for a list of available values.

Examples

>>> import openturns as ot
>>> print(ot.Drawable().getPointStyle())
none

getRadius()¶

Accessor to the radius of the Pie.

Returns

radiusfloat: Radius of the Pie.

getShadowedId()¶

Accessor to the object’s shadowed id.

Returns

idint: Internal unique identifier.

getTextAnnotations()¶

Accessor to the annotations of the Text.

Returns

annotationsDescription: Accessor to text annotations.

getTextPositions()¶

Accessor to the position of annotations.

Returns

positionsIndices: Accessor to text position with respect to data coordinates. Text is written below (position=1), above (position=3), to the left (position=2) or to the right (position=4) of data coordinates.

getTextSize()¶

Accessor to the text size.

Returns

sizefloat: Size of the Text.

Notes

The default value is 0.75.

getVisibility()¶

Accessor to the object’s visibility state.

Returns

visiblebool: Visibility flag.

getX()¶

Accessor to the first coordinate.

Returns

firstCoordSample: Values of the first coordinate.

getY()¶

Accessor to the second coordinate.

Returns

secondCoordSample: Values of the second coordinate.

hasName()¶

Test if the object is named.

Returns

hasNamebool: True if the name is not empty.

hasVisibleName()¶

Test if the object has a distinguishable name.

Returns

hasVisibleNamebool: True if the name is not empty and not the default one.

setCenter(center)¶

Accessor to the center of the Pie inside the bounding box.

Parameters

centersequence of float: Center of the Pie inside the bounding box.

setColor(color)¶

Accessor to the color of the drawable element.

Parameters

colorstr: Describes the color of the lines within the drawable element. It can be either the name of a color (e.g. ‘red’) or an hexadecimal code corresponding to the RGB (Red, Green, Blue) components of the color (e.g. ‘#A1B2C3’) or the RGBA (Red, Green, Blue, Alpha) components of the color (e.g. ‘#A1B2C3D4’). The alpha channel is taken into account only by the PDF and PNG formats, for the other format the color is fully transparent as soon as its alpha channel is less than 255 (or 1.0). Use GetValidColors() for a list of available values.

OpenTURNS

An Open source initiative for the Treatment of Uncertainties, Risks'N Statistics

Previous topic

Next topic

This Page

Staircase¶