ants.ops.mask_image

mask_image(image, mask, level=1, binarize=False)[source]

Mask an input image by a mask image. If the mask image has multiple labels, it is possible to specify which label(s) to mask at.

ANTsR function: maskImage

Parameters:

  • image (ants.core.ANTsImage) – Input image.

  • mask (ants.core.ANTsImage) – Mask or label image.

  • level (scalar or tuple of scalars) – Level(s) at which to threshold the mask. Can be a single value or an iterable of values.

  • binarize (bool) – whether to binarize the output image. This computes an intersection between (image != 0) and (mask == i), for all i in level.

Return type:

ants.core.ANTsImage

Example

>>> import ants
>>> myimage = ants.image_read(ants.get_ants_data('r16'))
>>> mask = ants.get_mask(myimage)
>>> myimage_mask = ants.mask_image(myimage, mask, 3)
>>> seg = ants.kmeans_segmentation(myimage, 3)
>>> myimage_mask = ants.mask_image(myimage, seg['segmentation'], (1,3))