rockverse.dect.DECTGroup.create_mask#

DECTGroup.create_mask(fill_value=False, overwrite=False, field_name='mask', description='Mask voxel image', **kwargs)[source]#

Create a mask voxel image based on the lowECT one. This function enforces boolean dtype and the path ‘/mask’ within the group store. These parameters will be ignored if passed as keyword arguments.

Parameters:

  • fill_value (bool, optional) – The value to fill the mask with (default is False).

  • overwrite (bool, optional) – If True, overwrite existing mask (default is False).

  • **kwargs – Additional keyword arguments for the rockverse.voxel_image.full_like function used to create the mask array.