HyperlogTransform Class

class flowkit.transforms.HyperlogTransform(transform_id, param_t, param_w, param_m, param_a)

Hyperlog transformation, implemented as defined in the GatingML 2.0 specification:

hyperlog(x, T, W, M, A) = root(EH(y, T, W, M, A) − x)

where EH is defined as:

EH(y, T, W, M, A) = ae^(by) + cy − f

The Hyperlog transformation was originally defined in the publication:

Bagwell CB. Hyperlog-a flexible log-like transform for negative, zero, and positive valued data. Cytometry A., 2005:64(1):34–42.

Parameters:

transform_id – A string identifying the transform
param_t – parameter for the top of the linear scale (e.g. 262144)
param_m – parameter for desired number of decades
param_w – parameter for the approximate number of decades in the linear region
param_a – parameter for the additional number of negative decades

apply(events)

Apply transform to given events.

inverse(events)

Apply the inverse transform to given events.