R/aRchiClass.R

In aRchi: Quantitative Structural Model ('QSM') Treatment for Tree Architecture

#' @title aRchi
#' @description Class containing files to compute and display in three dimensions tree architectural metrics at different level of organization
#' @docType class
#' @field QSM a data.table containing QSM information according to \code{\link{read_QSM}} function format
#' @field pointcloud a data.table containing the point cloud used to generate the QSM
#' @field Paths a data.table of Paths according to \code{\link{Make_Path}} function
#' @field Nodes Metrics computed at the node scale (see \code{\link{Make_Node}})
#' @field operations Record all the operations performed on the object.
#' @include nullOrDatatable.R
#' @include nullOrLASOrDatatable.R
#' @include nullOrlist.R
#' @include nullOrnumeric.R
#' @return An object of class aRchi
#' @name aRchi-class
#' @rdname aRchi-class
#' @export
aRchi=setClass("aRchi",slots=c(QSM = "nullOrDatatable",
                               Paths="nullOrDatatable",
                               pointcloud = "nullOrLASOrDatatable",
                               Nodes = "nullOrlist",
                               leaves= "nullOrlist",
                               operations = "nullOrlist"
                               ))


setMethod("show",
          "aRchi",
          function(object) {
            if(!is.null(object@QSM)){
              cat("QSM:",nrow(object@QSM),"cylinders,",length(unique(object@QSM$segment_ID)), "segments and", length(unique(object@QSM$node_ID)-1), "node\n")
            }else{
              cat("QSM is empty\n")
            }
            if(!is.null(object@Paths)){
              cat("Paths:", length(unique(object@Paths$ID_Path)),"Paths \n")
            }else{
              cat("Paths is empty\n")
            }
            if(!is.null(object@pointcloud)){
              if(is.data.frame(object@pointcloud)){cat("Point cloud:", nrow(object@pointcloud),"points \n")}
              if(is.data.frame(object@pointcloud)==FALSE){cat("Point cloud:", nrow(object@pointcloud@data),"points \n")}
            }else{
              cat("Point cloud is empty\n")
            }
            if(!is.null(object@Nodes)){
              cat("List with two elements: Relative and Absolute nodes tables\n")
            }else{
              cat("Node table is empty\n")
            }
            if(!is.null(object@leaves)){
              cat("Leaves computed\n")
            }else{
              cat("Leaves is empty\n")
            }
            if(!is.null(object@operations)){
              cat("Operations: ", paste(names(object@operations),collapse="; "))
            }else{
              cat("No operation realized\n")
            }
          }
)