io

voxel.load_volume(filename, fmt=None) -> vx.Volume

Load a volume from a file.

Parameters:

• filename (PathLike) –

  The path to the file to load.

• fmt (str, default: None ) –

  The format of the file. If None, the format is determined by the file extension.

Returns:

• Volume –

  The loaded volume.

voxel.save_volume(volume, filename, fmt=None) -> None

Save a volume to a file.

Parameters:

• volume (Volume) –

  The volume to save.

• filename (PathLike) –

  The path to the file to save.

• fmt (str, default: None ) –

  The format of the file. If None, the format is determined by the file extension.

voxel.load_mesh(filename, fmt=None, **kwargs) -> vx.Mesh

Load a mesh from a file.

Parameters:

• filename (PathLike) –

  The path to the file to load.

• fmt (str, default: None ) –

  The format of the file. If None, the format is determined by the file extension.

• **kwargs (Any, default: {} ) –

  Additional arguments to pass to the file reading method.

Returns:

• Mesh –

  The loaded mesh.

voxel.save_mesh(mesh, filename, fmt=None, **kwargs) -> None

Save a mesh to a file.

Parameters:

• mesh (Mesh) –

  The mesh to save.

• filename (PathLike) –

  The path to the file to save.

• fmt (str, default: None ) –

  The format of the file. If None, the format is determined by the file extension.

• **kwargs (Any, default: {} ) –

  Additional arguments to pass to the file writing method.

voxel.load_affine(filename, fmt=None) -> vx.AffineMatrix

Load an affine matrix from a file.

Parameters:

• filename (PathLike) –

  The path to the file to load.

• fmt (str, default: None ) –

  The format of the file. If None, the format is determined by the file extension.

Returns:

• AffineMatrix –

  The loaded affine matrix.

voxel.save_affine(affine, filename, fmt=None, **kwargs) -> None

Save an affine matrix to a file.

Parameters:

• affine (AffineMatrix) –

  The affine matrix to save.

• filename (PathLike) –

  The path to the file to save.

• fmt (str, default: None ) –

  The format of the file. If None, the format is determined by the file extension.

• **kwargs (Any, default: {} ) –

  Additional arguments to pass to the file writing method.

voxel.load_bounding_box(filename) -> BoundingBox

Load a bounding box from file.

Parameters:

• filename (Path) –

  Target file to load.

Returns:

• BoundingBox –

  Loaded bounding box.

voxel.load_labels(filename, fmt=None) -> vx.LabelLookup

Load a label lookup table from a file.

Parameters:

• filename (PathLike) –

  The path to the file to load.

• fmt (str, default: None ) –

  The format of the file. If None, the format is determined by the file extension.

Returns:

• LabelLookup –

  The loaded lookup table.

voxel.save_labels(lookup, filename, fmt=None, **kwargs) -> None

Save a label lookup table to a file.

Parameters:

• lookup (LabelLookup) –

  The lookup table to save.

• filename (PathLike) –

  The path to the file to save.

• fmt (str, default: None ) –

  The format of the file. If None, the format is determined by the file extension.

• **kwargs (Any, default: {} ) –

  Additional arguments to pass to the file writing method.