atomiq.components.sinara.sampler
================================

.. py:module:: atomiq.components.sinara.sampler


Classes
-------

.. autoapisummary::

   atomiq.components.sinara.sampler.Sampler
   atomiq.components.sinara.sampler.SamplerChannel


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

.. py:class:: Sampler(sampler_device, default_gain = [0] * 8, *args, **kwargs)

   Bases: :py:obj:`atomiq.components.electronics.adc.ADC`


   Sinara Sampler 8 Channel ADC

   This class represents the Sinara Sampler with all its 8 channels. It allows to sample all channels at once and to
   read out the result.

   :param sampler_device: The ARTIQ device for the sampler from the `device_db`, e.g. `@sampler0`
   :param default_gain: List with 8 entries setting the default gain for the 8 channels at startup. (default [0, .. , 0])


   .. py:attribute:: kernel_invariants


   .. py:attribute:: _sampler_device


   .. py:attribute:: default_gain
      :value: [0, 0, 0, 0, 0, 0, 0, 0]



   .. py:method:: _prerun()

      Specify here what should be done for this component before the run starts. In contrast to the _build() method,
      the _prerun() routine is executed on the core device before the actual experiment starts.



   .. py:method:: set_gain(channel, gain = 0)


   .. py:method:: _measure(target_arr)

      Measure a single sample on all 8 channels at once.

      This function advances the timeline by 175 us



.. py:class:: SamplerChannel(default_gain = 0, *args, **kwargs)

   Bases: :py:obj:`atomiq.components.electronics.adc.ADCChannel`


   Single ADC Channel of a Sinara Sampler

   This class represents a single channel of a Sinara Sampler as an
   :class:`~atomiq.components.electronics.adc.ADCChannel`.

   :param default_gain: Default gain to set for the Sampler channel at startup. (default 0)


   .. py:method:: set_gain(gain)

      Set the gain for the Sampler Channel

      :param gain: Gain in machine units (0: 1, ..., 3: 1000)