piel.base.signal.frequency.transmission
=======================================

.. py:module:: piel.base.signal.frequency.transmission


Functions
---------

.. autoapisummary::

   piel.base.signal.frequency.transmission.get_phasor_length
   piel.base.signal.frequency.transmission.offset_path_transmission
   piel.base.signal.frequency.transmission.offset_network_transmission_input_magnitude
   piel.base.signal.frequency.transmission.offset_network_transmission_path_magnitude


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

.. py:function:: get_phasor_length(phasor: Union[int, float, List[float], numpy.ndarray]) -> int

.. py:function:: offset_path_transmission(path_transmission, offset: float)

   Creates a new PathTransmission with the magnitude of the Phasor at the specified
   index offset by a given value.

   :param path_transmission: The original PathTransmission instance.
   :type path_transmission: PathTransmission
   :param index: The index of the Phasor in the transmission list to apply the offset.
   :type index: int
   :param offset: The value to offset the magnitude by.
   :type offset: float

   :returns: A new PathTransmission instance with the offset applied.
   :rtype: PathTransmission


.. py:function:: offset_network_transmission_input_magnitude(network_transmission, offset: float)

   Creates a new NetworkTransmission with the magnitude of the specified Phasor offset by a given value.

   :param network_transmission: The original NetworkTransmission instance.
   :type network_transmission: NetworkTransmission
   :param offset: The value to offset the magnitude by.
   :type offset: float

   :returns: A new NetworkTransmission instance with the offset applied.
   :rtype: NetworkTransmission


.. py:function:: offset_network_transmission_path_magnitude(network_transmission, path_index: int, offset: float)

   Creates a new NetworkTransmission with the magnitude of the specified Phasor offset by a given value.

   :param network_transmission: The original NetworkTransmission instance.
   :type network_transmission: NetworkTransmission
   :param path_index: The index of the PathTransmission in the network list.
   :type path_index: int
   :param offset: The value to offset the magnitude by.
   :type offset: float

   :returns: A new NetworkTransmission instance with the offset applied.
   :rtype: NetworkTransmission