nibcq.ACIRTestParameters
========================

.. py:class:: nibcq.ACIRTestParameters

   Bases: :py:obj:`nibcq.measurement.TestParameters`, :py:obj:`nibcq.measurement.ConfigFileSupport`


   Configuration parameters for Alternating Current Internal Resistance (ACIR) measurements.

   This class extends the base TestParameters to provide ACIR-specific configuration
   options for single-frequency AC impedance measurements. ACIR measurements characterize
   the complex impedance of a Device Under Test (DUT) at a specific frequency using
   sinusoidal current excitation and voltage measurement.

   These parameters control the measurement conditions including voltage limits for
   safety, signal amplitude for signal-to-noise ratio optimization, measurement
   duration for accuracy, and error compensation methods for systematic error correction.

   .. attribute:: nominal_voltage

      Expected DUT voltage level in Volts for measurement range optimization.
      Default 4.0V is typical for battery cells and electrochemical systems.

      :type: float

   .. attribute:: voltage_limit_hi

      Upper voltage limit in Volts for DUT protection. Default 5.0V
      provides safety margin for most applications.

      :type: float

   .. attribute:: current_amplitude

      AC current amplitude in Amperes for excitation signal.
      Default 1.0A provides good signal levels but may need adjustment
      based on DUT characteristics and desired measurement conditions.

      :type: float

   .. attribute:: number_of_periods

      Number of complete AC cycles to measure for averaging and
      noise reduction. Default 20 periods provides good balance
      between accuracy and measurement speed.

      :type: int

   .. attribute:: compensation_method

      Error correction method from CompensationMethod enum.
      Options include NO_COMPENSATION, SHORT, GOLDEN_DUT, or
      SHORT_GOLDEN_DUT for systematic error correction.

      :type: CompensationMethod

   .. rubric:: Example

   >>> params = ACIRTestParameters(
   ...     nominal_voltage=3.7,
   ...     voltage_limit_hi=4.2,
   ...     current_amplitude=0.1,
   ...     number_of_periods=50,
   ...     compensation_method=CompensationMethod.SHORT
   ... )


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


      Create ACIRTestParameters instance from JSON dictionary.

      :param json_data: Dictionary containing ACIR configuration data.
      :type json_data: Dict[str, Any]

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

      :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) -> ACIRTestParameters
      :classmethod:


      Create ACIRTestParameters instance from JSON configuration file.

      :param file_path: Path to JSON configuration file
      :type file_path: str

      :returns: Instance configured from file
      :rtype: ACIRTestParameters

      :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