RFLightModulator

Class Arguments

Argument	Type	Default Value
rfsource	RFSource
freq_limit	tuple
amp_limit	tuple	(0.0, 1.0)

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Example Component Dictionary

   {
    "lightmodulator_example": {
        "classname": "atomiq.components.optoelectronics.lightmodulator.RFLightModulator",
        "arguments": {
            "rfsource": "<mandatory parameter (RFSource)>",
            "freq_limit": "<mandatory parameter (tuple)>",
            "amp_limit": [
                0.0,
                1.0
            ]
        }
    }
}

Class Description

class atomiq.components.optoelectronics.lightmodulator.RFLightModulator(rfsource, freq_limit, amp_limit=(0.0, 1.0), *args, **kwargs)

Bases: LightModulator

A light modulator driven by an RF source

This class serves as a base class for devices like AOM, EOM, etc.

Parameters:

• rfsource (RFSource) -- The rfsource that drives the modulator

• freq_limit (tuple) -- Tuple (freq_min, freq_max) giving the minimum/maximum RF frequency that the modulator can handle in Hz.

• amp_limit (tuple) -- Tuple (amp_min, amp_max) giving the minimum/maximum RF attenuation that the modulator can do in range [0..1].

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

ramp(duration, frequency_start=- 1.0, frequency_end=- 1.0, amplitude_start=- 1.0, amplitude_end=- 1.0, ramp_timestep=- 1.0, ramp_steps=- 1)

Ramp frequency and amplitude over a given duration.

Parameters default to -1 to indicate no change. If the start frequency/amplitude is set to -1, the ramp starts from the last frequency/amplitude which was set. This method advances the timeline by ´duration´

Parameters:

• duration (TFloat) -- ramp duration [s]

• frequency_start (TFloat) -- initial frequency [Hz]

• frequency_end (TFloat) -- end frequency [Hz]

• amplitude_start (TFloat) -- initial amplitude [Hz]

• amplitude_end (TFloat) -- end amplitude [Hz]

• ramp_timestep (TFloat) --

• ramp_steps (TInt32) --

arb(duration, samples_amp=[], samples_freq=[], samples_phase=[], repetitions=1, prepare_only=False, run_prepared=False, transform_amp=<function identity_float>, transform_freq=<function identity_float>, transform_phase=<function identity_float>)

Play Arbitrary Samples from a List

This method allows to set the ouput amplitude, frequency an phase according to the values specified in respective lists. The whole sequence is played in the specified duration. The pattern store in the sample list can also be repeated.

We supports a scheme to prepare the arb function before it is acutally used. If that is needed, run this function with prepapre_only = True when the arb should be prepared and with run_only = True when the prepared arb should be played. In both calls the other parameters have to be passed.

Parameters:

• samples_amp (TList(TFloat)) -- List of amplitude samples. If this list is empty (default), the amplitude is not modified.

• samples_freq (TList(TFloat)) -- List of frequency samples. If this list is empty (default), the frequecy is not modified.

• samples_phase (TList(TFloat)) -- List of phase samples. If this list is empty (default), the phase is not modified.

• duration (TFloat) -- The time in which the whole sequence of samples should be played back [s].

• repetitions (TInt32) -- Number of times the sequence of all samples should be played. (default 1)

• prepare_only (TBool) --

• run_prepared (TBool) --

set_frequency(frequency)

Set the frequency by which the light is shifted.

Parameters:

frequency (TFloat) -- Frequency in Hz by which the light is shifted.

set_amplitude(amplitude)

Set the amplitude of the light after the modulator

Parameters:

amplitude (TFloat) -- Relative amplitude [0 .. 1] of the light after the modulator

set_phase(value)

Set the phase shift of the light imposed by the modulator

Parameters:

• phase -- Phase shift in radians

• value (TFloat) --

set_polarisation(angle)

Set the polarization rotation imposed by the modulator

Parameters:

angle (TFloat) -- Rotation angle in radians