piel.models.frequency
=====================

.. py:module:: piel.models.frequency


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/piel/models/frequency/all/index
   /autoapi/piel/models/frequency/defaults/index
   /autoapi/piel/models/frequency/electrical/index
   /autoapi/piel/models/frequency/electro_optic/index
   /autoapi/piel/models/frequency/electronic/index
   /autoapi/piel/models/frequency/opto_electronic/index
   /autoapi/piel/models/frequency/photonic/index
   /autoapi/piel/models/frequency/utils/index


Functions
---------

.. autoapisummary::

   piel.models.frequency.compose_custom_model_library_from_defaults
   piel.models.frequency.get_all_models
   piel.models.frequency.get_default_models


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

.. py:function:: compose_custom_model_library_from_defaults(custom_models: dict, *args, **kwargs) -> dict

   Compose the default measurement with the custom measurement.

   :param custom_models: Custom measurement dictionary.
   :type custom_models: dict

   :returns: Composed measurement dictionary.
   :rtype: dict


.. py:function:: get_all_models(custom_library: dict | None = None) -> dict

   Returns the default measurement dictionary.

   :param custom_library: Custom defaults dictionary.
   :type custom_library: dict

   :returns: Default measurement dictionary.
   :rtype: dict


.. py:function:: get_default_models(custom_defaults: dict | None = None, type: Literal['classical', 'quantum', 'optical_logic_verification'] = 'classical') -> dict

   Returns the default measurement dictionary.

   :param custom_defaults: Custom defaults dictionary.
   :type custom_defaults: dict
   :param type: Type of default measurement dictionary to return.
   :type type: Literal["default", "quantum"]

   :returns: Default measurement dictionary.
   :rtype: dict