nibcq.EISTestParameters

class nibcq.EISTestParameters

Bases: nibcq.measurement.TestParameters, nibcq.measurement.ConfigFileSupport

Configuration parameters for Electrochemical Impedance Spectroscopy (EIS) measurements.

This class extends the base TestParameters to provide EIS-specific configuration options. EIS measurements involve frequency sweeps across multiple frequency points, requiring comprehensive parameter specification for voltage limits, signal characteristics, and error compensation methods.

EIS measurements are typically more complex than single-frequency ACIR measurements as they characterize the frequency-dependent behavior of electrochemical systems. Proper parameter configuration ensures accurate impedance characterization across the entire frequency spectrum of interest.

voltage_limit_hi

Upper voltage limit in Volts for DUT protection during the entire frequency sweep. Default 5.0V provides safety for most electrochemical cells.

nominal_voltage

Expected DUT voltage level in Volts, used for measurement range optimization. Default 4.0V is typical for battery cells.

compensation_method

Error correction method applied to all frequency points. Options include NO_COMPENSATION, SHORT, GOLDEN_DUT, or SHORT_GOLDEN_DUT for systematic error correction.

frequency_sweep_characteristics

Dictionary mapping each frequency (Hz) to its corresponding FrequencySet containing current amplitude and number of periods. This defines the complete EIS measurement protocol.

Example

>>> sweep_config = {
...     1000.0: FrequencySet(current_amplitude=0.1, number_of_periods=20),
...     100.0: FrequencySet(current_amplitude=0.1, number_of_periods=50)
... }
>>> params = EISTestParameters(
...     voltage_limit_hi=6.0,
...     nominal_voltage=3.7,
...     compensation_method=CompensationMethod.SHORT,
...     frequency_sweep_characteristics=sweep_config
... )
classmethod from_json(json_data: Dict[str, Any]) → EISTestParameters

Create EISTestParameters instance from JSON dictionary.

Parameters:

json_data (Dict[str, Any]) – Dictionary containing EIS configuration data

Returns:

Instance configured from JSON data

Return type:

EISTestParameters

Raises:

  • ValueError – If required parameters are missing or invalid

  • KeyError – If expected keys are not found in json_data

classmethod from_file(file_path: str) → EISTestParameters

Create EISTestParameters instance from JSON configuration file.

Parameters:

file_path (str) – Path to JSON configuration file

Returns:

Instance configured from file

Return type:

EISTestParameters

Raises: