OFCLockΒΆ
Class Arguments
Argument |
Type |
Default Value |
---|---|---|
rf_source |
RFSource |
|
lock_direction |
TInt32 |
1 |
tooth_number |
TInt32 |
-1 |
rep_rate |
TFloat |
nan |
ceo |
TFloat |
nan |
settle_time |
TFloat |
0 |
blind |
TBool |
False |
lock_offset |
TFloat |
0.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.OFCLock",
"arguments": {
"rf_source": "<mandatory parameter (RFSource)>",
"lock_direction": 1,
"tooth_number": -1,
"rep_rate": NaN,
"ceo": NaN,
"settle_time": 0,
"blind": false,
"lock_offset": 0.0,
"harmonic": 1
}
}
}
Class Description
- class atomiq.components.lock.OFCLock(rf_source, lock_direction=1, tooth_number=-1, rep_rate=nan, ceo=nan, *args, **kwargs)[source]
Bases:
DetunableLock
Lock on an optical frequency comb
This is used to lock the laser on a beat note with an optical frequency comb. It is characterized by the frequency of the closest comb tooth and the offset frequency. The offset frequency is generated by an RF source and can be changed at runtime. Thus the lock point can be detuned.
- Parameters:
rfsource -- RF source that generates the reference beat frequency (i.e. the offset frequency) to which the laser beat note is stabilized.
reference_frequency -- The frequency in Hz of the comb tooth. Instead
ceo
,rep_rate
andtooth_number
) can be passed to automatically calculate the reference frequency.reference_frequency
is ignored in this case.lock_offset -- The default frequency offset to the comb tooth in Hz at which the lock stabilizes
settle_time -- Time in s the lock needs to settle after a detuning of the lock point
lock_direction (TInt32) -- Whether the laser is locked to the positive (+1) or negative (-1) beat note (default 1)
tooth_number (TInt32) -- Number of the comb tooth, the laser is beaten with (default -1)
rep_rate (TFloat) -- Repetition frequency of the comb in Hz (default
nan
)ceo (TFloat) -- Ceo frequency of the comb in Hz (default
nan
)rf_source (RFSource)
A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)
- kernel_invariants = {'lock_direction', 'rf_source'}
- get_frequency()
- Return type:
artiq.compiler.types.TMono('float', OrderedDict())
- set_detuning(offset_frequency)
Set the frequency relative to the reference frequency, i.e. set the lock offset.
- Parameters:
offset_frequency (artiq.compiler.types.TMono('float', OrderedDict())) -- new lock offset in Hz
- set_frequency(frequency)
Set the absolute frequency of the locked line
- Parameters:
frequency (artiq.compiler.types.TMono('float', OrderedDict())) -- The absoulte frequency at which the system should lock
- set_parameter(value, channel=None)
- Parameters:
value (artiq.compiler.types.TMono('float', OrderedDict()))
channel (artiq.compiler.types.TMono('str', OrderedDict()))