FlowUtils API

FlowUtils includes 2 modules: compensate and transforms containing functions for compensation and various transforms, respectively.

compensate Module

The compensate module includes functions for parsing the spillover keyword value from the metadata within an FCS file, creating a compensation from CSV or NumPy input types, and for applying a compensation matrix to FCS event data (as a NumPy array).

• compensate functions
  • get_spill()
  • parse_compensation_matrix()
  • compensate()
  • inverse_compensate()

transforms Module

The transforms module includes functions for applying various transformations (and their inverse) to FCS event data that are commonly used within the flow cytometry community. These include:

• Logarithmic

• Inverse hyperbolic sine (asinh)

• Logicle

• Hyperlog

• transforms functions
  • logicle()
  • logicle_inverse()
  • hyperlog()
  • hyperlog_inverse()
  • asinh()
  • asinh_inverse()
  • log()
  • log_inverse()

gating Module

The gating module includes helper functions related to evaluating event membership within gates.

• gating functions
  • points_in_ellipsoid()
  • points_in_polygon()