mean: Mean for antsImage Objects

mean.antsImageR Documentation

Mean for antsImage Objects

Description

Overloaded Mean for antsImage objects

Usage

## S3 method for class 'antsImage'
mean(x, ..., mask = NULL, na.rm = FALSE)

Arguments

x

is an object of class antsImage.

...

additional arguments to pass to mean

mask

binary mask of values to subset

na.rm

Remove missing values

Examples

img <- makeImage(c(10, 10, 10), rnorm(1000))
mean(img)
mean(img, na.rm = TRUE)
mean(img > 0)
mean(img > 0, na.rm = TRUE)
mean(img, mask = img > 0)
mean(img, mask = img > 0, na.rm = TRUE)
arr <- as.array(img)
arr[1, 1, 1] <- NA
img <- as.antsImage(arr, reference = img)
m <- mean(img)
stopifnot(is.nan(m))
mean(img, na.rm = TRUE)
m <- mean(0 < img)
stopifnot(is.nan(m))
m <- mean(img > 0)
# stopifnot(is.nan(m))
mean(img > 0, na.rm = TRUE)
m <- mean(img, mask = img > 0)
stopifnot(is.nan(m))
mean(img, mask = img > 0, na.rm = TRUE)

stnava/ANTsR documentation built on April 13, 2025, 4:10 a.m.