rockverse.voxel_image.VoxelImage.create_mask_from_region#

VoxelImage.create_mask_from_region(region, **kwargs)[source]#

Create a mask voxel image.

Create boolean voxel image with same shape, chunks, voxel_origin, voxel_length, and voxel_unit as the original image, masking voxels outside the region of interest.

Parameters:

a (VoxelImage) – The source voxel image to mimic.
**kwargs – Additional keyword arguments to be passed to the underlying creation function. Keyword argument dtype will be ignored if passed, as the mask has to be of boolean type.

Returns:

The created VoxelImage object.

Return type: