matflow.param_classes.seeds.MicrostructureSeeds#
- class matflow.param_classes.seeds.MicrostructureSeeds(position: numpy.ndarray, box_size: numpy.ndarray, phase_label: str, orientations: matflow.param_classes.orientations.Orientations | None = None, random_seed: int | None = None)#
Bases:
ParameterValue
Methods
Write this parameter value to an HDF5 group.
For custom initialisation via YAML or JSON.
Prepare this parameter value for serialisation as JSON.
Extract a parameter value from an HDF5 group.
Extract a parameter value from JSON data.
Serialise this parameter value as a dictionary.
Attributes
- Parameters:
position (ndarray) –
box_size (ndarray) –
phase_label (str) –
orientations (Orientations | None) –
random_seed (int | None) –
- dump_to_HDF5_group(group)#
Write this parameter value to an HDF5 group.
- classmethod from_JSON_like(position, orientations=None, **kwargs)#
For custom initialisation via YAML or JSON.
- classmethod from_file(path, box_size, phase_label, number=None, start_index=0, delimiter=' ')#
- classmethod from_random(num_seeds, box_size, phase_label, random_seed=None, orientations=None)#
- property num_seeds#
- orientations: Orientations | 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) –
- show()#
- to_dict()#
Serialise this parameter value as a dictionary.