mask_img: Mask Image

In muschellij2/neurobase: 'Neuroconductor' Base Package with Helper Functions for 'nifti' Objects

Mask Image

Description

Takes an image, masks it by mask, and returns an object of class nifti

Usage

mask_img(img, mask, allow.NA = TRUE)

Arguments

img	object of class nifti
mask	array or object of class nifti, same dimensions as img
allow.NA	allow NAs in the mask

Value

Object of class nifti with values outside mask set to 0 if mask is 0 and NA if mask is NA and img if mask == 1

Examples

  set.seed(5)
  dims = rep(10, 3)
  arr = array(rnorm(prod(dims)), dim = dims)
  nim = oro.nifti::nifti(arr)
  mask = abs(nim) > 1
  masked = mask_img(nim, mask)
  mask[mask == 0] = NA
  na_masked = mask_img(nim, mask, allow.NA = TRUE)
  
set.seed(5)
dims = rep(10, 3)
arr = array(rnorm(prod(dims)), dim = dims)
arr[,,10] = 0
nim = oro.nifti::nifti(arr)
rnifti = RNifti::asNifti(nim)
mask = nim > 0
timg = tempimg(nim)
limg = list(factor(timg), factor(timg))
func = function(...) mask_img(..., mask = mask)
func(arr)
func(nim)
func(rnifti)
func(timg)
lapply(limg, func)

muschellij2/neurobase documentation built on Nov. 28, 2023, 5:33 a.m.