Descriptive Summary Methods

Below is a discussion of descriptive summary methods included alongside SensorEvaluation. These methods print formatted summaries in the console for testing conditions and evaluation statistics, printed to the console. Example outputs are shown for each summary method.

Note

This section provides a brief overview of the descriptive summary methods accessed via instances of the SensorEvaluation class. For more detail on calling these methods, click on the link to the API documentation indicated below each method header.

Important

A console width of at least 86 characters is recommended to properly format printed statements resulting from these methods.

SensorEvaluation.print_eval_metrics()

API Documentation for print_eval_metrics()

Example

Below is an example for the Toco Toucan Quickstart Guide example

----------------------------------------------------------------------------------------
                 Toco_Toucan 1-hour Performance Evaluation Results
        Reference Method: Teledyne Advanced Pollution Instrumentation T640X
----------------------------------------------------------------------------------------
  CV  |         Slope          |       Intercept        |          R^2           | RMSE
----------------------------------------------------------------------------------------
 13.0 |          0.79          |         -1.69          |          0.54          | 3.6
      |     (0.75 to 0.82)     |    (-1.73 to -1.66)    |     (0.52 to 0.56)     |

Description

Display a summary of performance evaluation results using EPA’s recommended performance metrics.

The coefficient of variation, sensor vs FRM/FEM OLS regression slope, intercept, and R2,, and RMSE are displayed. Regression statistics are computed for each sensor, and the mean metric value is presented alongside the range (min to max).

SensorEvaluation.print_eval_conditions()

API Documentation for print_eval_conditions()

Example

Below is an example for the Toco Toucan Quickstart Guide example

----------------------------------------------------------------------------------------
                    Toco_Toucan (3) 1-hour Evaluation Conditions
----------------------------------------------------------------------------------------
  Eval period  |   Duration   | Sensor PM25  |   Ref PM25   |     Temp     |      RH
----------------------------------------------------------------------------------------
   08-01-19-   |   31 days    |     4.5      |     7.8      |      26      |      72
    09-01-19   |              |(0.9 to 13.8) |(3.3 to 15.3) |  (14 to 38)  |  (24 to 97)

Description

Display conditions for the evaluation parameter and meteorological conditions during the testing period.

Values for the evaluation parameter recorded by the sensor, FRM/FEM instrument, and temperature and relative humidity values are displayed by the mean of 1-hour or 24-hour averages during the testing period. The range (min to max) of each parameter is listed below the mean in parentheses.