Measurement Classes

The following classes encode the $Pn* keywords for a single measurement.

Optical

class pyreflow.Optical2_0(scale=None, wavelength=None, bin=None, size=None, filter='', power=None, detector_type='', percent_emitted=None, detector_voltage=None, longname='', nonstandard_keywords={})

FCS 2.0 $Pn* keywords for optical measurement.

Variables:

• scale (tuple[()] | tuple[float, float] | None) – (read-write) Value for $PnE. Empty tuple means linear scale; 2-tuple encodes decades and offset for log scale Defaults to None.

• wavelength (float | None) – (read-write) Value for $PnL. Defaults to None.

• bin (int | None) – (read-write) Value of $PKn. Defaults to None.

• size (int | None) – (read-write) Value of $PKNn. Defaults to None.

• filter (str) – (read-write) Value for $PnF. Defaults to "".

• power (float | None) – (read-write) Value for $PnO. Defaults to None.

• detector_type (str) – (read-write) Value for $PnT. Defaults to "".

• percent_emitted (float | None) – (read-write) Value for $PnP. Defaults to None.

• detector_voltage (float | None) – (read-write) Value for $PnV. Defaults to None.

• longname (str) – (read-write) Value for $PnS. Defaults to "".

• nonstandard_keywords (dict[str, str]) – (read-write) Any non-standard keywords corresponding to this measurement. No keys should start with $. Realistically each key should follow a pattern corresponding to the measurement index, something like prefixing with “P” followed by the index. This is not enforced. Defaults to {}.

Raises:

• OverflowError – if bin or size is less than 0 or greater than 2**32-1

• InvalidKeywordValueError – if scale has log scale floats which are not both positive

• InvalidKeywordValueError – if wavelength is negative, 0.0, NaN, inf, or -inf

• InvalidKeywordValueError – if detector_voltage, percent_emitted, or power is negative, NaN, inf, or -inf

• ParseKeyError – if dict key in nonstandard_keywords is empty or starts with "$"

class pyreflow.Optical3_0(transform, wavelength=None, bin=None, size=None, filter='', power=None, detector_type='', percent_emitted=None, detector_voltage=None, longname='', nonstandard_keywords={})

FCS 3.0 $Pn* keywords for optical measurement.

Variables:

• transform (float | tuple[float, float]) – (read-write) Value for $PnE and/or $PnG. Singleton float encodes gain ($PnG) and implies linear scaling (ie $PnE is 0,0). 2-tuple encodes decades and offset for log scale, and implies $PnG is not set.

• wavelength (float | None) – (read-write) Value for $PnL. Defaults to None.

• bin (int | None) – (read-write) Value of $PKn. Defaults to None.

• size (int | None) – (read-write) Value of $PKNn. Defaults to None.

• filter (str) – (read-write) Value for $PnF. Defaults to "".

• power (float | None) – (read-write) Value for $PnO. Defaults to None.

• detector_type (str) – (read-write) Value for $PnT. Defaults to "".

• percent_emitted (float | None) – (read-write) Value for $PnP. Defaults to None.

• detector_voltage (float | None) – (read-write) Value for $PnV. Defaults to None.

• longname (str) – (read-write) Value for $PnS. Defaults to "".

• nonstandard_keywords (dict[str, str]) – (read-write) Any non-standard keywords corresponding to this measurement. No keys should start with $. Realistically each key should follow a pattern corresponding to the measurement index, something like prefixing with “P” followed by the index. This is not enforced. Defaults to {}.

Raises:

• OverflowError – if bin or size is less than 0 or greater than 2**32-1

• InvalidKeywordValueError – if transform has log scale floats which are not both positive

• InvalidKeywordValueError – if wavelength is negative, 0.0, NaN, inf, or -inf

• InvalidKeywordValueError – if detector_voltage, percent_emitted, or power is negative, NaN, inf, or -inf

• ParseKeyError – if dict key in nonstandard_keywords is empty or starts with "$"

class pyreflow.Optical3_1(transform, wavelengths=[], calibration=None, display=None, bin=None, size=None, filter='', power=None, detector_type='', percent_emitted=None, detector_voltage=None, longname='', nonstandard_keywords={})

FCS 3.1 $Pn* keywords for optical measurement.

Variables:

• transform (float | tuple[float, float]) – (read-write) Value for $PnE and/or $PnG. Singleton float encodes gain ($PnG) and implies linear scaling (ie $PnE is 0,0). 2-tuple encodes decades and offset for log scale, and implies $PnG is not set.

• wavelengths (list[float]) – (read-write) Value for $PnL. Defaults to [].

• calibration (tuple[float, str] | None) – (read-write) Value of $PnCALIBRATION. Tuple encodes slope and calibration units. Defaults to None.

• display (tuple[bool, float, float] | None) – (read-write) Value of $PnD. First member of tuple encodes linear or log display (False and True respectively). The float members encode lower/upper and decades/offset for linear and log scaling respectively. Defaults to None.

• bin (int | None) – (read-write) Value of $PKn. Defaults to None.

• size (int | None) – (read-write) Value of $PKNn. Defaults to None.

• filter (str) – (read-write) Value for $PnF. Defaults to "".

• power (float | None) – (read-write) Value for $PnO. Defaults to None.

• detector_type (str) – (read-write) Value for $PnT. Defaults to "".

• percent_emitted (float | None) – (read-write) Value for $PnP. Defaults to None.

• detector_voltage (float | None) – (read-write) Value for $PnV. Defaults to None.

• longname (str) – (read-write) Value for $PnS. Defaults to "".

• nonstandard_keywords (dict[str, str]) – (read-write) Any non-standard keywords corresponding to this measurement. No keys should start with $. Realistically each key should follow a pattern corresponding to the measurement index, something like prefixing with “P” followed by the index. This is not enforced. Defaults to {}.

Raises:

• OverflowError – if bin or size is less than 0 or greater than 2**32-1

• ValueError – if display represents a log display (field 1 is True) and the two floats are not both positive

• InvalidKeywordValueError – if transform has log scale floats which are not both positive

• InvalidKeywordValueError – if detector_voltage, percent_emitted, or power is negative, NaN, inf, or -inf

• InvalidKeywordValueError – if field 1 in calibration is negative, 0.0, NaN, inf, or -inf

• InvalidKeywordValueError – if any in wavelengths is negative, 0.0, NaN, inf, or -inf

• ParseKeyError – if dict key in nonstandard_keywords is empty or starts with "$"

class pyreflow.Optical3_2(transform, wavelengths=[], calibration=None, display=None, analyte='', feature=None, tag='', measurement_type='', detector_name='', filter='', power=None, detector_type='', percent_emitted=None, detector_voltage=None, longname='', nonstandard_keywords={})

FCS 3.2 $Pn* keywords for optical measurement.

Variables:

• transform (float | tuple[float, float]) – (read-write) Value for $PnE and/or $PnG. Singleton float encodes gain ($PnG) and implies linear scaling (ie $PnE is 0,0). 2-tuple encodes decades and offset for log scale, and implies $PnG is not set.

• wavelengths (list[float]) – (read-write) Value for $PnL. Defaults to [].

• calibration (tuple[float, float, str] | None) – (read-write) Value of $PnCALIBRATION. Tuple encodes slope, intercept, and calibration units. Defaults to None.

• display (tuple[bool, float, float] | None) – (read-write) Value of $PnD. First member of tuple encodes linear or log display (False and True respectively). The float members encode lower/upper and decades/offset for linear and log scaling respectively. Defaults to None.

• analyte (str) – (read-write) Value for $PnANALYTE. Defaults to "".

• feature (Literal[“Area”, “Width”, “Height”] | None) – (read-write) Value for $PnFEATURE. Defaults to None.

• tag (str) – (read-write) Value for $PnTAG. Defaults to "".

• measurement_type (str) – (read-write) Value for $PnTYPE. Defaults to "".

• detector_name (str) – (read-write) Value for $PnDET. Defaults to "".

• filter (str) – (read-write) Value for $PnF. Defaults to "".

• power (float | None) – (read-write) Value for $PnO. Defaults to None.

• detector_type (str) – (read-write) Value for $PnT. Defaults to "".

• percent_emitted (float | None) – (read-write) Value for $PnP. Defaults to None.

• detector_voltage (float | None) – (read-write) Value for $PnV. Defaults to None.

• longname (str) – (read-write) Value for $PnS. Defaults to "".

• nonstandard_keywords (dict[str, str]) – (read-write) Any non-standard keywords corresponding to this measurement. No keys should start with $. Realistically each key should follow a pattern corresponding to the measurement index, something like prefixing with “P” followed by the index. This is not enforced. Defaults to {}.

Raises:

• ValueError – if display represents a log display (field 1 is True) and the two floats are not both positive

• InvalidKeywordValueError – if transform has log scale floats which are not both positive

• InvalidKeywordValueError – if detector_voltage, percent_emitted, or power is negative, NaN, inf, or -inf

• InvalidKeywordValueError – if field 1 in calibration is negative, 0.0, NaN, inf, or -inf

• InvalidKeywordValueError – if any in wavelengths is negative, 0.0, NaN, inf, or -inf

• ParseKeyError – if dict key in nonstandard_keywords is empty or starts with "$"

Temporal

class pyreflow.Temporal2_0(has_scale=False, bin=None, size=None, longname='', nonstandard_keywords={})

FCS 2.0 $Pn* keywords for temporal measurement.

Variables:

• has_scale (bool) – (read-write) Value for $PnE. Defaults to False.

• bin (int | None) – (read-write) Value of $PKn. Defaults to None.

• size (int | None) – (read-write) Value of $PKNn. Defaults to None.

• longname (str) – (read-write) Value for $PnS. Defaults to "".

• nonstandard_keywords (dict[str, str]) – (read-write) Any non-standard keywords corresponding to this measurement. No keys should start with $. Realistically each key should follow a pattern corresponding to the measurement index, something like prefixing with “P” followed by the index. This is not enforced. Defaults to {}.

Raises:

• OverflowError – if bin or size is less than 0 or greater than 2**32-1

• ParseKeyError – if dict key in nonstandard_keywords is empty or starts with "$"

class pyreflow.Temporal3_0(timestep, bin=None, size=None, longname='', nonstandard_keywords={})

FCS 3.0 $Pn* keywords for temporal measurement.

Variables:

• timestep (float) – (read-write) Value of $TIMESTEP.

• bin (int | None) – (read-write) Value of $PKn. Defaults to None.

• size (int | None) – (read-write) Value of $PKNn. Defaults to None.

• longname (str) – (read-write) Value for $PnS. Defaults to "".

• nonstandard_keywords (dict[str, str]) – (read-write) Any non-standard keywords corresponding to this measurement. No keys should start with $. Realistically each key should follow a pattern corresponding to the measurement index, something like prefixing with “P” followed by the index. This is not enforced. Defaults to {}.

Raises:

• OverflowError – if bin or size is less than 0 or greater than 2**32-1

• InvalidKeywordValueError – if timestep is negative, 0.0, NaN, inf, or -inf

• ParseKeyError – if dict key in nonstandard_keywords is empty or starts with "$"

class pyreflow.Temporal3_1(timestep, display=None, bin=None, size=None, longname='', nonstandard_keywords={})

FCS 3.1 $Pn* keywords for temporal measurement.

Variables:

• timestep (float) – (read-write) Value of $TIMESTEP.

• display (tuple[bool, float, float] | None) – (read-write) Value of $PnD. First member of tuple encodes linear or log display (False and True respectively). The float members encode lower/upper and decades/offset for linear and log scaling respectively. Defaults to None.

• bin (int | None) – (read-write) Value of $PKn. Defaults to None.

• size (int | None) – (read-write) Value of $PKNn. Defaults to None.

• longname (str) – (read-write) Value for $PnS. Defaults to "".

• nonstandard_keywords (dict[str, str]) – (read-write) Any non-standard keywords corresponding to this measurement. No keys should start with $. Realistically each key should follow a pattern corresponding to the measurement index, something like prefixing with “P” followed by the index. This is not enforced. Defaults to {}.

Raises:

• OverflowError – if bin or size is less than 0 or greater than 2**32-1

• ValueError – if display represents a log display (field 1 is True) and the two floats are not both positive

• InvalidKeywordValueError – if timestep is negative, 0.0, NaN, inf, or -inf

• ParseKeyError – if dict key in nonstandard_keywords is empty or starts with "$"

class pyreflow.Temporal3_2(timestep, display=None, has_type=False, longname='', nonstandard_keywords={})

FCS 3.2 $Pn* keywords for temporal measurement.

Variables:

• timestep (float) – (read-write) Value of $TIMESTEP.

• display (tuple[bool, float, float] | None) – (read-write) Value of $PnD. First member of tuple encodes linear or log display (False and True respectively). The float members encode lower/upper and decades/offset for linear and log scaling respectively. Defaults to None.

• has_type (bool) – (read-write) Value for $PnTYPE. Defaults to False.

• longname (str) – (read-write) Value for $PnS. Defaults to "".

• nonstandard_keywords (dict[str, str]) – (read-write) Any non-standard keywords corresponding to this measurement. No keys should start with $. Realistically each key should follow a pattern corresponding to the measurement index, something like prefixing with “P” followed by the index. This is not enforced. Defaults to {}.

Raises:

• ValueError – if display represents a log display (field 1 is True) and the two floats are not both positive

• InvalidKeywordValueError – if timestep is negative, 0.0, NaN, inf, or -inf

• ParseKeyError – if dict key in nonstandard_keywords is empty or starts with "$"