piel.analysis.signals.dc.transfer.metrics
=========================================

.. py:module:: piel.analysis.signals.dc.transfer.metrics


Functions
---------

.. autoapisummary::

   piel.analysis.signals.dc.transfer.metrics.get_out_min_max
   piel.analysis.signals.dc.transfer.metrics.get_out_response_in_transition_range


Module Contents
---------------

.. py:function:: get_out_min_max(collection: piel.types.SignalDCCollection, lower_threshold_ratio: float = 0.1, upper_threshold_ratio: float = 0.9, **kwargs) -> piel.types.ScalarMetric

   Retrieves the minimum and maximum output voltage values within a specified input voltage range.

   :param collection: The collection of input and output DC signals.
   :type collection: SignalDCCollection
   :param lower_threshold_ratio: The lower threshold as a fraction of V_in range (0-1). Defaults to 0.1.
   :type lower_threshold_ratio: float, optional
   :param upper_threshold_ratio: The upper threshold as a fraction of V_in range (0-1). Defaults to 0.9.
   :type upper_threshold_ratio: float, optional

   :returns: Metrics including min and max values of the output voltage in the specified input voltage range.
   :rtype: ScalarMetric


.. py:function:: get_out_response_in_transition_range(collection: piel.types.SignalDCCollection, lower_threshold_ratio: float = 0.1, upper_threshold_ratio: float = 0.9, transition_type: Literal['analogue', 'digital'] = 'analogue', transition_direction: Literal['positive', 'negative'] = 'positive', **kwargs) -> piel.types.ScalarMetric

   Calculates the equivalent input voltage range (V_in) corresponding to specified thresholds of output voltage (V_out).

   :param collection: The collection of input and output DC signals.
   :type collection: SignalDCCollection
   :param lower_threshold_ratio: The lower threshold as a fraction of V_out's final value (0-1). Defaults to 0.1.
   :type lower_threshold_ratio: float, optional
   :param upper_threshold_ratio: The upper threshold as a fraction of V_out's final value (0-1). Defaults to 0.9.
   :type upper_threshold_ratio: float, optional
   :param transition_type: Type of transition. Defaults to "analogue".
   :type transition_type: Literal["analogue", "digital"], optional
   :param transition_direction: Direction of transition. Defaults to "positive".
   :type transition_direction: Literal["positive", "negative"], optional
   :param \*\*kwargs: Additional keyword arguments.

   :returns: Metrics including min and max V_in values corresponding to the specified V_out threshold range.
   :rtype: ScalarMetric