Class "dg1polynomial"

Share:

Description

dg1polynomial allows for scaling,linear combination and translation within a single transformation defined by the function

f(parameter_1,...,parameter_n,a_1,...,a_n,b) = b + Σ_{i=1}^n a_i*parameter_i

Objects from the Class

Objects can be created by using the constructor dg1polynomial(parameter,a,b,transformationId).

Slots

.Data:

Object of class "function" ~~

parameters:

Object of class "parameters" -the flow parameters that are to be transformed

a:

Object of class "numeric" - coefficients of length equal to the number of flow parameters

b:

Object of class "numeric" - coefficient of length 1 that performs the translation

transformationId:

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

Extends

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

Methods

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

Note

The 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.(See example below)

Author(s)

Gopalakrishnan N, F.Hahne

References

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

See Also

ratio,quadratic,squareroot

Examples

1
2
3
4
  dat <- read.FCS(system.file("extdata","0877408774.B08",
  package="flowCore"))
  dg1<-dg1polynomial(c("FSC-H","SSC-H"),a=c(1,2),b=1,transformationId="dg1")
  transOut<-eval(dg1)(exprs(dat))

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.