ImageParameter

class imgreg.util.params.ImageParameter(enum_id: enum.Enum, value_definition: Union[Type[Any], Callable[[Dict[enum.Enum, imgreg.util.params.Parameter]], Any]], parent_parameters: Optional[Set[imgreg.util.params.Parameter]] = None)

Bases: imgreg.util.params.Parameter

Parameter with additional display functionality for stored image.

Methods

__init__(enum_id, value_definition[, …])	Initialize self.
add_child(child)	Assign a Parameter a child relation
add_descendant(descendant)	Assign a Parameter a child relation
clear([clear_descendants])	Clear the value stored in this and dependent Parameters.
display([axsp])	Display the stored image using matplotlib.
set_bounds_lookup(bounds_enum_id)	Reference a boundary Parameter using its enum_id as a lookup for cropping.

Attributes

aspect	The aspect ratio used by matplotlib.
bounds	Cropping boundaries for the display function.
children	Parameters with a child relation to this Parameters instance.
cmap	The colormap used by matplotlib.
const	Flag if the value can be overwritten once initialized.
descendants	Parameters with a descendant relation to this Parameters instance.
enum_id	Returns the Parameter ID as an enumeration.
parents	Parent Parameters of this Parameters instance.
title	The image title used by the display function.
type_info	The type of this Parameter.
value	The value of this Parameter.

add_child(child: imgreg.util.params.Parameter) → None

Assign a Parameter a child relation

add_descendant(descendant: imgreg.util.params.Parameter) → None

Assign a Parameter a child relation

property aspect

The aspect ratio used by matplotlib.

property bounds

Cropping boundaries for the display function.

property children

Parameters with a child relation to this Parameters instance.

clear(clear_descendants=True) → None

Clear the value stored in this and dependent Parameters.

property cmap

The colormap used by matplotlib.

property const

Flag if the value can be overwritten once initialized.

property descendants

Parameters with a descendant relation to this Parameters instance.

display(axsp: Optional[Any] = None)

Display the stored image using matplotlib.

Parameters

aspxmatplotlib.axes._subplots.AxesSubplot

AxesSubplot on which to draw

Notes

Uses the title, cmap and bounds properties of the ImageParameter class.

property enum_id

Returns the Parameter ID as an enumeration.

property parents

Parent Parameters of this Parameters instance.

set_bounds_lookup(bounds_enum_id: enum.Enum)

Reference a boundary Parameter using its enum_id as a lookup for cropping.

property title

The image title used by the display function.

property type_info

The type of this Parameter.

property value

The value of this Parameter.