R/largest_component.R

In neuroconductor-releases/extrantsr: Extra Functions to Build on the 'ANTsR' Package

#' @title Get Largest Component
#'
#' @description Wrapper for \code{oMath("GetLargestComponent")}
#' 
#' @param img Object of class \code{nifti} 
#' @param ... Additional arguments passed to \code{\link{iMath}}
#' @param retfile logical to indicate if an \code{antsImage} should be returned
#' (useful for chaining)
#' @export
#' @return Object of class \code{nifti}
largest_component <- function(img, ..., retfile = FALSE){
  res = oMath(img = img, operation = "GetLargestComponent", 
              ..., retfile = retfile)
  return(res)
}