piel.experimental.measurements.data.dc

piel.experimental.measurements.data.dc#

Functions#

construct_sourcemeter_sweep_signal_from_csv(...)

construct_sourcemeter_sweep_signal_from_dataframe(...)

construct_multimeter_sweep_signal_from_csv(...)

Construct a multimeter sweep signal from a CSV file.

construct_multimeter_sweep_signal_from_dataframe(...)

Construct a multimeter sweep signal from a dataframe.

extract_signal_data_from_dataframe(...)

Extract DC sweep data from a dataframe.

extract_signal_data_from_csv(...)

Extract DC sweep data from a CSV file.

extract_dc_sweeps_from_operating_point_csv(...)

Extract DC sweep data from a full operating point CSV file. The operating point CSV file contains the DC sweep data

extract_dc_sweep_experiment_data_from_csv(...)

Extract DC sweep data experiment data from a full operating point CSV file. The operating point CSV file contains the DC sweep data

extract_dc_metrics_from_experiment_data(experiment_data)

Module Contents#

construct_sourcemeter_sweep_signal_from_csv(file_path: piel.types.PathTypes, voltage_signal_name: str, current_signal_name: str, **kwargs) → piel.types.SignalDC[source]#
construct_sourcemeter_sweep_signal_from_dataframe(dataframe: pandas.DataFrame, voltage_signal_name: str, current_signal_name: str, signal_kwargs: dict = None, **kwargs) → piel.types.SignalDC[source]#
construct_multimeter_sweep_signal_from_csv(file_path: piel.types.PathTypes, signal_name: str, unit: piel.types.Unit = V, **kwargs) → piel.types.SignalDC[source]#

Construct a multimeter sweep signal from a CSV file.

Parameters:

  • file_path (PathTypes) – The path to the CSV file.

  • signal_name (str) – The name of the signal.

  • unit (Unit) – Determines type of signal.

  • **kwargs

Returns:

  • SignalDC – The multimeter sweep signal

construct_multimeter_sweep_signal_from_dataframe(dataframe: pandas.DataFrame, signal_name: str, signal_kwargs: dict = None, **kwargs) → piel.types.SignalDC[source]#

Construct a multimeter sweep signal from a dataframe.

Parameters:

  • dataframe (pd.DataFrame) – The dataframe containing the multimeter sweep signal data.

  • signal_name (str) – The name of the signal.

  • signal_kwargs (dict) – Additional keyword arguments.

  • **kwargs

Returns:

  • SignalDC – The multimeter sweep signal

extract_signal_data_from_dataframe(dataframe: pandas.DataFrame, input_signal_name_list: list[piel.types.VoltageCurrentSignalNamePair], output_signal_name_list: list[str], power_signal_name_list: list[piel.types.VoltageCurrentSignalNamePair], **kwargs) → piel.types.SignalDCCollection[source]#

Extract DC sweep data from a dataframe.

Parameters:

  • dataframe (pd.DataFrame) – The dataframe containing the DC sweep data.

  • input_signal_name_list (list[VoltageCurrentSignalNamePair]) – The pairs of sourcemeter voltage and current signal names.

  • output_signal_name_list (list[str]) – The multimeter signals.

  • power_signal_name_list (list[VoltageCurrentSignalNamePair]) – The pairs of sourcemeter voltage and current signal names.

  • **kwargs – Additional keyword arguments.

Returns:

  • SignalDCCollection – The DC sweep data.

extract_signal_data_from_csv(file_path: piel.types.PathTypes, input_signal_name_list: list[piel.types.VoltageCurrentSignalNamePair], output_signal_name_list: list[str], power_signal_name_list: list[piel.types.VoltageCurrentSignalNamePair], **kwargs) → piel.types.SignalDCCollection[source]#

Extract DC sweep data from a CSV file.

Parameters:

  • file_path (PathTypes) – The path to the CSV file.

  • input_signal_name_list (list[VoltageCurrentSignalNamePair]) – The pairs of sourcemeter voltage and current signal names.

  • output_signal_name_list (list[str]) – The multimeter signals.

  • power_signal_name_list (list[VoltageCurrentSignalNamePair]) – The pairs of sourcemeter voltage and current signal names relating to power lines.

  • **kwargs – Additional keyword arguments.

Returns:

  • SignalDCCollection – The DC sweep data.

extract_dc_sweeps_from_operating_point_csv(file_path: piel.types.PathTypes, input_signal_name_list: list[piel.types.VoltageCurrentSignalNamePair], output_signal_name_list: list[str], power_signal_name_list: list[piel.types.VoltageCurrentSignalNamePair], unique_operating_point_columns: list[str], **kwargs) → piel.types.DCSweepMeasurementDataCollection[source]#

Extract DC sweep data from a full operating point CSV file. The operating point CSV file contains the DC sweep data for multiple operating points. The unique operating point columns are used to extract the unique operating points from the CSV file. The DC sweep data is then extracted for each unique operating point. The DC sweep data is returned as a DCMeasurementDataCollection. The DCMeasurementDataCollection is a list of DCMeasurementDataTypes.

Parameters:

  • file_path (PathTypes) – The path to the operating point CSV file.

  • input_signal_name_list (list[VoltageCurrentSignalNamePair]) – The pairs of sourcemeter voltage and current signal names.

  • output_signal_name_list (list[str]) – The multimeter signals.

  • power_signal_name_list (list[VoltageCurrentSignalNamePair]) – The pairs of sourcemeter voltage and current signal names relating to power lines.

  • unique_operating_point_columns (list[str]) – The unique operating point columns.

  • **kwargs – Additional keyword arguments.

Returns:

The DC sweep data collection.

Return type:

DCMeasurementDataCollection

extract_dc_sweep_experiment_data_from_csv(file_path: piel.types.PathTypes, input_signal_name_list: list[piel.types.VoltageCurrentSignalNamePair], output_signal_name_list: list[str], power_signal_name_list: list[piel.types.VoltageCurrentSignalNamePair], unique_operating_point_columns: list[str], **kwargs) → piel.types.ExperimentData[source]#

Extract DC sweep data experiment data from a full operating point CSV file. The operating point CSV file contains the DC sweep data for multiple operating points. The unique operating point columns are used to extract the unique operating points from the CSV file. The DC sweep data is then extracted for each unique operating point. The DC sweep data is returned as a ExperimentData with the unique_operating_point_columns as part of the parameter_list definition, and the sweep data as part of the collection DCSweepMeasurementDataCollection.

Parameters:

  • file_path (PathTypes) – The path to the operating point CSV file.

  • input_signal_name_list (list[VoltageCurrentSignalNamePair]) – The pairs of sourcemeter voltage and current signal names.

  • output_signal_name_list (list[str]) – The multimeter signals.

  • power_signal_name_list (list[VoltageCurrentSignalNamePair]) – The pairs of sourcemeter voltage and current signal names of the power lines.

  • unique_operating_point_columns (list[str]) – The unique operating point columns.

  • **kwargs – Additional keyword arguments.

Returns:

A collection of experiment and metadata to represent a DC sweep analysis.

Return type:

ExperimentData

extract_dc_metrics_from_experiment_data(experiment_data: piel.types.ExperimentData, parameter_column: str = 'driver_b_v_set', label_column_name='ID', **kwargs)[source]#
Contents