herostools.flow.dummy
=====================

.. py:module:: herostools.flow.dummy


Classes
-------

.. autoapisummary::

   herostools.flow.dummy.Logger
   herostools.flow.dummy.AddConstant
   herostools.flow.dummy.Sqrt
   herostools.flow.dummy.ToPower


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

.. py:class:: Logger(inputs: collections.abc.Mapping[str, heros.HERORef | str] | collections.abc.Sequence[heros.HERORef | str] | None = None, identifier_key: str = 'identifier', subscriber: herostools.flow._subscriber.FlowSubscriber | None = None, queue_warn_threshold: int = 100)

   Bases: :py:obj:`herostools.flow.Node`


   Log incoming flow data and forward it unchanged.

   Every message is logged at INFO on purpose, since showing the data is the point of this node.


   .. py:method:: _process(inputs: dict[str, Any], metadata: dict) -> tuple[Any, dict]

      Log and return incoming data.

      :param inputs: Input data keyed by input name.
      :param metadata: Input metadata.

      :returns: The single input value and empty metadata.



.. py:class:: AddConstant(constant: float = 5, **kwargs)

   Bases: :py:obj:`herostools.flow.Node`


   Add a constant value to incoming flow data.


   .. py:attribute:: constant
      :type:  float


   .. py:method:: _process(inputs: dict[str, Any], metadata: dict) -> tuple[Any, dict]

      Add the configured constant to incoming data.

      :param inputs: Input data keyed by input name.
      :param metadata: Input metadata.

      :returns: Transformed data and empty metadata.



.. py:class:: Sqrt(inputs: collections.abc.Mapping[str, heros.HERORef | str] | collections.abc.Sequence[heros.HERORef | str] | None = None, identifier_key: str = 'identifier', subscriber: herostools.flow._subscriber.FlowSubscriber | None = None, queue_warn_threshold: int = 100)

   Bases: :py:obj:`herostools.flow.Node`


   Apply the square root to incoming flow data.


   .. py:method:: _process(inputs: dict[str, Any], metadata: dict) -> tuple[Any, dict]

      Calculate the square root of incoming data.

      :param inputs: Input data keyed by input name.
      :param metadata: Input metadata.

      :returns: Transformed data and empty metadata.



.. py:class:: ToPower(exponent: float = 2, **kwargs)

   Bases: :py:obj:`herostools.flow.Node`


   Raise incoming flow data to a configured exponent.


   .. py:attribute:: exponent
      :type:  float


   .. py:method:: _process(inputs: dict[str, Any], metadata: dict) -> tuple[Any, dict]

      Raise incoming data to the configured exponent.

      :param inputs: Input data keyed by input name.
      :param metadata: Input metadata.

      :returns: Transformed data and empty metadata.