ImageViewerState

class glue.viewers.image.state.ImageViewerState(**kwargs)[source]

Bases: glue.viewers.matplotlib.state.MatplotlibDataViewerState

A state class that includes all the attributes for an image viewer.

Attributes Summary

aspect Whether to enforce square pixels (equal) or fill the axes (auto)
color_mode Whether each layer can have its own colormap (Colormaps) or whether each layer is assigned a single color (One color per layer)
layers A collection of all layers in the viewer
layers_data
numpy_slice_aggregation_transpose Returns slicing information usable by Numpy.
reference_data The dataset that is used to define the available pixel/world components, and which defines the coordinate frame in which the images are shown
slices The current slice along all dimensions
wcsaxes_slice Returns slicing information usable by WCSAxes.
x_att The component ID giving the pixel component shown on the x axis
x_att_world The component ID giving the world component shown on the x axis
x_log Whether the x axis is logarithmic
x_max Upper limit of the visible x range
x_min Lower limit of the visible x range
y_att The component ID giving the pixel component shown on the y axis
y_att_world The component ID giving the world component shown on the y axis
y_log Whether the y axis is logarithmic
y_max Upper limit of the visible y range
y_min Lower limit of the visible y range

Methods Summary

add_callback(name, callback[, echo_old, …]) Add a callback that gets triggered when a callback property of the class changes.
add_global_callback(callback) Add a global callback function, which is a callback that gets triggered when any callback properties on the class change.
as_dict() Return the current state as a dictionary of attribute/value pairs.
flip_x() Flip the x_min/x_max limits.
flip_y() Flip the y_min/y_max limits.
is_callback_property(name) Whether a property (identified by name) is a callback property.
iter_callback_properties() Iterator to loop over all callback properties.
remove_callback(name, callback) Remove a previously-added callback
remove_global_callback(callback) Remove a global callback function.
reset_limits()
update_from_dict(properties) Update this state using the values from a dictionary of attributes.
update_from_state(state) Update this state using the values from another state.

Attributes Documentation

aspect

Whether to enforce square pixels (equal) or fill the axes (auto)

color_mode

Whether each layer can have its own colormap (Colormaps) or whether each layer is assigned a single color (One color per layer)

layers

A collection of all layers in the viewer

layers_data
numpy_slice_aggregation_transpose[source]

Returns slicing information usable by Numpy.

This returns two objects: the first is an object that can be used to slice Numpy arrays and return a 2D array, and the second object is a boolean indicating whether to transpose the result.

reference_data

The dataset that is used to define the available pixel/world components, and which defines the coordinate frame in which the images are shown

slices

The current slice along all dimensions

wcsaxes_slice[source]

Returns slicing information usable by WCSAxes.

This returns an iterable of slices, and including 'x' and 'y' for the dimensions along which we are not slicing.

x_att

The component ID giving the pixel component shown on the x axis

x_att_world

The component ID giving the world component shown on the x axis

x_log

Whether the x axis is logarithmic

x_max

Upper limit of the visible x range

x_min

Lower limit of the visible x range

y_att

The component ID giving the pixel component shown on the y axis

y_att_world

The component ID giving the world component shown on the y axis

y_log

Whether the y axis is logarithmic

y_max

Upper limit of the visible y range

y_min

Lower limit of the visible y range

Methods Documentation

add_callback(name, callback, echo_old=False, priority=0)

Add a callback that gets triggered when a callback property of the class changes.

Parameters:

name : str

The instance to add the callback to.

callback : func

The callback function to add

echo_old : bool, optional

If True, the callback function will be invoked with both the old and new values of the property, as callback(old, new). If False (the default), will be invoked as callback(new)

priority : int, optional

This can optionally be used to force a certain order of execution of callbacks (larger values indicate a higher priority).

add_global_callback(callback)

Add a global callback function, which is a callback that gets triggered when any callback properties on the class change.

Parameters:

callback : func

The callback function to add

as_dict()

Return the current state as a dictionary of attribute/value pairs.

flip_x()[source]

Flip the x_min/x_max limits.

flip_y()[source]

Flip the y_min/y_max limits.

is_callback_property(name)

Whether a property (identified by name) is a callback property.

Parameters:

name : str

The name of the property to check

iter_callback_properties()

Iterator to loop over all callback properties.

remove_callback(name, callback)

Remove a previously-added callback

Parameters:

name : str

The instance to remove the callback from.

func : func

The callback function to remove

remove_global_callback(callback)

Remove a global callback function.

Parameters:

callback : func

The callback function to remove

reset_limits()[source]
update_from_dict(properties)

Update this state using the values from a dictionary of attributes.

Parameters:

properties : dict

The dictionary containing attribute/value pairs.

update_from_state(state)

Update this state using the values from another state.

Parameters:

state : ~glue.core.state_objects.State

The state to use the values from