invsplitscale-class: Class "invsplitscale"

In RGLab/flowCore: flowCore: Basic structures for flow cytometry data

Class "invsplitscale"

Description

As its name suggests, the inverse split scale transformation class represents the inverse transformation of a split scale transformation that has a logarithmic scale at high values and a linear scale at low values.

Details

The inverse split scale transformation is defined by the function

f(parameter,r,maxValue,transitionChannel) \frac{(parameter-b)}{a}, parameter<=t*a + b

f(parameter,r,maxValue,transitionChannel) = \frac{10^{parameter*\frac{d}{r}}}{c}, parameter > t*a+b

where

b=\frac{transitionChannel}{2}

d=\frac{2*log_{10}(e)*r}{transitionChannel} + log_{10}(maxValue)

t=10^{log_{10}t}

a= \frac{transitionChannel}{2*t}

log_{10}ct=\frac{(a*t+b)*d}{r}

c=10^{log_{10}ct}

Slots

.Data

Object of class "function".

r

Object of class "numeric" – a positive value indicating the range of the logarithmic part of the dispmlay.

maxValue

Object of class "numeric" – a positive value indicating the maximum value the transformation is applied to.

transitionChannel

Object of class "numeric" – non negative value that indicates where to split the linear vs. logarithmic transformation.

parameters

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

transformationId

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

Objects from the Class

Objects can be created by calls to the constructor invsplitscale(parameters,r,maxValue,transitionChannel,transformationId)

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.

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

See Also

splitscale

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

Examples

  dat <- read.FCS(system.file("extdata","0877408774.B08",package="flowCore"))
  sp1<-invsplitscale("FSC-H",r=512,maxValue=2000,transitionChannel=512)
  transOut<-eval(sp1)(exprs(dat))

RGLab/flowCore documentation built on Aug. 26, 2024, 8:52 a.m.