Methods that act on the .Data field in a NIfTI/ANALYZE image but only on values inside a mask.

mask_vals(object, mask)

mask_vals(object, mask) <- value

# S4 method for class 'nifti'
mask_vals(object, mask) <- value

# S4 method for class 'anlz'
mask_vals(object, mask) <- value

# S4 method for class 'array'
mask_vals(object, mask) <- value

Arguments

object

is an object of class nifti or anlz.

mask

is an object of class nifti or anlz.

value

is the value to assign to the .Data field.

Examples

set.seed(2022)
img = nifti(array(rnorm(10^3), dim = rep(10, 3)))
mask = img > 1.5
mask_vals(img, mask)
#>  [1] 1.693190 2.314499 1.870869 2.746927 2.887423 1.855734 1.578631 1.700810
#>  [9] 1.596973 1.506987 2.458926 1.609042 1.627579 1.881067 1.551865 1.679318
#> [17] 1.812150 2.693779 1.864219 1.719872 2.057894 1.962489 2.448805 1.893214
#> [25] 2.129228 2.176455 3.765191 2.066231 1.538827 1.598178 1.662501 1.586898
#> [33] 1.575864 2.089094 2.029349 1.803115 2.892122 1.767646 1.634752 2.748292
#> [41] 2.737169 1.925705 1.593078 1.918393 1.742502 2.174606 1.616297 1.617032
#> [49] 2.100461 2.176399 2.160856 1.652127 2.767110 2.915663 1.873841 1.636208
#> [57] 1.568863 1.634380 1.741507
testthat::expect_equal(sum(mask_vals(img, mask)), 117.628200302518)
mask_vals(img, mask) = rep(4, sum(mask))
mask_vals(img, as(mask, "array")) = rep(4, sum(mask))
mask_vals(as(img, "array"), 
    as(mask, "array")) = rep(4, sum(mask))