piel.models.logic.electro_optic
===============================

.. py:module:: piel.models.logic.electro_optic


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/piel/models/logic/electro_optic/signal_map/index


Functions
---------

.. autoapisummary::

   piel.models.logic.electro_optic.linear_bit_phase_map


Package Contents
----------------

.. py:function:: linear_bit_phase_map(bits_amount: int, final_phase_rad: float, initial_phase_rad: float = 0, quantization_error: float = 1e-06, **kwargs) -> piel.types.digital_electro_optic.BitPhaseMap

   Returns a linear direct mapping of bits to phase.

   :param bits_amount: Amount of bits to generate.
   :type bits_amount: int
   :param final_phase_rad: Final phase to map to.
   :type final_phase_rad: float
   :param initial_phase_rad: Initial phase to map to.
   :type initial_phase_rad: float
   :param quantization_error: Error in the phase mapping.
   :type quantization_error: float

   :returns: Mapping of bits to phase.
   :rtype: BitPhaseMap