piel.analysis.signals.dc.transfer.power
=======================================

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


Attributes
----------

.. autoapisummary::

   piel.analysis.signals.dc.transfer.power.logger


Functions
---------

.. autoapisummary::

   piel.analysis.signals.dc.transfer.power.calculate_power_signal_from_collection
   piel.analysis.signals.dc.transfer.power.get_power_metrics
   piel.analysis.signals.dc.transfer.power.get_power_map_vin_metrics


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

.. py:data:: logger

.. py:function:: calculate_power_signal_from_collection(collection: piel.types.SignalDCCollection, lower_threshold_ratio: float = 0, upper_threshold_ratio: float = 1, **kwargs) -> piel.types.ScalarMetric

   Retrieves the minimum and maximum power values within a specified input voltage range,
   along with the corresponding V_in values where these extrema occur.

   :param collection: The collection of input, output, and power 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:

             ScalarMetric
                 - ScalarMetric containing min and max power.


.. py:function:: get_power_metrics(collection: piel.types.SignalDCCollection, lower_threshold_ratio: float = 0, upper_threshold_ratio: float = 1, **kwargs) -> piel.types.ScalarMetric

   Retrieves the minimum and maximum power values within a specified input voltage range,
   along with the corresponding V_in values where these extrema occur.

   :param collection: The collection of input, output, and power 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:

             ScalarMetric
                 - ScalarMetric containing min and max power.


.. py:function:: get_power_map_vin_metrics(collection: piel.types.SignalDCCollection, lower_threshold_ratio: float = 0, upper_threshold_ratio: float = 1, **kwargs) -> piel.types.ScalarMetric

   Retrieves the mapped V_IN minimum and maximum power values within a specified input voltage range. Represents
   along with the corresponding V_in values where these power extrema occur.

   :param collection: The collection of input, output, and power 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:

             ScalarMetric
                 - ScalarMetric containing min and max power.