Lock#
Class Arguments
Argument |
Type |
Default Value |
---|---|---|
reference_frequency |
TFloat |
|
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
Example Component Dictionary
{
"lock_example": {
"classname": "atomiq.components.lock.Lock",
"arguments": {
"reference_frequency": "<mandatory parameter (TFloat)>",
"lock_offset": 0,
"harmonic": 1
}
}
}
Class Description
- class atomiq.components.lock.Lock(reference_frequency, lock_offset=0, harmonic=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.
- Parameters:
reference_frequency (TFloat) -- The frequency in Hz that the lock references to
lock_offset (TFloat) -- The frequency offset in Hz at which the lock stabilizes
harmonic (TInt32) -- 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)