matflow.param_classes.orientations.OrientationRepresentation#

class matflow.param_classes.orientations.OrientationRepresentation(type, euler_definition=None, euler_is_degrees=None, quat_order=None)#

Bases: ParameterValue

A representation descriptor of an orientation.

Parameters:

type (matflow.param_classes.orientations.OrientationRepresentationType) – How the orientation is represented.
euler_definition (matflow.param_classes.orientations.EulerDefinition | None) – For Euler angles, how the angles are applied.
euler_is_degrees (bool | None) – For Euler angles, whether the angles are in degrees or radians.
quat_order (matflow.param_classes.orientations.QuatOrder | None) – For quaternions, what is the order of the scalar wrt the vector.

Methods

`dump_element_group_to_HDF5_group`	Write a list (from an element group) of parameter values to an HDF5 group.
`dump_to_HDF5_group`	Write this parameter value to an HDF5 group.
`euler`	Make a representation of an orientation that uses Euler angles.
`prepare_JSON_dump`	Prepare this parameter value for serialisation as JSON.
`quaternion`	Make a representation of an orientation that uses quaternions.
`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`	For Euler angles, how the angles are applied.
`euler_is_degrees`	For Euler angles, whether the angles are in degrees or radians.
`quat_order`	For quaternions, what is the order of the scalar wrt the vector.
`type`	How the orientation is represented.

classmethod dump_element_group_to_HDF5_group(objs, group)#

Write a list (from an element group) of parameter values to an HDF5 group.

Parameters:

objs (list[Self]) –
group (HDF5Group) –

dump_to_HDF5_group(group)#

Write this parameter value to an HDF5 group.

Parameters:: group (HDF5Group) –

classmethod euler(is_degrees=False, definition=EulerDefinition.BUNGE)#

Make a representation of an orientation that uses Euler angles.

Parameters:

is_degrees (bool) – Whether the angles are in degrees or radians.
definition (EulerDefinition) – How the angles are applied.

Return type:

Self

euler_definition: EulerDefinition | None = None#: For Euler angles, how the angles are applied.

euler_is_degrees: bool | None = None#: For Euler angles, whether the angles are in degrees or radians.

prepare_JSON_dump()#

Prepare this parameter value for serialisation as JSON.

Return type:: dict[str, Any]

quat_order: QuatOrder | None = None#: For quaternions, what is the order of the scalar wrt the vector.

classmethod quaternion(order=QuatOrder.SCALAR_VECTOR)#

Make a representation of an orientation that uses quaternions.

Parameters:: order (QuatOrder) – What is the order of the scalar wrt the vector.
Return type:: Self

classmethod save_from_HDF5_group(group, param_id, workflow)#

Extract a parameter value from an HDF5 group.

Parameters:

group (HDF5Group) –
param_id (int) –
workflow (Workflow) –

classmethod save_from_JSON(data, param_id, workflow)#

Extract a parameter value from JSON data.

Parameters:

param_id (int | list[int]) –
workflow (Workflow) –

to_dict()#

Serialise this parameter value as a dictionary.

Return type:: dict[str, Any]

type: OrientationRepresentationType#: How the orientation is represented.