odatse.domain.meshgrid module

class odatse.domain.meshgrid.MeshGrid(info: Info = None, *, param: Dict[str, Any] = None, mesh: bool = True, rng: RandomState = None)

Bases: DomainBase

MeshGrid class for handling grid data for quantum beam diffraction experiments.

Initialize the MeshGrid object.

Parameters:

• info (Info, optional) – Information object containing algorithm parameters.

• param (dict, optional) – Dictionary containing parameters for setting up the grid.

• mesh (bool, optional) – Whether to use mesh grid or points.

• rng (np.random.RandomState, optional) – Random number generator.

__init__(info: Info = None, *, param: Dict[str, Any] = None, mesh: bool = True, rng: RandomState = None)

Initialize the MeshGrid object.

Parameters:

• info (Info, optional) – Information object containing algorithm parameters.

• param (dict, optional) – Dictionary containing parameters for setting up the grid.

• mesh (bool, optional) – Whether to use mesh grid or points.

• rng (np.random.RandomState, optional) – Random number generator.

_setup(info_param, rng: RandomState, mesh: bool = True)

Setup the grid based on provided parameters.

Parameters:

• info_param – Dictionary containing parameters for setting up the grid.

• rng (np.random.RandomState, optional) – Random number generator.

• mesh (bool, optional) – Whether to use mesh grid or points.

_setup_from_file(info_param)

Setup the grid from a file.

Parameters:

info_param – Dictionary containing parameters for setting up the grid.

_setup_grid(info_param)

Setup the grid based on min, max, and num lists.

Parameters:

info_param – Dictionary containing parameters for setting up the grid.

do_split()

Split the grid data among MPI processes.

classmethod from_dict(param)

Create a MeshGrid object from a dictionary of parameters.

Parameters:

param – Dictionary containing parameters for setting up the grid.

Returns:

a MeshGrid object.

Return type:

MeshGrid

classmethod from_file(mesh_path)

Create a MeshGrid object from a file.

Parameters:

mesh_path – Path to the file containing the grid data.

Returns:

a MeshGrid object.

Return type:

MeshGrid

store_file(store_path, *, header='')

Store the grid data to a file.

Parameters:

• store_path – Path to the file where the grid data will be stored.

• header – Header to be included in the file.