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

dump_to_HDF5_group

Write this parameter value to an HDF5 group.

from_JSON_like

For custom initialisation via YAML or JSON.

from_file

from_random

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.

show

to_dict

Serialise this parameter value as a dictionary.

Attributes

num_seeds

orientations

random_seed

position

box_size

phase_label

Parameters:
box_size: ndarray#
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#
phase_label: str#
position: ndarray#
prepare_JSON_dump()#

Prepare this parameter value for serialisation as JSON.

Return type:

Dict

random_seed: int | 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.