emptyImageDimensionsMask: Make Mask from Empty Image Dimensions

View source: R/emptyImageDimensionsMask.R

emptyImageDimensionsMaskR Documentation

Make Mask from Empty Image Dimensions

Description

Make a mask of an image that has all irrelevant values

Usage

emptyImageDimensionsMask(img, ..., reorient = FALSE)

empty_dim_mask(img, ..., reorient = FALSE)

Arguments

img

nifti object

...

Arguments to be passed to getEmptyImageDimensions.

reorient

Should image be reoriented if a filename?

Value

Object of class nifti, with binary values

Note

empty_dim_mask is a shorthand for emptyImageDimensionsMask with all the same arguments.

See Also

getEmptyImageDimensions

Examples

set.seed(5)
dims = rep(10, 3)
arr = array(rnorm(prod(dims)), dim = dims)
arr[,,10] = 0
nim = oro.nifti::nifti(arr)
out = emptyImageDimensionsMask(nim)
out_arr = emptyImageDimensionsMask(arr)
testthat::expect_equal(out_arr, array(out, dim = dim(out)))
out_arr = empty_dim_mask(arr)

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