atomiq.components.optoelectronics.lightmodulator module

class atomiq.components.optoelectronics.lightmodulator.Shutter(switch, invert=False, opening_time=0, closing_time=0, *args, **kwargs)

Bases: Component, Switchable

Component to switch light on or off depending on a logical signal. This could be a mechanical shutter or a binary only amplitude modulator (e.g. AOM, EOM, Pockels cell etc.). It requires a class:Switchable switch that operates the shutter

Parameters:

• switch (Switchable) -- Switch that operates the shutter, e.g. TTL

• invert (TBool) -- invert the logic of on and off

• opening_time (TFloat) -- Time in s it takes from the arrival of the TTL until the shutter is fully opened (default 0)

• closing_time (TFloat) -- Time in s it takes from the arrival of the TTL until the shutter is completely closed (default 0). Note that if closing_time is > 0 the shutter is already closing before the time at which the off() method is called

A Switchable has one ore more channel(s) that can be switched on or off

kernel_invariants = {'invert', 'switch'}

on()

Opens the shutter. The time cursor is moved back in time to accommodate the opening_time of the shutter. After executing the on (or off if inverted) method of the defined switch the time cursor is then forwarded by opening_time again. The time cursor advancement is therefore given by the switch.on() or switch.off() method.

off()

Closes the shutter. The time cursor is moved back in time to accommodate the closing_time of the shutter. After executing the off (or on if inverted) method of the defined switch the time cursor is then forwarded by closing_time again. The time cursor advancement is therefore given by the switch.on() or switch.off() method.

class atomiq.components.optoelectronics.lightmodulator.LightModulator(*args, **kwargs)

Bases: Component, Parametrizable

An abstract light modulator for frequency, amplitude, phase, polarisation

This class serves as a base class for all kinds of electro-optic devices that can change the properties of light.

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

set_frequency(frequency)

Set the frequency by which the light is shifted.

Parameters:

frequency (artiq.compiler.types.TMono('float', OrderedDict())) -- Frequency in Hz by which the light is shifted.

get_frequency()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

set_amplitude(amplitude)

Set the amplitude of the light after the modulator

Parameters:

amplitude (artiq.compiler.types.TMono('float', OrderedDict())) -- Relative amplitude [0 .. 1] of the light after the modulator

set_phase(phase)

Set the phase shift of the light imposed by the modulator

Parameters:

phase (artiq.compiler.types.TMono('float', OrderedDict())) -- Phase shift in radians

set_polarisation(angle)

Set the polarization rotation imposed by the modulator

Parameters:

angle (artiq.compiler.types.TMono('float', OrderedDict())) -- Rotation angle in radians

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)

kernel_invariants = {'amp_max', 'amp_min', 'freq_max', 'freq_min', 'rfsource'}

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 (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]

• frequency_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial frequency [Hz]

• frequency_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end frequency [Hz]

• amplitude_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial amplitude [Hz]

• amplitude_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end amplitude [Hz]

• ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))

• ramp_steps (artiq.compiler.types.TMono('int', OrderedDict([('width', artiq.compiler.types.TValue(32))])))

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 output 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 actually 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 (artiq.compiler.types.TMono('list', OrderedDict([('elt', artiq.compiler.types.TMono('float', OrderedDict()))]))) -- List of amplitude samples. If this list is empty (default), the amplitude is not modified.

• samples_freq (artiq.compiler.types.TMono('list', OrderedDict([('elt', artiq.compiler.types.TMono('float', OrderedDict()))]))) -- List of frequency samples. If this list is empty (default), the frequency is not modified.

• samples_phase (artiq.compiler.types.TMono('list', OrderedDict([('elt', artiq.compiler.types.TMono('float', OrderedDict()))]))) -- List of phase samples. If this list is empty (default), the phase is not modified.

• duration (artiq.compiler.types.TMono('float', OrderedDict())) -- The time in which the whole sequence of samples should be played back [s].

• repetitions (artiq.compiler.types.TMono('int', OrderedDict([('width', artiq.compiler.types.TValue(32))]))) -- Number of times the sequence of all samples should be played. (default 1)

• prepare_only (artiq.compiler.types.TMono('bool', OrderedDict()))

• run_prepared (artiq.compiler.types.TMono('bool', OrderedDict()))

get_frequency_min()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_frequency_max()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_frequency()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

set_frequency(frequency)

Set the frequency by which the light is shifted.

Parameters:

frequency (artiq.compiler.types.TMono('float', OrderedDict())) -- Frequency in Hz by which the light is shifted.

get_amplitude_min()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_amplitude_max()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_amplitude()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

set_amplitude(amplitude)

Set the amplitude of the light after the modulator

Parameters:

amplitude (artiq.compiler.types.TMono('float', OrderedDict())) -- Relative amplitude [0 .. 1] of the light after the modulator

get_phase()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

set_phase(value)

Set the phase shift of the light imposed by the modulator

Parameters:

• phase -- Phase shift in radians

• value (artiq.compiler.types.TMono('float', OrderedDict()))

on()

off()

set_polarisation(angle)

Set the polarization rotation imposed by the modulator

Parameters:

angle (artiq.compiler.types.TMono('float', OrderedDict())) -- Rotation angle in radians

class atomiq.components.optoelectronics.lightmodulator.AOM(center_freq, freq_limit=None, bandwidth=None, switch=None, switching_delay=0, passes=1, order=1, am_calibration=None, *args, **kwargs)

Bases: RFLightModulator, Switchable

An acousto-optical modulator to alter amplitude, frequency and phase of the light.

A component to represent an AOM to attenuate, switch and frequency-shift light. It is controlled by an RFSource and a Switchable to rapidly switch the light on and off. As such, the AOM works also as a (non-perfect) shutter.

Parameters:

• rfsource -- The rf source that drives the AOM

• center_freq (TFloat) -- RF center frequency of the AOM in Hz.

• freq_limit (tuple) -- Tuple (freq_min, freq_max) giving the minimum/maximum RF frequency that the AOM can handle in Hz. Either freq_limit xor bandwidth must be given

• bandwidth (TFloat) -- RF bandwidth of the AOM around the center frequency in Hz. Either bandwidth xor freq_limit must be given.

• switch (Switchable) -- An optional switch to rapidly switch on and off the AOM. If none is given the rfsource is used to switch.

• switching_delay (TFloat) -- the switching delay of the AOM, i.e. the time it takes from the arrival of the TTL to having full optical power. (default 0)

• passes (TInt32) -- How often does the beam pass the AOM? Singlepass -> 1, Doublepass -> 2 (default 1)

• order (TInt32) -- The diffraction order the AOM is aligned to. -2, -1, 1, 2 ... (default 1)

• am_calibration (Calibration) -- Calibration of RF power vs output power. Typically an inverse sigmoid. (default none)

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

kernel_invariants = {'center_freq', 'order', 'passes', 'switching_delay'}

get_frequency_min()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_frequency_max()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_frequency()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

set_frequency(frequency)

Set the frequency shift of the light coming out of the AOM

Parameters:

frequency (artiq.compiler.types.TMono('float', OrderedDict()))

set_detuning(detuning)

Set the frequency shift of the light coming out of the AOM relative to the center frequency

Parameters:

detuning (artiq.compiler.types.TMono('float', OrderedDict())) -- Detuning from the AOM center frequency in Hz

detune(detuning)

Alias for set_detuning()

Parameters:

detuning (artiq.compiler.types.TMono('float', OrderedDict()))

set_amplitude(amplitude)

Set the amplitude of the light after the modulator

Parameters:

amplitude (artiq.compiler.types.TMono('float', OrderedDict())) -- Relative amplitude [0 .. 1] of the light after the modulator

arb(duration, samples_amp=[], samples_freq=[], samples_det=[], 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 output 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 actually 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 (artiq.compiler.types.TMono('list', OrderedDict([('elt', artiq.compiler.types.TMono('float', OrderedDict()))]))) -- List of amplitude samples. If this list is empty (default), the amplitude is not modified.

• samples_freq (artiq.compiler.types.TMono('list', OrderedDict([('elt', artiq.compiler.types.TMono('float', OrderedDict()))]))) -- List of frequency samples. If this list is empty (default), the frequency is not modified.

• samples_det (artiq.compiler.types.TMono('list', OrderedDict([('elt', artiq.compiler.types.TMono('float', OrderedDict()))]))) -- List of frequency samples relative to the center frequency. If this list is empty (default), the frequency is not modified. This overwrites samples_frequency

• samples_phase (artiq.compiler.types.TMono('list', OrderedDict([('elt', artiq.compiler.types.TMono('float', OrderedDict()))]))) -- List of phase samples. If this list is empty (default), the phase is not modified.

• duration (artiq.compiler.types.TMono('float', OrderedDict())) -- The time in which the whole sequence of samples should be played back [s].

• repetitions (artiq.compiler.types.TMono('int', OrderedDict([('width', artiq.compiler.types.TValue(32))]))) -- Number of times the sequence of all samples should be played. (default 1)

• prepare_only (artiq.compiler.types.TMono('bool', OrderedDict()))

• run_prepared (artiq.compiler.types.TMono('bool', OrderedDict()))

get_amplitude()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_amplitude_max()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_amplitude_min()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_phase()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

on()

Turns on the AOM. The time cursor is moved back in time to accommodate the switching_delay of the AOM. After executing the on method of the defined switch the time cursor is then forwarded by switching_delay again. The time cursor advancement is therefore given by the switch.on() method.

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 (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]

• frequency_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial frequency [Hz]

• frequency_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end frequency [Hz]

• amplitude_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial amplitude [Hz]

• amplitude_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end amplitude [Hz]

• ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))

• ramp_steps (artiq.compiler.types.TMono('int', OrderedDict([('width', artiq.compiler.types.TValue(32))])))

set_phase(value)

Set the phase shift of the light imposed by the modulator

Parameters:

• phase -- Phase shift in radians

• value (artiq.compiler.types.TMono('float', OrderedDict()))

set_polarisation(angle)

Set the polarization rotation imposed by the modulator

Parameters:

angle (artiq.compiler.types.TMono('float', OrderedDict())) -- Rotation angle in radians

off()

Turns off the AOM. The time cursor is moved back in time to accommodate the switching_delay of the AOM. After executing the off method of the defined switch the time cursor is then forwarded by switching_delay again. The time cursor advancement is therefore given by the switch.off() method.