Gating Classes

The following classes encode the gating keywords ($Gn*, $Rn*, $GATING, and $GATE).

These apply to each FCS version as follows (note that 3_0 is reused for both FCS 3.0 and FCS 3.1):

Version

UnivariateRegion*

BivariateRegion*

FCS2.0

UnivariateRegion2_0

BivariateRegion2_0

FCS3.0

UnivariateRegion3_0

BivariateRegion3_0

FCS3.1

UnivariateRegion3_0

BivariateRegion3_0

FCS3.2

UnivariateRegion3_2

BivariateRegion3_2

Univariate Regions

These encode one pair of $RnI and $RnW where each has a scaler value corresponding to a univariate gate.

class pyreflow.UnivariateRegion2_0(index, gate)

Make a new FCS 2.0-compatible univariate region

Variables:

  • index (int) – (read-only) The index corresponding to a gating measurement (the m in the $Gm* keywords).

  • gate (tuple[Decimal, Decimal]) – (read-only) The lower and upper bounds of the gate.

class pyreflow.UnivariateRegion3_0(index, gate)

Make a new FCS 3.0/3.1-compatible univariate region

Variables:

  • index (str) – (read-only) The index corresponding to either a gating or a physical measurement (the m and n in the $Gm* or $Pn* keywords). Must be a string like either Gm or Pn where m is an integer and the prefix corresponds to a gating or physical measurement respectively.

  • gate (tuple[Decimal, Decimal]) – (read-only) The lower and upper bounds of the gate.

Raises:

ParseKeywordValueError – if index is not like P<X> or G<X> where X is an integer one or greater

class pyreflow.UnivariateRegion3_2(index, gate)

Make a new FCS 3.2-compatible univariate region

Variables:

  • index (int) – (read-only) The index corresponding to a physical measurement (the n in the $Pn* keywords).

  • gate (tuple[Decimal, Decimal]) – (read-only) The lower and upper bounds of the gate.

Bivariate Regions

These encode one pair of $RnI and $RnW where each has a pair of values corresponding to a bivariate gate.

class pyreflow.BivariateRegion2_0(index, vertices)

Make a new FCS 2.0-compatible bivariate region

Variables:

  • index (tuple[int, int]) – (read-only) The x/y indices corresponding to a gating measurement (the m in the $Gm* keywords).

  • vertices (list[tuple[float, float]]) – (read-only) The vertices of a polygon gate. Must not be empty.

Raises:

InvalidKeywordValueError – if vertices is empty

class pyreflow.BivariateRegion3_0(index, vertices)

Make a new FCS 3.0/3.1-compatible bivariate region

Variables:

  • index (tuple[str, str]) – (read-only) The x/y indices corresponding to either a gating or a physical measurement (the m and n in the $Gm* or $Pn* keywords). Each must be a string like either Gm or Pn where m is an integer and the prefix corresponds to a gating or physical measurement respectively.

  • vertices (list[tuple[float, float]]) – (read-only) The vertices of a polygon gate. Must not be empty.

Raises:
class pyreflow.BivariateRegion3_2(index, vertices)

Make a new FCS 3.2-compatible bivariate region

Variables:

  • index (tuple[int, int]) – (read-only) The x/y indices corresponding to a physical measurement (the n in the $Pn* keywords).

  • vertices (list[tuple[float, float]]) – (read-only) The vertices of a polygon gate. Must not be empty.

Raises:

InvalidKeywordValueError – if vertices is empty

Gated Measurements

This encodes one “gated measurement” described by the $Gn* keywords for a given index n.

class pyreflow.GatedMeasurement(scale=None, filter='', shortname=None, percent_emitted=None, range=None, longname='', detector_type='', detector_voltage=None)

The $Gm* keywords for one gated measurement.

Variables:

  • scale (tuple[()] | tuple[float, float] | None) – (read-write) The $GmE keyword. () means linear scaling and 2-tuple specifies decades and offset for log scaling. Defaults to None.

  • filter (str) – (read-write) The $GmF keyword. Defaults to "".

  • shortname (str | None) – (read-write) The $GmN keyword. Defaults to None.

  • percent_emitted (float | None) – (read-write) The $GmP keyword. Defaults to None.

  • range (Decimal | None) – (read-write) The $GmR keyword. Defaults to None.

  • longname (str) – (read-write) The $GmS keyword. Defaults to "".

  • detector_type (str) – (read-write) The $GmT keyword. Defaults to "".

  • detector_voltage (float | None) – (read-write) The $GmV keyword. Defaults to None.

Raises: