magnet.generate.dataset_3D#

magnet.generate.dataset_3D(n_cubes: int, n_cubes_portions: int, output_path: str, dataset_name: str, extension: str = 'vtk', base_name: str = 'mesh', seed: int | None = None) None#

Generate dataset of 3D meshes.

Generates dataset of 3D tetrahedral meshes of the unit cube and portions of the unit cube. The meshes are saved together with a .npz file containing adjacency, centroid and volume data of the meshes. A text file containing a summary of the dataset is also saved.

Parameters:
  • n_cubes (int) – Number of meshes of the unit cube to be generated.

  • n_cubes_portions (int) – Number of meshes of portions of the unit cube to be generated.

  • output_path (str) – folder path where the dataset will be saved.

  • dataset_name – name of the folder containing the dataset

  • extension (str, optional) – Mesh file format extension (default is ‘vtk’).

  • base_name (str, optional) – Root name of the mesh files (default is ‘mesh’).

  • seed (int, optional) – Seed of the Random number generator. If not provided, uses a random seed.

Return type:

None

See also

magnet.io.load_dataset

load mesh dataset.