R/ms.image_class.R

In SPUTNIK: SPatially aUTomatic deNoising for Ims toolKit

#' \link{ms.image-class} definition.
#'
#' @slot values numeric 2-D matrix representing the pixel intensity values.
#' @slot name string. Image name used for plotting.
#' @slot scaled logical. Whether the pixels intensities have been scaled in [0, 1]
#' or not.
#'
#' @method \code{\link{msImage}} default
#' @method binOtsu default
#' @method closeImage default
#' @method invertImage default
#' @method plot default
#' @method removeSmallObjects default
#' @method smoothImage default
#'
#' @author Paolo Inglese \email{p.inglese14@imperial.ac.uk}
#'
#' @export
#'
setClass(

  "ms.image",
  slots = list(
    values = "matrix",
    name = "character",
    scaled = "logical"
  ),

  validity = function(object) {
    if (length(dim(object@values)) != 2) {
      return("Values must be 2-D numeric matrix.")
    }
    
    # if (any(!is.finite(c(object@values)))) {
    #   return("Values must be finite")
    # }

    # if (min(c(object@values)) < 0 || max(c(object@values)) > 1) {
    #   return("Values are not between 0 and 1.")
    # }

    if (length(unique(c(object@values))) == 0) {
      return("Constant image.")
    }
    return(TRUE)
  }
)