Parameter

class imgreg.util.params.Parameter(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: object

Base Parameter class, aware of related Parameters and lazy evaluating.

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.

Attributes

children	Parameters with a child relation to this Parameters instance.
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.
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 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 const

Flag if the value can be overwritten once initialized.

property descendants

Parameters with a descendant relation to this Parameters instance.

property enum_id

Returns the Parameter ID as an enumeration.

property parents

Parent Parameters of this Parameters instance.

property type_info

The type of this Parameter.

property value

The value of this Parameter.