factory module

Define a class to create the proper IMeasurementPoint.

class IMeasurementPointFactory(is_raw=False, create_virtual_instruments=True, commented_lines=None, **kwargs)

Bases: object

Class to create the proper GlobalDiagnostics PickUp.

It infers the proper type, position of instruments as well as the measured data from the configuration TOML file and the measurements CSV file.

Parameters:

• is_raw (bool, default: False)

• create_virtual_instruments (bool, default: True)

• commented_lines (Sequence[str] | None, default: None)

run_single(config_key, config_value, df_data, color)

Create a single measurement point.

Parameters:

• config_key (str) – A key from the TOML file. If ‘global’ keyword is in the key, we return a GlobalDiagnostics. Else, we return a PickUp.

• config_value (dict) – Values from the TOML file corresponding to config_key, which will passed down to the created IMeasurementPoint.

• df_data (DataFrame) – Full data from the CSV file.

• color (tuple[float, float, float])

Return type:

IMeasurementPoint | None

Returns:

A GlobalDiagnostics or PickUp.

run(config, df_data, verbose=False)

Create all the measurement points.

Parameters:

• config (dict[str, dict])

• df_data (DataFrame)

• verbose (bool, default: False)

Return type:

tuple[GlobalDiagnostics | None, list[PickUp]]

_filter_global_diagnostics(measurement_points, verbose=False)

Ensure that we have only one GlobalDiagnostics object.

Parameters:

• measurement_points (list[IMeasurementPoint])

• verbose (bool, default: False)

Return type:

GlobalDiagnostics | None

_filter_pick_ups(measurement_points, verbose=False)

Print information on the created pick-ups.

Parameters:

• measurement_points (list[IMeasurementPoint])

• verbose (bool, default: False)

Return type:

list[PickUp]