atomiq.components.optoelectronics.wavelengthmeter
=================================================

.. py:module:: atomiq.components.optoelectronics.wavelengthmeter

.. autoapi-nested-parse::

   Abstract implementations of a wavelength meter to be used with HEROS wavelengthmeters or other remote devices.



Classes
-------

.. autoapisummary::

   atomiq.components.optoelectronics.wavelengthmeter.WavelengthMeterChannel
   atomiq.components.optoelectronics.wavelengthmeter.StabilizingWavelengthMeterChannel


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

.. py:class:: WavelengthMeterChannel(*args, **kwargs)

   Bases: :py:obj:`atomiq.components.primitives.Component`, :py:obj:`atomiq.components.primitives.Measurable`


   An atomiq Component

   Every component in atomiq inherits from this class. It provides basic functionality for automatic and recursive
   building and initialization of components (prepare, build, prerun). It also takes care for joining kernel
   invariants along the inheritance tree.

   .. Note::
      The arguments `parent` and `identifier` are automatically passed to the component object by the atomiq object
      builder.

   :param parent: The parent context of the component. Usually this is the experiment that uses the component
   :param identifier: A unique name to identify the component.
   :param debug_output: Set whether the component should show debug output. Using this switch rather than the debug
                        kernel logger can allow the compiler to not include the debug commands in the kernel code if the
                        output is not needed.


   .. py:method:: get_wavelength()

      Return the wavelength in meters.



   .. py:method:: get_frequency()

      Return the light frequency (vacuum) in Hz.



   .. py:method:: _measure()
      :abstractmethod:



   .. py:attribute:: experiment


   .. py:attribute:: identifier


   .. py:attribute:: debug_output
      :value: False



   .. py:attribute:: core


   .. py:attribute:: _kernel_invariants


   .. py:attribute:: _prepare_done
      :value: False



   .. py:attribute:: _build_done
      :value: False



   .. py:attribute:: _hooks_done
      :value: []



   .. py:attribute:: children
      :value: []



   .. py:attribute:: __in_build
      :value: True



   .. py:attribute:: channels
      :type:  list[str]


   .. py:method:: measure(channel = '')
      :abstractmethod:



   .. py:method:: measurement_channels()


.. py:class:: StabilizingWavelengthMeterChannel(default_frequency, frequency_min, frequency_max, *args, **kwargs)

   Bases: :py:obj:`WavelengthMeterChannel`, :py:obj:`atomiq.components.primitives.Parametrizable`


   An atomiq Component

   Every component in atomiq inherits from this class. It provides basic functionality for automatic and recursive
   building and initialization of components (prepare, build, prerun). It also takes care for joining kernel
   invariants along the inheritance tree.

   .. Note::
      The arguments `parent` and `identifier` are automatically passed to the component object by the atomiq object
      builder.

   :param parent: The parent context of the component. Usually this is the experiment that uses the component
   :param identifier: A unique name to identify the component.
   :param debug_output: Set whether the component should show debug output. Using this switch rather than the debug
                        kernel logger can allow the compiler to not include the debug commands in the kernel code if the
                        output is not needed.


   .. py:attribute:: kernel_invariants


   .. py:attribute:: default_frequency


   .. py:attribute:: frequency_min


   .. py:attribute:: frequency_max


   .. py:method:: _measure()
      :abstractmethod:



   .. py:method:: set_frequency(frequency)
      :abstractmethod:


      Set the frequency of the attached laser.

      Should check the requested frequency against ``frequency_min`` and ``frequency_max``.



   .. py:method:: set_wavelength(wavelength)
      :abstractmethod:


      Set the wavelength of the attached laser.

      Should check the requested wavelength against ``frequency_min`` and ``frequency_max``.



   .. py:method:: get_wavelength()

      Return the wavelength in meters.



   .. py:method:: get_frequency()

      Return the light frequency (vacuum) in Hz.



   .. py:attribute:: experiment


   .. py:attribute:: identifier


   .. py:attribute:: debug_output
      :value: False



   .. py:attribute:: core


   .. py:attribute:: _kernel_invariants


   .. py:attribute:: _prepare_done
      :value: False



   .. py:attribute:: _build_done
      :value: False



   .. py:attribute:: _hooks_done
      :value: []



   .. py:attribute:: children
      :value: []



   .. py:attribute:: __in_build
      :value: True



   .. py:attribute:: channels
      :type:  list[str]


   .. py:method:: measure(channel = '')
      :abstractmethod:



   .. py:method:: measurement_channels()


   .. py:method:: set_parameter(value, channel = None)