prepare.mask: Prepare mask

In czarrar/niftir: niftir 0.2

Prepare mask

Description

Prepare a mask to do masking

Usage

prepare.mask(new_mask, orig_mask=NULL, thresh=0)

Arguments

new_mask	vector or object that can be converted to a vector
orig_mask	NULL or vector of logical elements
thresh	if new_mask is numeric than threshold at this level

Details

Intended as a function called by do.mask. Ensures that input new_mask is a vector of logicals for masking.

If orig_mask is specified, then this implies that new_mask will be masking an object later that has already been masked. The new_mask can then be either the same length as orig_mask or the length of the number of TRUE elements in new_mask.

Value

vector of logicals

Author(s)

Zarrar Shehzad

See Also

do.mask

czarrar/niftir documentation built on April 19, 2022, 3:35 a.m.