DetunableLock#

Class Arguments

Argument

Type

Default Value

reference_frequency

TFloat

settle_time

TFloat

0

blind

TBool

False

lock_offset

TFloat

0

harmonic

TInt32

1

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.lock.DetunableLock

Example Component Dictionary

   {
    "lock_example": {
        "classname": "atomiq.components.lock.DetunableLock",
        "arguments": {
            "reference_frequency": "<mandatory parameter (TFloat)>",
            "settle_time": 0,
            "blind": false,
            "lock_offset": 0,
            "harmonic": 1
        }
    }
}

Class Description

class atomiq.components.lock.DetunableLock(settle_time=0, blind=False, *args, **kwargs)

Bases: Lock, Parametrizable

This is a very generic class to describe a laser lock where the lock offset can be changed. It is characterized by some means of a reference frequency and a detunable offset to that frequency at which the lock tries to stabilize.

Most likely you want to use a more specific class inherited from this one.

Parameters:
  • settle_time (TFloat) -- Time in s the lock needs to settle after a detuning of the lock point

  • blind (TBool) --

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

set_frequency(frequency)

Set the absolute frequency of the locked line

Parameters:

frequency (TFloat) -- The absoulte frequency at which the system should lock

set_detuning(offset_frequency)

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

Parameters:

offset_frequency (TFloat) -- new lock offset in Hz