Class "exponential"

Description

Exponential transform class defines a transformation given by the function

f(parameter,a,b)=e^{parameter/b}*frac{1}{a}

Objects from the Class

Objects can be created by calls to the constructorexponential(parameters,a,b).

Slots

.Data:

Object of class "function" ~~

a:

Object of class "numeric"- non zero constant

b:

Object of class "numeric"- non zero constant

parameters:

Object of class "transformation"- flow parameter to be transformed

transformationId:

Object of class "character" -unique ID to reference the transformation

Extends

Class "singleParameterTransform", directly. Class "transform", by class "singleParameterTransform", distance 2. Class "transformation", by class "singleParameterTransform", distance 3. Class "characterOrTransformation", by class "singleParameterTransform", distance 4.

Methods

No methods defined with class "exponential" in the signature.

Note

The exponential transformation object can be evaluated using the eval method by passing the data frame as an argument.The transformed parameters are returned as a matrix with a single column

Author(s)

Gopalakrishnan N, F.Hahne

References

Gating-ML Candidate Recommendation for Gating Description in Flow Cytometry V 1.5

See Also

logarithm

Examples

 dat <- read.FCS(system.file("extdata","0877408774.B08",
  package="flowCore"))
  exp1<-exponential(parameters="FSC-H",a=1,b=37,transformationId="exp1")
  transOut<-eval(exp1)(exprs(dat))

Results

R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(flowCore)
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/flowCore/exponential-class.Rd_%03d_medium.png", width=480, height=480)
> ### Name: exponential-class
> ### Title: Class "exponential"
> ### Aliases: exponential-class exponential eval,exponential,missing-method
> ### Keywords: classes
> 
> ### ** Examples
> 
>  dat <- read.FCS(system.file("extdata","0877408774.B08",
+   package="flowCore"))
>   exp1<-exponential(parameters="FSC-H",a=1,b=37,transformationId="exp1")
>   transOut<-eval(exp1)(exprs(dat))
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>