matflow.param_classes.orientations.UnitCellAlignment

class matflow.param_classes.orientations.UnitCellAlignment(x=None, y=None, z=None)

Bases: ParameterValue

A description of the alignment of a unit cell.

Parameters:

• x (str | LatticeDirection) – The direction of the X component.

• y (str | LatticeDirection) – The direction of the Y component.

• z (str | LatticeDirection) – The direction of the Z component.

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.
from_hex_convention_DAMASK	Generate a unit cell alignment from Damask's default convention for hexagonal symmetry.
from_hex_convention_MTEX	Generate a unit cell alignment from MTEX's default convention for hexagonal symmetry.
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

x	The direction of the X component.
y	The direction of the Y component.
z	The direction of the Z component.

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[ParameterValue]) –

• group (Group) –

dump_to_HDF5_group(group)

Write this parameter value to an HDF5 group.

Parameters:

group (Group) –

classmethod from_hex_convention_DAMASK()

Generate a unit cell alignment from Damask’s default convention for hexagonal symmetry.

Return type:

Self

classmethod from_hex_convention_MTEX()

Generate a unit cell alignment from MTEX’s default convention for hexagonal symmetry.

Tested using this command in MTEX: crystalSymmetry(“hexagonal”).alignment

Return type:

Self

prepare_JSON_dump()

Prepare this parameter value for serialisation as JSON.

Return type:

dict[str, Any]

classmethod save_from_HDF5_group(group, param_id, workflow)

Extract a parameter value from an HDF5 group.

Parameters:

• group (Group) –

• 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]

x: LatticeDirection | None = None

The direction of the X component.

y: LatticeDirection | None = None

The direction of the Y component.

z: LatticeDirection | None = None

The direction of the Z component.