Measurement Classes

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

Optical

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

FCS 2.0 $Pn* keywords for optical measurement.

Variables:

• wavelength (float | None) – (read-write) Value of $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 of $PnF. Defaults to "".

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

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

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

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

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

Raises:

• 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

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

FCS 3.0 $Pn* keywords for optical measurement.

Variables:

• wavelength (float | None) – (read-write) Value of $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 of $PnF. Defaults to "".

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

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

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

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

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

Raises:

• 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

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

FCS 3.1 $Pn* keywords for optical measurement.

Variables:

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

• calibration (Calibration3_1 | None) – (read-write) Value of $PnCALIBRATION. Tuple encodes slope and calibration units. Defaults to None.

• display (Display | 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 of $PnF. Defaults to "".

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

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

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

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

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

Raises:

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

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

class pyreflow.Optical3_2(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='')

FCS 3.2 $Pn* keywords for optical measurement.

Variables:

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

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

• display (Display | 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 of $PnANALYTE. Defaults to "".

• feature (str | None) – (read-write) Value of $PnFEATURE. Defaults to None.

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

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

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

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

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

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

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

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

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

Raises:

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

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

awh_feature

Value of $PnFEATURE (area/width/height) (read-write).

This should be the preferred way to get and set this keyword if one knows that only "Area", "Width", and "Height" will be used since it has a well-defined type.

Return type:

Literal[“Area”, “Width”, “Height”] | None

Temporal

class pyreflow.Temporal2_0(bin=None, size=None, longname='')

FCS 2.0 $Pn* keywords for temporal measurement.

Variables:

• 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 of $PnS. Defaults to "".

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

FCS 3.0 $Pn* keywords for temporal measurement.

Variables:

• timestep (Timestep) – (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 of $PnS. Defaults to "".

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

FCS 3.1 $Pn* keywords for temporal measurement.

Variables:

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

• display (Display | 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 of $PnS. Defaults to "".

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

FCS 3.2 $Pn* keywords for temporal measurement.

Variables:

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

• display (Display | 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 of $PnTYPE. Defaults to False.

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