qcodes_contrib_drivers.drivers.SwabianInstruments.private package

Submodules

qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger module

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.ArrayLikeValidator(min_value: float | int | floating | integer | None = None, max_value: float | int | floating | integer | None = None, shape: Sequence[int | Callable[[], int]] | None = None, valid_types: Sequence[type] | None = None)

Bases: Arrays

A validator for array_like objects.

Note that validation might be expensive since conversion to ndarray takes place each time.

validate(value: _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str], context: str = '') → None

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.DelegateParameterWithoutParentValidator(name: str, source: Parameter | None, *args: Any, **kwargs: Any)

Bases: DelegateParameter

A DelegateParameter with a validator that does not validate on the parent’s validators.

property validators: tuple[Validator, ...]

Tuple of all validators associated with the parameter.

Getter:

All validators associated with the parameter.

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.LogspaceNumValidator(start_param: ParameterBase, stop_param: ParameterBase)

Bases: Validator[int]

Validates the n_bins parameter of a HistogramLogBinsMeasurement.

validate(value: int, context: str = '') → None

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.LogspaceStartValidator(stop_param: ParameterBase, num_param: ParameterBase)

Bases: Validator[float]

Validates the exp_start parameter of a HistogramLogBinsMeasurement.

validate(value: float, context: str = '') → None

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.LogspaceStopValidator(start_param: ParameterBase, num_param: ParameterBase)

Bases: Validator[float]

Validates the exp_stop parameter of a HistogramLogBinsMeasurement.

validate(value: float, context: str = '') → None

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.MeasurementControlMixin

Bases: object

Mixin class forwarding common methods from the TimeTagger API.

clear()

Implements API object TimeTagger:IteratorBase.clear() – see the documentation there.

is_running() → bool

Implements API object TimeTagger:IteratorBase.isRunning() – see the documentation there.

start()

Implements API object TimeTagger:IteratorBase.start() – see the documentation there.

start_for(duration: int, clear: bool = True)

Implements API object TimeTagger:IteratorBase.startFor() – see the documentation there.

stop()

Implements API object TimeTagger:IteratorBase.stop() – see the documentation there.

wait_until_finished(timeout: int = -1)

Implements API object TimeTagger:IteratorBase.waitUntilFinished() – see the documentation there.

abstract property api

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.ParameterWithSetSideEffect(name: str, set_side_effect: Callable[[Any], None], set_cmd: Callable[[Any], Any] | None = None, execute_before: bool = False, **kwargs: Any)

Bases: Parameter

A Parameter allowing for side effects on set events.

Parameters:

• set_side_effect – A callable that is run on every set event. Receives the set value as sole argument.

• execute_before – Run the side effect before or after setting the parameter.

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.TimeTaggerInstrumentBase(name: str, metadata: Mapping[Any, Any] | None = None, label: str | None = None)

Bases: InstrumentBase

Base class for TimeTagger instruments and channels.

Overrides snapshot_base() to add the API configuration.

get_configuration() → dict[str, Any]

Implements API object TimeTagger:TimeTaggerBase.getConfiguration() – see the documentation there.

snapshot_base(update: bool | None = False, params_to_skip_update: Sequence[str] | None = None) → dict[Any, Any]

State of the instrument as a JSON-compatible dict (everything that the custom JSON encoder class NumpyJSONEncoder supports).

Parameters:

• update – If True, update the state by querying the instrument. If None update the state if known to be invalid. If False, just use the latest values in memory and never update state.

• params_to_skip_update – List of parameter names that will be skipped in update even if update is True. This is useful if you have parameters that are slow to update but can be updated in a different way (as in the qdac). If you want to skip the update of certain parameters in all snapshots, use the snapshot_get attribute of those parameters instead.

Returns:

base snapshot

Return type:

dict

abstract property api

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.TimeTaggerMeasurement(parent: InstrumentBase, name: str, api_tagger: tt.TimeTaggerBase | None = None, **kwargs: Any)

Bases: MeasurementControlMixin, TimeTaggerInstrumentBase, TimeTaggerModule

Instrument channel representing a TimeTagger API Measurement.

get_capture_duration() → int

Implements API object TimeTagger:IteratorBase.getCaptureDuration() – see the documentation there.

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.TimeTaggerModule(parent: InstrumentBase, name: str, api_tagger: tt.TimeTaggerBase | None = None, **kwargs: Any)

Bases: InstrumentChannel

An InstrumentChannel implementing TimeTagger Measurements and Virtual Channels.

__init__(parent: InstrumentBase, name: str, api_tagger: tt.TimeTaggerBase | None = None, **kwargs: Any)

Initialize a TimeTaggerModule.

Parameters:

• parent – The parent instrument.

• name – The channel name.

• api_tagger – The TimeTagger API object of the device to use. Can be a virtual time tagger gotten from TimeTaggerSynchronizedMeasurements.get_tagger().

classmethod implementations() → frozenset[type[TimeTaggerModule]]

All registered implementations of this class.

abstract property api

The TimeTagger:TimeTagger.Measurement API object underlying this module.

property api_tagger: tt.TimeTaggerBase

The TimeTagger:TimeTagger.TimeTaggerBase API object underlying this module.

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.TimeTaggerSynchronizedMeasurements(parent: InstrumentBase, name: str, **kwargs: Any)

Bases: MeasurementControlMixin, InstrumentModule

Instrument module representing a TimeTagger API TimeTagger:SynchronizedMeasurements object.

register_measurement(measurement: TimeTaggerMeasurement)

Implements API object TimeTagger:SynchronizedMeasurements.registerMeasurement() – see the documentation there.

unregister_measurement(measurement: TimeTaggerMeasurement)

Implements API object TimeTagger:SynchronizedMeasurements.unregisterMeasurement() – see the documentation there.

property api: tt.SynchronizedMeasurements

property api_tagger: tt.TimeTaggerBase

A proxy TimeTagger API object for synchronized measurements.

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.TimeTaggerVirtualChannel(parent: InstrumentBase, name: str, api_tagger: tt.TimeTaggerBase | None = None, **kwargs: Any)

Bases: TimeTaggerInstrumentBase, TimeTaggerModule

Instrument channel representing a TimeTagger API Virtual Channel.

get_channel() → int

Implements API object VirtualChannel.getChannel() – see the documentation there.

get_channels() → list[int]

Implements API object VirtualChannel.getChannels() – see the documentation there.

class qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.TypeValidator(cls: type)

Bases: Validator[type]

A validator for specific types.

validate(value: type, context: str = '') → None

qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.cached_api_object(__func: Callable[[...], Any] | None = None, *, required_parameters: Collection[str] | None = None)

A custom descriptor for a cached API object with exception handling, invalidation capability, and initialization checks.

qcodes_contrib_drivers.drivers.SwabianInstruments.private.time_tagger.refer_to_api_doc(api_obj: str = '') → Callable[[_O], _O]

Decorator factory to link a method to its TT API documentation.

Module contents