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)

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 and tooth_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)

append_to_dataset(key, value)

Append a value to a dataset.

The target dataset must be a list (i.e. support append()), and must have previously been set from this experiment.

The broadcast/persist/archive mode of the given key remains unchanged from when the dataset was last set. Appended values are transmitted efficiently as incremental modifications in broadcast mode.

build()

Should be implemented by the user to request arguments.

Other initialization steps such as requesting devices may also be performed here.

There are two situations where the requested devices are replaced by DummyDevice() and arguments are set to their defaults (or None) instead: when the repository is scanned to build the list of available experiments and when the dataset browser artiq_browser is used to open or run the analysis stage of an experiment. Do not rely on being able to operate on devices or arguments in build().

Datasets are read-only in this method.

Leftover positional and keyword arguments from the constructor are forwarded to this method. This is intended for experiments that are only meant to be executed programmatically (not from the GUI).

call_child_method(method, *args, **kwargs)

Calls the named method for each child, if it exists for that child, in the order of registration.

Parameters:

• method (str) -- Name of the method to call

• args -- Tuple of positional arguments to pass to all children

• kwargs -- Dict of keyword arguments to pass to all children

get_argument(key, processor, group=None, tooltip=None)

Retrieves and returns the value of an argument.

This function should only be called from build.

Parameters:

• key -- Name of the argument.

• processor -- A description of how to process the argument, such as instances of BooleanValue and NumberValue.

• group -- An optional string that defines what group the argument belongs to, for user interface purposes.

• tooltip -- An optional string to describe the argument in more detail, applied as a tooltip to the argument name in the user interface.

get_dataset(key, default=<class 'artiq.language.environment.NoDefault'>, archive=True)

Returns the contents of a dataset.

The local storage is searched first, followed by the master storage (which contains the broadcasted datasets from all experiments) if the key was not found initially.

If the dataset does not exist, returns the default value. If no default is provided, raises KeyError.

By default, datasets obtained by this method are archived into the output HDF5 file of the experiment. If an archived dataset is requested more than one time or is modified, only the value at the time of the first call is archived. This may impact reproducibility of experiments.

Parameters:

archive -- Set to False to prevent archival together with the run's results. Default is True.

get_dataset_metadata(key, default=<class 'artiq.language.environment.NoDefault'>)

Returns the metadata of a dataset.

Returns dictionary with items describing the dataset, including the units, scale and precision.

This function is used to get additional information for displaying the dataset.

See set_dataset() for documentation of metadata items.

get_device(key)

Creates and returns a device driver.

get_device_db()

Returns the full contents of the device database.

interactive(title='')

Request arguments from the user interactively.

This context manager returns a namespace object on which the method setattr_argument() should be called, with the usual semantics.

When the context manager terminates, the experiment is blocked and the user is presented with the requested argument widgets. After the user enters values, the experiment is resumed and the namespace contains the values of the arguments.

If the interactive arguments request is cancelled, raises CancelledArgsError.

mutate_dataset(key, index, value)

Mutate an existing dataset at the given index (e.g. set a value at a given position in a NumPy array)

If the dataset was created in broadcast mode, the modification is immediately transmitted.

If the index is a tuple of integers, it is interpreted as slice(*index). If the index is a tuple of tuples, each sub-tuple is interpreted as slice(*sub_tuple) (multi-dimensional slicing).

set_dataset(key, value, *, unit=None, scale=None, precision=None, broadcast=False, persist=False, archive=True)

Sets the contents and handling modes of a dataset.

Datasets must be scalars (bool, int, float or NumPy scalar) or NumPy arrays.

Parameters:

• unit -- A string representing the unit of the value.

• scale -- A numerical factor that is used to adjust the value of the dataset to match the scale or units of the experiment's reference frame when the value is displayed.

• precision -- The maximum number of digits to print after the decimal point. Set precision=None to print as many digits as necessary to uniquely specify the value. Uses IEEE unbiased rounding.

• broadcast -- the data is sent in real-time to the master, which dispatches it.

• persist -- the master should store the data on-disk. Implies broadcast.

• archive -- the data is saved into the local storage of the current run (archived as a HDF5 file).

set_default_scheduling(priority=None, pipeline_name=None, flush=None)

Sets the default scheduling options.

This function should only be called from build.

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

setattr_argument(key, processor=None, group=None, tooltip=None)

Sets an argument as attribute. The names of the argument and of the attribute are the same.

The key is added to the instance's kernel invariants.

setattr_dataset(key, default=<class 'artiq.language.environment.NoDefault'>, archive=True)

Sets the contents of a dataset as attribute. The names of the dataset and of the attribute are the same.

setattr_device(key)

Sets a device driver as attribute. The names of the device driver and of the attribute are the same.

The key is added to the instance's kernel invariants.