EOM

Class Arguments

Argument

Type

Default Value

center_freq

float

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.EOM

Example Component Dictionary

   {
    "lightmodulator_example": {
        "classname": "atomiq.components.optoelectronics.lightmodulator.EOM",
        "arguments": {
            "center_freq": "<mandatory parameter (float)>",
            "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.EOM(center_freq, freq_limit=None, bandwidth=None, switching_delay=0, *args, **kwargs)[source]

Bases: RFLightModulator

An electro-optic modulator

Driven by an RF source, these devices are typically used to modulate sidebands onto a laser. Note that for describing EOMs in a cavity laser lock, you should use atomiq.components.lock.SidebandLock

Parameters:
  • center_freq (float) -- Center frequency of the EOM in Hz. Especially relevant if it is a resonant EOM. Otherwise this can be understood as a default value.

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

  • bandwidth (float | None) -- RF bandwidth of the EOM around the center frequency in Hz. Either bandwidth xor freq_limit must be given.

  • switch -- An optional switch to rapidly switch on and off the EOM. If none is given the rfsource is used to switch.

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

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

kernel_invariants = {'center_freq', 'switching_delay'}
switching_delay: float = 0

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

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)

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_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

toggle(channel=None)
Parameters:

channel (str)

channels: list[str]