Simple Mask Maker

Creates a logical array from an antsImage object

coerce_mask(x, error = TRUE)

Arguments

x

antsImage object

error

should the function error if the mask as not binary?

Value

Array, logical if all values within 0, 1, NA, and NaN

Examples

img <- makeImage(c(10, 10), rnorm(100))
mask <- img > 0
coerce_mask(mask, error = TRUE)
#>        [,1]  [,2]  [,3]  [,4]  [,5]  [,6]  [,7]  [,8]  [,9] [,10]
#>  [1,] FALSE FALSE FALSE  TRUE FALSE  TRUE FALSE FALSE FALSE  TRUE
#>  [2,] FALSE FALSE FALSE FALSE FALSE FALSE  TRUE  TRUE FALSE FALSE
#>  [3,] FALSE  TRUE  TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE
#>  [4,] FALSE  TRUE FALSE  TRUE FALSE FALSE  TRUE FALSE FALSE  TRUE
#>  [5,] FALSE  TRUE  TRUE FALSE FALSE  TRUE  TRUE  TRUE  TRUE  TRUE
#>  [6,] FALSE FALSE  TRUE  TRUE  TRUE FALSE FALSE  TRUE  TRUE FALSE
#>  [7,] FALSE FALSE FALSE  TRUE  TRUE  TRUE  TRUE  TRUE  TRUE FALSE
#>  [8,]  TRUE FALSE FALSE FALSE FALSE FALSE  TRUE FALSE FALSE FALSE
#>  [9,] FALSE  TRUE  TRUE  TRUE  TRUE  TRUE FALSE FALSE  TRUE  TRUE
#> [10,]  TRUE FALSE  TRUE FALSE  TRUE FALSE  TRUE  TRUE FALSE  TRUE
coerce_mask(mask + 1, error = FALSE)
#>       [,1] [,2] [,3] [,4] [,5] [,6] [,7] [,8] [,9] [,10]
#>  [1,]    1    1    1    2    1    2    1    1    1     2
#>  [2,]    1    1    1    1    1    1    2    2    1     1
#>  [3,]    1    2    2    1    1    1    1    1    1     1
#>  [4,]    1    2    1    2    1    1    2    1    1     2
#>  [5,]    1    2    2    1    1    2    2    2    2     2
#>  [6,]    1    1    2    2    2    1    1    2    2     1
#>  [7,]    1    1    1    2    2    2    2    2    2     1
#>  [8,]    2    1    1    1    1    1    2    1    1     1
#>  [9,]    1    2    2    2    2    2    1    1    2     2
#> [10,]    2    1    2    1    2    1    2    2    1     2
testthat::expect_error(coerce_mask(mask + 1, error = TRUE))
coerce_mask(as.array(mask) > 0, error = FALSE)
#>        [,1]  [,2]  [,3]  [,4]  [,5]  [,6]  [,7]  [,8]  [,9] [,10]
#>  [1,] FALSE FALSE FALSE  TRUE FALSE  TRUE FALSE FALSE FALSE  TRUE
#>  [2,] FALSE FALSE FALSE FALSE FALSE FALSE  TRUE  TRUE FALSE FALSE
#>  [3,] FALSE  TRUE  TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE
#>  [4,] FALSE  TRUE FALSE  TRUE FALSE FALSE  TRUE FALSE FALSE  TRUE
#>  [5,] FALSE  TRUE  TRUE FALSE FALSE  TRUE  TRUE  TRUE  TRUE  TRUE
#>  [6,] FALSE FALSE  TRUE  TRUE  TRUE FALSE FALSE  TRUE  TRUE FALSE
#>  [7,] FALSE FALSE FALSE  TRUE  TRUE  TRUE  TRUE  TRUE  TRUE FALSE
#>  [8,]  TRUE FALSE FALSE FALSE FALSE FALSE  TRUE FALSE FALSE FALSE
#>  [9,] FALSE  TRUE  TRUE  TRUE  TRUE  TRUE FALSE FALSE  TRUE  TRUE
#> [10,]  TRUE FALSE  TRUE FALSE  TRUE FALSE  TRUE  TRUE FALSE  TRUE