Cloud¶

(Source code, png)

class Cloud(*args)¶

Cloud.

Available constructors:

Cloud(data, legend=’ ‘)

Cloud(dataX, dataY, legend=’ ‘)

Cloud(data, color, pointStyle, legend=’ ‘)

Cloud(dataComplex, legend=’ ‘)

Parameters:

data2-d sequence of float: Points from which the cloud is built.
dataX, dataYtwo 2-d sequences of float of dimension 1, or two sequences of float: Points from which the cloud is built.
legendstr: Legend of the Cloud.
colorstr: Color of the points. If not specified, the default color is the first color in the default palette.
pointStylestr: Style of the points. If not specified, by default it is ‘plus’.
dataComplexComplexCollection: Collection of complex points.

Examples

>>> import openturns as ot
>>> R = ot.CorrelationMatrix(2)
>>> R[1, 0] = -0.25
>>> distribution = ot.Normal([-1.5, 0.5], [4.0, 1.0], R)
>>> sample = distribution.getSample(100)
>>> # Create an empty graph
>>> myGraph = ot.Graph('Normal sample', 'x1', 'x2', True, '')
>>> # Create the cloud
>>> myCloud = ot.Cloud(sample, 'blue', 'fsquare', 'My Cloud')
>>> myGraph.add(myCloud)

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.
`GetValidColorBarPositions`()	Return the list of the valid color bar positions of contour drawables.
`GetValidColorMaps`()	Return the list of the valid color maps of contour drawables.
`GetValidColors`()	Return the list of the valid colors of the drawable element.
`GetValidExtends`()	Return the list of the valid coloration extends of contour drawables.
`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.
`GetValidNorms`()	Return the list of the valid norms of contour drawables.
`GetValidPointStyles`()	Return the list of the valid point styles of the drawable element.
`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.
`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.
`getPointStyle`()	Accessor to the point style of the drawable element.
`getRadius`()	Accessor to the radius of the Pie.
`getTextAnnotations`()	Accessor to the annotations of the Text.
`getTextPositions`()	Accessor to the position of annotations.
`getTextSize`()	Accessor to the text size.
`getX`()	Accessor to the first coordinate.
`getY`()	Accessor to the second coordinate.
`hasName`()	Test if the object is named.
`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.
`setTextAnnotations`(textAnnotations)	Accessor to the annotations of the Text.
`setTextPositions`(textPositions)	Accessor to the position of annotations.
`setTextSize`(size)	Accessor to the text size.
`setX`(x)	Accessor to the first coordinate.
`setY`(y)	Accessor to the second coordinate.

__init__(*args)¶

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]
>>> 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]
>>> ot.ResourceMap.Reload()

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 GetValidColorBarPositions()¶

Return the list of the valid color bar positions of contour drawables.

Returns:

validColorBarPositionsDescription: List of the valid color bar positions of contour drawables.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.GetValidColorBarPositions())
[,left,right,top,bottom]

static GetValidColorMaps()¶

Return the list of the valid color maps of contour drawables.

Returns:

validColorMapsDescription: List of the valid color map names of contour drawables.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.GetValidColorMaps()[:3])
[,magma,inferno]

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 GetValidExtends()¶

Return the list of the valid coloration extends of contour drawables.

Returns:

validExtendsDescription: List of the valid coloration extends of contour drawables.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.GetValidExtends())
[neither,both,min,max]

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 GetValidNorms()¶

Return the list of the valid norms of contour drawables.

Returns:

validNormsDescription: List of the valid norms of contour drawables.

Notes

These norms are strings that can be passed as the norm parameter of a Matplotlib contour object, except rank which scales the colormap based on the ranks of the data values.

Examples

>>> import openturns as ot
>>> print(ot.Drawable.GetValidNorms())
[asinh,linear,log,logit,symlog,rank]

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())
[square,circle,triangleup,plus,times,...

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.