R/iMathOps.R

In stnava/ANTsR: ANTs in R: Quantification Tools for Biomedical Images

#' @name iMathOps
#'
#' @title Operations for iMath Operator
#'
#' @description Examples, description and categorization of iMath operations.
#'
#' @format A data frame listing the following variables.
#' \describe{
#' \item{\code{Operation}}{Name of operation}
#' \item{\code{OperationType}}{Enumerated type of the operation (filter, etc)}
#' \item{\code{Parameters}}{descriptive parameters}
#' \item{\code{Example}}{working example code}
#' \item{\code{Description}}{free text description}
#' \item{\code{OutputDimensionalityChange}}{NA if not image, otherwise
#'   increment to output image dimensionality relative to input image}
#' }
#' @examples
#' data(iMathOps)
#' i <- antsImageRead(getANTsRData("r16"), 2)
#' roiImg <- getMask(i)
#' roiImg2 <- iMath(roiImg, "ME", 25)
#' if (sum(roiImg == 1) == sum(roiImg2 == 1)) stop("erosion failure")
#' roiImg2 <- iMath(roiImg, "MD", 25)
#' if (sum(roiImg == 1) == sum(roiImg2 == 1)) stop("dilation failure")
#' for (j in c(1:nrow(iMathOps)))
#' {
#'   op <- as.character(iMathOps$Operation[j])
#' }
#' @keywords datasets
NULL