RefImageParam

class imgreg.models.logpolar.params.RefImageParam(image: Optional[numpy.ndarray] = None)

Reference image.

Attributes

valuenumpy.ndarray

The value of this Parameter.

Methods

__init__([image])	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.