R/filterObject_Methods.R

In flowWorkspace: Infrastructure for representing and interacting with gated and ungated cytometry data sets.

#' @include GatingSet_Methods.R
NULL

#' @templateVar old filterObject
#' @templateVar new filter_to_list
#' @template template-depr_pkg
NULL

#' @export 
filterObject <- function(x)UseMethod("filterObject")

#' @export 
filterObject.default <- function(x){
  .Deprecated("filter_to_list")
  filter_to_list(x)
}

#' convert flowCore filter to a list 
#'  
#' It convert the flowCore gate to a list whose structure can be understood by 
#' underlying c++ data structure.
#' 
#' @name filter_to_list
#' @aliases filterObject filterObject,default-method filter_to_list,rectangleGate-method
#' filter_to_list,polygonGate-method filter_to_list,quadGate-method filter_to_list,booleanFilter-method
#' filter_to_list,ellipsoidGate-method filter_to_list,logical-method
#' @param x \code{filter} a flowCore gate. Currently supported gates are:
#'                          "rectangleGate", "polygonGate","ellipsoidGate" and "booleanFilter"
#' @return a \code{list}
#' @export 
filter_to_list <- function(x)UseMethod("filter_to_list")

#' @export 
filter_to_list.rectangleGate <- function(x){
      params<-parameters(x)
      nDim <- length(params)
      if(nDim==1)
      {
        #convert to rangeGate
        filterObject<-list(type=as.integer(2)
            ,params=params
            ,range=c(x@min,x@max) 
            ,filterId=x@filterId
        )
        
      }else if(nDim==2)
      {
        #convert to rectGate gate
        mat<-rbind(x@min,x@max)
        filterObject<-list(type=as.integer(5)
            ,params=params
            ,boundaries=mat
            ,filterId=x@filterId)  
      }else
        stop(nDim, "D rectangleGate is not supported by GatingSet!")
      filterObject
    }

#' @export
filter_to_list.polygonGate <- function(x){
      params<-parameters(x)
      
      list(type=as.integer(1)
          ,params=params
          ,boundaries=x@boundaries
          ,filterId=x@filterId)  
    }

#' @export
filter_to_list.quadGate <- function(x){
	params<-parameters(x)
	
	list(type=as.integer(9)
			,params=params
			,mu=x@boundary
			,uid = gen_uid()
			,filterId=x@filterId)  
}

#' @export
filter_to_list.booleanFilter <- function(x){
      expr <- x@deparse
      
      pattern <- "&&|\\|\\|"
      if(grepl(pattern=pattern,expr))
        stop("double operater ('&&' or '||') found in the expression of booleanFilter!")
      
      pattern <- "&|\\|"
      #get the position of logical operators
      op_ind <- unlist(gregexpr(pattern=pattern,expr))
      #extract these operators
      op <- trimws(substring(expr,op_ind,op_ind))
      ##append & for the first node element(as C parser convention requires)
      if(length(op)==1){
        if(nchar(op)==0){
          op <- "&"
        }else{
          op <- c("&",op)
        }
      }else{
        op <- c("&",op)        
      }

      #split into node elements by operators
      refs <- unlist(strsplit(expr,split=pattern)) 
      refs <- trimws(refs)
      #extract the leading ! operator from each ref
      isNot <- as.logical(regexpr("!",refs) + 1) 
      #strip ! symbol from node elements
      refs <- sub("!","",refs)
      
      #check if there is still illegal ! symbol left
      nNodes <- length(refs)
      if(any(grepl("!", refs)))
        stop("extra '!' symbol found in the reference node names of boolean fitler!")
      if(length(op)!=nNodes)
        stop("the number of logical operators are inconsistent with nodes!")
      list(type=as.integer(3)
          ,refs=refs
          ,isNot=isNot
          ,op=op
          ,filterId=x@filterId)  
    }
    
#' @export
filter_to_list.ellipsoidGate <- function(x){
      params<-parameters(x)
      
      list(type=as.integer(4)
          , params = params
          , mu = x@mean
          , cov = x@cov
          , dist = x@distance
          ,filterId=x@filterId)  
    }


#' @export
filter_to_list.logical <- function(x){
  
  list(type=as.integer(6)
       , negated = FALSE
       ,filterId = "dummy_logicalGate") 
}