LineBroadeningEOM

Class Arguments

Argument

Type

Default Value

spacing

float

broadening_calibration

Calibration | None

None

freq_limit

tuple | None

None

bandwidth

float | None

None

switching_delay

float

0

amp_limit

tuple

(0.0, 1.0)

soft_amp_limit

tuple

(False, False)

switch

Switchable

None

debug_output

bool

False

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

Inheritance diagram of atomiq.components.optoelectronics.lightmodulator.LineBroadeningEOM

Example Component Dictionary

   {
    "lightmodulator_example": {
        "classname": "atomiq.components.optoelectronics.lightmodulator.LineBroadeningEOM",
        "arguments": {
            "spacing": "<mandatory parameter (float)>",
            "broadening_calibration": null,
            "freq_limit": null,
            "bandwidth": null,
            "switching_delay": 0,
            "amp_limit": [
                0.0,
                1.0
            ],
            "soft_amp_limit": [
                false,
                false
            ],
            "switch": null,
            "debug_output": false
        }
    }
}

Class Description

class atomiq.components.optoelectronics.lightmodulator.LineBroadeningEOM(spacing, broadening_calibration=None, *args, **kwargs)[source]

Bases: EOM

A resonant EOM that is used to broaden the linewidth of a laser

By modulating sidebands onto a laser that are approximately spaced by the linewidth of the optical transition one can effectively create a laser with a broad line.

Parameters:
  • spacing (float) -- frequency spacing of the sidebands modulated onto the laser [Hz]. It is used as the center frequency of the EOM.

  • broadening_calibration (Calibration | None) -- Calibration of RF amplitude vs "width" of broadening (unit: Hz). The measure of broadening may eg. be the FWHM of the envelope of created RF tones. If none is given, the width is interpreted as the RF amplitude directly.

Note

The inherited ramp() and set_amplitude() act on the raw RF frequency and amplitude of the EOM and therefore bypass the broadening calibration. Use ramp_broadening() and set_broadening() to work with the width of the broadening instead.

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

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 (list[float]) -- List of amplitude samples. If this list is empty (default), the amplitude is not modified.

  • samples_freq (list[float]) -- List of frequency samples. If this list is empty (default), the frequency is not modified.

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

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

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

  • prepare_only (bool)

  • run_prepared (bool)

get_amplitude()
Return type:

float

get_amplitude_max()
Return type:

float

get_amplitude_min()
Return type:

float

get_frequency()
Return type:

float

get_frequency_max()
Return type:

float

get_frequency_min()
Return type:

float

get_phase()
Return type:

float

is_on(channel=None)
Parameters:

channel (str)

kernel_invariants = {'center_freq', 'switching_delay'}
off()

Turns off the modulator. The time cursor is moved back in time to accommodate the switching_delay of the modulator. 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.

on()

Turns on the modulator. The time cursor is moved back in time to accommodate the switching_delay of the modulator. 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.

pulse(pulsetime, channel='')
Parameters:
  • pulsetime (float)

  • channel (str)

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

Ramp frequency and/or power/amplitude over a given duration.

Parameters default to -1 or nan to indicate no change. If no starting value is given, the ramp starts from the last frequency/amplitude which was set.

This method advances the timeline by ´duration´

Parameters:
  • duration (float) -- ramp duration [s]

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

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

  • amplitude_start (float) -- initial amplitude

  • amplitude_end (float) -- end amplitude

  • ramp_timestep (float)

  • ramp_steps (int32)

set_amplitude(amplitude)

Set the amplitude of the light after the modulator

Parameters:

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

set_broadening(width=nan, spacing=nan)[source]

Set spacing and/or width of the spectral broadening. Parameters default to nan to indicate no change.

Parameters:
  • width (float) -- width of broadening [Hz]

  • spacing (float) -- line spacing [Hz]

set_frequency(frequency)

Set the frequency by which the light is shifted.

Parameters:

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

set_parameter(value, channel=None)
Parameters:
  • value (float)

  • channel (str)

set_phase(value)

Set the phase shift of the light imposed by the modulator

Parameters:
  • phase -- Phase shift in radians

  • value (float)

set_polarisation(angle)

Set the polarization rotation imposed by the modulator

Parameters:

angle (float) -- Rotation angle in radians

switching_delay: float = 0

Time in s it takes from the arrival of the TTL until the modulator is fully switched

toggle(channel=None)
Parameters:

channel (str)

channels: list[str]
ramp_broadening(duration, spacing_start=nan, spacing_end=nan, width_start=nan, width_end=nan, ramp_timestep=nan, ramp_steps=-1)[source]

Ramp spacing and/or width over a given duration. Parameters default to -1 or nan to indicate no change. If the start frequency/amplitude is set to nan, the ramp starts from the last frequency/amplitude which was set. This method advances the timeline by ´duration´

The ramp is executed by the underlying RF source and is subject to the frequency and amplitude limits of the modulator.

Parameters:
  • duration (float) -- ramp duration [s]

  • spacing_start (float) -- initial line spacing [Hz]

  • spacing_end (float) -- final line spacing [Hz]

  • width_start (float) -- initial width of broadening [Hz]

  • width_end (float) -- final width of broadening [Hz]

  • ramp_timestep (float) -- time between steps in the ramp [s]. This takes precedence over ramp_steps

  • ramp_steps (int32) -- number of steps the whole ramp should have