piel.analysis.signals.dc.utils
==============================

.. py:module:: piel.analysis.signals.dc.utils


Attributes
----------

.. autoapisummary::

   piel.analysis.signals.dc.utils.logger


Functions
---------

.. autoapisummary::

   piel.analysis.signals.dc.utils.get_trace_values_by_datum
   piel.analysis.signals.dc.utils.get_trace_values_by_unit


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

.. py:data:: logger

.. py:function:: get_trace_values_by_datum(signal_dc: piel.types.SignalDC, desired_datum: str) -> Optional[numpy.ndarray]

   Retrieves the values of a trace from a SignalDC instance based on the unit's datum.

   :param signal_dc: The SignalDC instance containing the traces.
   :type signal_dc: SignalDC
   :param desired_datum: The datum type to filter traces (e.g., 'voltage', 'ampere') See unit definitions.
   :type desired_datum: str

   :returns: The numpy array of trace values if found, else None.
   :rtype: Optional[np.ndarray]


.. py:function:: get_trace_values_by_unit(signal_dc: piel.types.SignalDC, desired_unit: piel.types.Unit) -> Optional[numpy.ndarray]

   Retrieves the values of a trace from a SignalDC instance based on the exact unit.

   :param signal_dc: The SignalDC instance containing the traces.
   :type signal_dc: SignalDC
   :param desired_unit: The Unit instance to filter traces.
   :type desired_unit: Unit

   :returns: The numpy array of trace values if found, else None.
   :rtype: Optional[np.ndarray]