AsinhTransform Class

class flowkit.transforms.AsinhTransform(param_t, param_m, param_a)

An implementation of the parametrized inverse hyperbolic sine function as defined in the GatingML 2.0 specification.

This transformation provides an inverse hyperbolic sine transformation that maps a data value onto the interval [0,1] such that:

  • The top of scale value (i.e, param_t) is mapped to 1.

  • Large data values are mapped to locations similar to the logarithmic scale.

  • param_a decades of negative data are brought on scale.

Parameters:
  • param_t – parameter specifying the top of the scale, (e.g. 262144)

  • param_m – parameter for the number of decades

  • param_a – parameter for the number of additional negative decades

apply(events)

Apply transform to given events.

Parameters:

events – NumPy array of FCS event data

Returns:

NumPy array of transformed events

inverse(events)

Apply the inverse transform to given events.

Parameters:

events – NumPy array of FCS event data

Returns:

NumPy array of inversely transformed events