Lock

Class Arguments

Argument	Type	Default Value
reference_frequency	float
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.Lock",
        "arguments": {
            "reference_frequency": "<mandatory parameter (float)>",
            "lock_offset": 0.0,
            "harmonic": 1,
            "debug_output": false
        }
    }
}

Class Description

class atomiq.components.lock.Lock(reference_frequency, lock_offset=0.0, harmonic=np.int32(1), *args, **kwargs)

Bases: Component

This is a very generic class to describe a laser lock. It is characterized by some means of a reference frequency and an 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.

All frequencies of this class refer to the fundamental of the laser, i.e. the frequency the lock acts on. get_frequency() returns the frequency of the light exiting the laser, i.e. the fundamental frequency multiplied by the harmonic.

Parameters:

• reference_frequency (float) -- The frequency in Hz that the lock references to (at the laser fundamental)

• lock_offset (float) -- The frequency offset in Hz at which the lock stabilizes (at the laser fundamental)

• harmonic (int32) -- Use this option if the laser is frequency converted but locked to the fundamental. Use 1 for no conversion, 2 for SHG, 4 for FHG ,... (default 1)

kernel_invariants = {'harmonic'}

get_frequency()

Get the absolute frequency of the light exiting the laser in Hz (fundamental frequency x harmonic)

Return type:

float