matflow.param_classes.orientations.UnitCellAlignment

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

Bases: ParameterValue

Methods

dump_to_HDF5_group	Write this parameter value to an HDF5 group.
from_hex_convention_DAMASK
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
y
z

Parameters:

• x (LatticeDirection | None) –

• y (LatticeDirection | None) –

• z (LatticeDirection | None) –

dump_to_HDF5_group(group)

Write this parameter value to an HDF5 group.

classmethod from_hex_convention_DAMASK()

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

prepare_JSON_dump()

Prepare this parameter value for serialisation as JSON.

Return type:

Dict

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.

x: LatticeDirection | None = None

y: LatticeDirection | None = None

z: LatticeDirection | None = None