OFCLockΒΆ
Class Arguments
Argument |
Type |
Default Value |
|---|---|---|
rf_source |
RFSource |
|
lock_direction |
np.int32 |
1 |
tooth_number |
np.int32 |
-1 |
rep_rate |
float |
"NaN" |
ceo |
float |
"NaN" |
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.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,
"debug_output": false
}
}
}
Class Description
- class atomiq.components.lock.OFCLock(rf_source, lock_direction=np.int32(1), tooth_number=np.int32(-1), rep_rate=nan, ceo=nan, *args, **kwargs)[source]
Bases:
DetunableLockLock 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_rateandtooth_number) can be passed to automatically calculate the reference frequency.reference_frequencyis 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 (
int32) -- Whether the laser is locked to the positive (+1) or negative (-1) beat note (default 1)tooth_number (
int32) -- Number of the comb tooth, the laser is beaten with (default -1)rep_rate (
float) -- Repetition frequency of the comb in Hz (defaultnan)ceo (
float) -- Ceo frequency of the comb in Hz (defaultnan)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()
Get the absolute frequency of the light exiting the laser in Hz (fundamental frequency x harmonic)
- Return type:
float
- 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 soffset_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 stepsramp_steps (
int32) -- Number of ramp steps (default -1, i.e. derive from the timestep)
- ramp_frequency(duration, frequency_start=nan, frequency_end=nan, ramp_timestep=nan, ramp_steps=np.int32(-1))
Ramp the absolute frequency of the light exiting the laser
- Parameters:
duration (
float) -- Ramp duration in sfrequency_start (
float) -- Initial absolute frequency in Hz of the light exiting the laserfrequency_end (
float) -- Final absolute frequency in Hz of the light exiting the laserramp_timestep (
float) -- Time in s between two ramp stepsramp_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_frequency(frequency)
Set the absolute frequency of the light exiting the laser
- Parameters:
frequency (
float) -- The absolute frequency in Hz of the light exiting the laser
- set_parameter(value, channel=None)
- Parameters:
value (float)
channel (str)