measurements package

Submodules

measurements.pulsedIV module

class measurements.pulsedIV.Measurement(logger, config, instrument)

Bases: object

initialize_instrument(logger, instrument)

Initialize the instrument with the specified parameters.

Parameters:

• logger (logging.Logger) – The logger object to use for logging messages.

• instrument (object) – The instrument object used for measurement.

measure_val(logger, instrument, val)

Perform a measurement for a specific value.

Parameters:

• logger (logging.Logger) – The logger object to use for logging messages.

• instrument (object) – The instrument object used for measurement.

• val (float) – The value to measure.

Returns:

The measurement results and plots.

Return type:

list

set_plot_parameters(cycle_type)

Set the plot parameters based on the cycle type.

Parameters:

cycle_type (str) – The cycle type.

measurements.pulsedIV.create_list(logger, cycle, max_val, min_val, step)

Create a list of values based on the specified cycle type and parameters.

Parameters:

• logger (logging.Logger) – The logger object to use for logging messages.

• cycle (str) – The cycle type. Valid values are ‘+’, ‘-’, ‘+-’, ‘-+’.

• max_val (float) – The maximum value for the list.

• min_val (float) – The minimum value for the list.

• step (float) – The step size between consecutive values.

Returns:

The generated list of values, rounded to 5 decimal places.

Return type:

numpy.ndarray

Raises:

ValueError – If the cycle type is invalid.

measurements.pulsedVI module

class measurements.pulsedVI.Measurement(logger, config, instrument)

Bases: object

initialize_instrument(logger, instrument)

Initialize the instrument with the specified parameters.

Parameters:

• logger (logging.Logger) – The logger object to use for logging messages.

• instrument (object) – The instrument object used for measurement.

measure_val(logger, instrument, val)

Perform a measurement for a specific value.

Parameters:

• logger (logging.Logger) – The logger object to use for logging messages.

• instrument (object) – The instrument object used for measurement.

• val (float) – The value to measure.

Returns:

The measurement results and plots.

Return type:

list

set_plot_parameters(cycle_type)

Set the plot parameters based on the cycle type.

Parameters:

cycle_type (str) – The cycle type.

measurements.pulsedVI.create_list(logger, cycle, max_val, min_val, step)

Create a list of values based on the specified cycle type and parameters.

Parameters:

• logger (logging.Logger) – The logger object to use for logging messages.

• cycle (str) – The cycle type. Valid values are ‘+’, ‘-’, ‘+-’, ‘-+’.

• max_val (float) – The maximum value for the list.

• min_val (float) – The minimum value for the list.

• step (float) – The step size between consecutive values.

Returns:

The generated list of values, rounded to 5 decimal places.

Return type:

numpy.ndarray

Raises:

ValueError – If the cycle type is invalid.

measurements.sweepIV module

class measurements.sweepIV.Measurement(logger, config, instrument)

Bases: object

initialize_instrument(logger, instrument)

Initialize the instrument with initial parameters.

Args: logger (logging.Logger): Logger to use for logging messages. instrument (Instrument): Instrument object to use for setting parameters.

measure_val(logger, instrument, val)

Measure the output for a given voltage and return the result along with the plots.

Args: logger (logging.Logger): Logger to use for logging messages. instrument (Instrument): Instrument object to use for measurement. val (float): The voltage value to measure.

Returns: list: A list containing the result of measurement and the plots.

set_plot_parameters(cycle_type)

Set parameters for the plot based on the type of cycle.

Args: cycle_type (str): Type of the cycle which could be ‘1’ or ‘2’.

measurements.sweepIV.create_list(logger, cycle, max_val, min_val, step)

Create a list of values based on the specified cycle type and parameters.

Parameters:

• logger (logging.Logger) – The logger object to use for logging messages.

• cycle (str) – The cycle type. Valid values are ‘+’, ‘-’, ‘+-’, ‘-+’.

• max_val (float) – The maximum value for the list.

• min_val (float) – The minimum value for the list.

• step (float) – The step size between consecutive values.

Returns:

The generated list of values, rounded to 5 decimal places.

Return type:

numpy.ndarray

Raises:

ValueError – If the cycle type is invalid.

measurements.sweepVI module

class measurements.sweepVI.Measurement(logger, config, instrument)

Bases: object

initialize_instrument(logger, instrument)

Initialize the instrument with initial parameters.

Args: logger (logging.Logger): Logger to use for logging messages. instrument (Instrument): Instrument object to use for setting parameters.

measure_val(logger, instrument, val)

Measure the output for a given current and return the result along with the plots.

Args: logger (logging.Logger): Logger to use for logging messages. instrument (Instrument): Instrument object to use for measurement. val (float): The current value to measure.

Returns: list: A list containing the result of measurement and the plots.

set_plot_parameters(cycle_type)

Set parameters for the plot based on the type of cycle.

Args: cycle_type (str): Type of the cycle which could be ‘1’ or ‘2’.

measurements.sweepVI.create_list(logger, cycle, max_val, min_val, step)

Create a list of values based on the specified cycle type and parameters.

Parameters:

• logger (logging.Logger) – The logger object to use for logging messages.

• cycle (str) – The cycle type. Valid values are ‘+’, ‘-’, ‘+-’, ‘-+’.

• max_val (float) – The maximum value for the list.

• min_val (float) – The minimum value for the list.

• step (float) – The step size between consecutive values.

Returns:

The generated list of values, rounded to 5 decimal places.

Return type:

numpy.ndarray

Raises:

ValueError – If the cycle type is invalid.

measurements.template module

class measurements.template.Measurement(logger, config, instrument)

Bases: object

initialize_instrument(logger, instrument)

measure_val(logger, instrument, val)

set_plot_parameters(cycle_type)

Module contents