matflow.param_classes.orientations.OrientationRepresentation

class matflow.param_classes.orientations.OrientationRepresentation(type: matflow.param_classes.orientations.OrientationRepresentationType, euler_definition: matflow.param_classes.orientations.EulerDefinition | None = None, euler_is_degrees: bool | None = None, quat_order: matflow.param_classes.orientations.QuatOrder | None = None)

Bases: ParameterValue

Methods

dump_to_HDF5_group	Write this parameter value to an HDF5 group.
prepare_JSON_dump	Prepare this parameter value for serialisation as JSON.
save_from_HDF5_group	Extract a parameter value from an HDF5 group.
save_from_JSON	Extract a parameter value from JSON data.
to_dict	Serialise this parameter value as a dictionary.

Attributes

euler_definition
euler_is_degrees
quat_order
type

Parameters:

• type (OrientationRepresentationType) –

• euler_definition (EulerDefinition | None) –

• euler_is_degrees (bool | None) –

• quat_order (QuatOrder | None) –

dump_to_HDF5_group(group)

Write this parameter value to an HDF5 group.

euler_definition: EulerDefinition | None = None

euler_is_degrees: bool | None = None

prepare_JSON_dump()

Prepare this parameter value for serialisation as JSON.

Return type:

Dict

quat_order: QuatOrder | None = None

classmethod save_from_HDF5_group(group, param_id, workflow)

Extract a parameter value from an HDF5 group.

Parameters:

param_id (int) –

classmethod save_from_JSON(data, param_id, workflow)

Extract a parameter value from JSON data.

Parameters:

param_id (int) –

to_dict()

Serialise this parameter value as a dictionary.

type: OrientationRepresentationType