RGB module

class lys.widgets.canvas.interface.RGB.RGBData(canvas, wave, axis)[source]

Bases: WaveData

Interface to access rgb data in the canvas.

Instance of RGBData is automatically generated by display or append methods.

getAutoColorRange()[source]

Get the automarically-calculated color range of the image, which is used by setColorRange() method.

Returns

minimum and maximum value of the range.

Return type

tuple of length 2

getColorRange()[source]

Get the color range of the image.

Returns

minimum and maximum value of the range.

Return type

tuple of length 2

getColorRotation()[source]

Get color rotation of the RGB image.

Returns

The rotation.

Return type

float

getColormapData(size=50)[source]
getColormapPosition()[source]

Get the position of the colormap.

Returns

The position of the colormap.

Return type

length 2 sequence

getColormapSize()[source]

Get the size of the colormap.

Returns

The size of the colormap.

Return type

float

getColormapVisible()[source]

Get the visibility of the colormap.

Returns

The visibility.

Return type

bool

getRGBWave()[source]

Return RGB wave data that is used to display.

Returns

The RGB data.

Return type

Wave

setColorRange(min='auto', max='auto')[source]

Set the color range of the image.

Parameters

  • min (float or 'auto') – The minimum value of the range.

  • max (float or 'auto') – The maximum value of the range.

setColorRotation(rot)[source]

Rotate color map of the RGB image if the data is complex.

Parameters

rot (float) – The rotation.

setColormapPosition(pos)[source]

Set the position of the colormap.

Parameters

pos (length 2 sequence) – The position of the colormap

setColormapSize(size)[source]

Set the size of the colormap.

Parameters

size (float) – The size of the colormap

setColormapVisible(visible)[source]

Set the visibility of the colormap.

Parameters

visible (bool) – The visibility.