nibcq.EISTestParameters
=======================

.. py:class:: nibcq.EISTestParameters

   Bases: :py:obj:`nibcq.measurement.TestParameters`, :py:obj:`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.

   .. attribute:: 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.

   .. attribute:: nominal_voltage

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

   .. attribute:: 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.

   .. attribute:: 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.

   .. rubric:: 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
   ... )


   .. py:method:: from_json(json_data: Dict[str, Any]) -> EISTestParameters
      :classmethod:


      Create EISTestParameters instance from JSON dictionary.

      :param json_data: Dictionary containing EIS configuration data

      :returns: Instance configured from JSON data
      :rtype: EISTestParameters

      :raises ValueError: If required parameters are missing or invalid
      :raises KeyError: If expected keys are not found in json_data



   .. py:method:: from_file(file_path: str) -> EISTestParameters
      :classmethod:


      Create EISTestParameters instance from JSON configuration file.

      :param file_path: Path to JSON configuration file

      :returns: Instance configured from file
      :rtype: EISTestParameters

      :raises FileNotFoundError: If configuration file is not found
      :raises ValueError: If file content is invalid or required parameters are missing
      :raises json.JSONDecodeError: If file contains invalid JSON