atomiq.components.electronics.rfsource module

An RFSource has the properties frequency, amplitude and phase these can either be set or ramped linearly.

class atomiq.components.electronics.rfsource.RFSource(default_frequency=100000000.0, default_amplitude=0.0, default_phase=0.0, freq_limit=(0.0, inf), amp_limit=(0.0, 1.0), blind=False, default_ramp_steps=30, *args, **kwargs)

Bases: Component, Parametrizable

Abstract class to represent an RF source. Typical examples of components inheriting this class could be a DDS, a standalone AOM driver, an AWG etc.

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

Parameters:

• default_frequency (TFloat)

• default_amplitude (TFloat)

• default_phase (TFloat)

• freq_limit (tuple)

• amp_limit (tuple)

• blind (TBool)

• default_ramp_steps (TInt32)

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

set_frequency(frequency)

get_frequency()

Return type:

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

set_amplitude(amplitude)

get_amplitude()

Return type:

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

set_phase(phase)

get_phase()

Return type:

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

set(frequency=-1.0, amplitude=-1.0, phase=0.0)

Set the frequency and amplitude. Frequency/amplitude are set to the last known value if -1 is given.

Parameters:

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

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

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

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 [0..1]

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

• ramp_timesteps -- time between steps in the ramp [s]

• ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)}))) -- number of steps the whole ramp should have. This takes precedence over ramp_timesteps

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

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()))

class atomiq.components.electronics.rfsource.RPCRFSource(rpc_rfsource, *args, **kwargs)

Bases: RFSource

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

Parameters:

rpc_rfsource (Component)

kernel_invariants = {'rfsource'}

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_amplitude()

Return type:

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

get_frequency()

Return type:

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

get_phase()

Return type:

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

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 [0..1]

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

• ramp_timesteps -- time between steps in the ramp [s]

• ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)}))) -- number of steps the whole ramp should have. This takes precedence over ramp_timesteps

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

set(frequency=-1.0, amplitude=-1.0, phase=0.0)

Set the frequency and amplitude. Frequency/amplitude are set to the last known value if -1 is given.

Parameters:

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

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

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

set_amplitude(amplitude)

set_frequency(frequency)

set_phase(phase)

class atomiq.components.electronics.rfsource.VoltageControlledRFSource(freq_voltage_source=None, freq_calibration=None, amp_voltage_source=None, amp_calibration=None, *args, **kwargs)

Bases: RFSource

An RF source controlled by an analog voltage

A frequent use case for this class are AOM drivers whose frequency and amplitude can be controlled via analog voltages.

Parameters:

• freq_voltage_source (VoltageSource) -- Voltage source that controls the frequency of the rf source

• amp_voltage_source (VoltageSource) -- Voltage source that controls amplitude of the rf source

• freq_calibration (Calibration) -- Calibration U = f(freq) to give the control voltage U for a desired frequency in Hz

• amp_calibration (Calibration) -- Calibration U = f(amp) to give the control voltage U for a desired amplitude in full scale [0..1]

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

kernel_invariants = {'amp_calibration', 'amp_voltage_source', 'freq_calibration', 'freq_voltage_source'}

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_amplitude()

Return type:

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

get_frequency()

Return type:

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

get_phase()

Return type:

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

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 [0..1]

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

• ramp_timesteps -- time between steps in the ramp [s]

• ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)}))) -- number of steps the whole ramp should have. This takes precedence over ramp_timesteps

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

set(frequency=-1.0, amplitude=-1.0, phase=0.0)

Set the frequency and amplitude. Frequency/amplitude are set to the last known value if -1 is given.

Parameters:

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

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

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

set_amplitude(amplitude)

set_frequency(frequency)

set_phase(phase)

ramp_frequency(duration, frequency_start, frequency_end, ramp_timestep=-1.0, ramp_steps=-1)

Ramp only the frequency of the RF source

This function can possibly ramp the RF source faster than the generic ramp() method if the connected DAC can do fast ramps.

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]

• ramp_timesteps -- time between steps in the ramp [s]

• ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)}))) -- number of steps the whole ramp should have. This takes precedence over ramp_timesteps

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

ramp_amplitude(duration, amplitude_start, amplitude_end, ramp_timestep=-1.0, ramp_steps=-1)

Ramp only the amplitude of the RF source

This function can possibly ramp the RF source faster than the generic ramp() method if the connected DAC can do fast ramps.

Parameters:

• duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]

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

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

• ramp_timesteps -- time between steps in the ramp [s]

• ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)}))) -- number of steps the whole ramp should have. This takes precedence over ramp_timesteps

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