Class "ratio"

ratio transform calculates the ratio of two parameters defined by the function $$f(parameter_1,parameter_2)=\frac{parameter_1}{parameter_2}$$

Slots

.Data

Object of class "function".

numerator

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

denominator

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

transformationId

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

Note

The ratio transformation object can be evaluated using the eval method by passing the data frame as an argument.The transformed parameters are returned as matrix with one column. (See example below)

Objects from the Class

Objects can be created by calls to the constructor ratio(parameter1,parameter2,transformationId) .

Extends

Class "transform", directly.

Class "transformation", by class "transform", distance 2.

Class "characterOrTransformation", by class "transform", distance 3.

References

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

See also

dg1polynomial,quadratic,squareroot

Other mathematical transform classes: EHtrans-class, asinht-class, asinhtGml2-class, dg1polynomial-class, exponential-class, hyperlog-class, hyperlogtGml2-class, invsplitscale-class, lintGml2-class, logarithm-class, logicletGml2-class, logtGml2-class, quadratic-class, ratiotGml2-class, sinht-class, splitscale-class, squareroot-class, unitytransform-class

Examples

  dat <- read.FCS(system.file("extdata","0877408774.B08",
  package="flowCore"))
  rat1<-ratio("FSC-H","SSC-H",transformationId="rat1")
  transOut<-eval(rat1)(exprs(dat))