OffsetLock

Class Arguments

Argument	Type	Default Value
reference_laser
sideband_order	np.int32	1
settle_time	float	0
blind	bool	False
lock_offset	float	0.0
harmonic	np.int32	1
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

Example Component Dictionary

   {
    "lock_example": {
        "classname": "atomiq.components.lock.OffsetLock",
        "arguments": {
            "reference_laser": "<mandatory parameter ()>",
            "sideband_order": 1,
            "settle_time": 0,
            "blind": false,
            "lock_offset": 0.0,
            "harmonic": 1,
            "debug_output": false
        }
    }
}

Class Description

class atomiq.components.lock.OffsetLock(reference_laser, *args, **kwargs)

Bases: SidebandLock

Lock on a reference laser via beating signal

Parameters:

reference_laser -- laser that is used to generate the beat note. It's frequency serves as the reference frequency for this lock

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

kernel_invariants = {'reference_laser'}

get_frequency()

Get the absolute frequency of the light exiting the laser in Hz, based on the current frequency of the reference laser

Return type:

float

set_frequency(frequency)

Set the absolute frequency of the light exiting the laser, relative to the current frequency of the reference laser

Parameters:

frequency (float) -- The absolute frequency in Hz of the light exiting the laser

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

Ramp the absolute frequency of the light exiting the laser, relative to the current frequency of the reference laser

Parameters:

• duration (float) -- Ramp duration in s

• frequency_start (float) -- Initial absolute frequency in Hz of the light exiting the laser

• frequency_end (float) -- Final absolute frequency in Hz of the light exiting the laser

• ramp_timestep (float) -- Time in s between two ramp steps

• ramp_steps (int32) -- Number of ramp steps (default -1, i.e. derive from the timestep)

ramp_detuning(duration, offset_frequency_start=nan, offset_frequency_end=nan, ramp_timestep=nan, ramp_steps=np.int32(-1))

Ramp the lock offset, i.e. the detuning of the laser fundamental from the reference frequency

Parameters:

• duration (float) -- Ramp duration in s

• offset_frequency_start (float) -- Initial lock offset in Hz (at the laser fundamental)

• offset_frequency_end (float) -- Final lock offset in Hz (at the laser fundamental)

• ramp_timestep (float) -- Time in s between two ramp steps

• ramp_steps (int32) -- Number of ramp steps (default -1, i.e. derive from the timestep)

set_detuning(offset_frequency)

Set the frequency of the laser fundamental relative to the reference frequency, i.e. set the lock offset.

Parameters:

offset_frequency (float) -- new lock offset in Hz (at the laser fundamental)

set_parameter(value, channel=None)

Parameters:

• value (float)

• channel (str)