sensortoolkit.param._parameter.Parameter

class Parameter(param, set_units=True, **kwargs)[source]

Bases: object

Object for accessing parameter attributes.

Here, parameters are defined as measurable environmental quantities such as pollutants or meteorological conditions for which air sensors and reference instrumentation may collect measurements at regular sampling intervals.

Parameters
  • param (str) – The name of a parameter. Passing an SDFS parameter will initialize a parameter instance with preset parameter attributes. Non-SDFS parameters will require user-input for specifying these attributes.

  • set_units (bool, optional) – If true, will attempt to assign units to the parameter. If the parameter name is not recognized as an SDFS parameter and set_units is True, the user will be prompted to enter the units for the parameter instance. Defaults to True.

name

The name of the parameter (e.g., 'PM25').

Type

str

format_name

A formatted expression for the parameter used for displaying the name of the parameter on plots (e.g., 'PM$_{2.5}$').

Type

str

format_baseline

For format_name, contains the baseline component of the parameter name (e.g., 'PM' for fine particulate matter)

Type

str

format_subscript

For format_name, contains the subscripted component of the parameter name (e.g., '2.5' for fine particulate matter)

Type

str

classifier

A term for sorting the parameter into one of three environmental parameter classifications, either ‘PM’ for particulate matter pollutants, ‘Gases’ for gaseous pollutants, or ‘Met’ for meteorological environmental parameters (e.g., 'PM25' is assigned to the ‘PM’ classifier).

Type

str

criteria_pollutant

Describes whether the parameter is a criteria pollutant (True) or non-criteria (False).

Type

bool

aqs_parameter_code

The AQS Parameter code. See resource #1 in the module docstring for a detailed list of AQS parameter codes.

Type

int

averaging

The reference measurement averaging intervals commonly utilized for analyzing parameter data. Common averaging intervals are included in a list (e.g., fine particulate matter as measured by FRM or FEM instrumentation may report data at either 1-hour or 24-hour sampling or averaging intervals, such that averaging would be ['1-hour', '24-hour']).

Type

list

units

The units of measure, expressed symbolically in unicode characters (e.g., for fine particulate matter, 'µg/m³').

Type

str

units_description

A textual description of the units of measure (e.g., for fine particulate matter, ‘Micrograms per Cubic Meter’).

Type

str

units_aqs_code

The AQS unit code. See resource #2 in the module docstring for a detailed list of AQS parameter codes.

Type

int

PerformanceTargets

Performance metrics, target values and ranges associated with the parameter. Preset values are configured for \(PM_{2.5}\) and \(O_3\) using U.S. EPA’s recommended performance metrics and targets for air sensors measuring these pollutants.

Type

sensortoolkit.ParameterTargets object

Methods

is_sdfs

Indicate whether the passed parameter name is in the catalog of parameter names for the sensortoolkit Data Formatting Scheme (SDFS).

is_sdfs()[source]

Indicate whether the passed parameter name is in the catalog of parameter names for the sensortoolkit Data Formatting Scheme (SDFS).

Returns

Return True if in the catalog, otherwise return False.

Return type

bool