Interface class to define the controls for fast counting devices. More...
Public Member Functions | |
| def | get_constraints (self) |
| Retrieve the hardware constrains from the Fast counting device. More... | |
| def | configure (self, bin_width_s, record_length_s, number_of_gates=0) |
| Configuration of the fast counter. More... | |
| def | get_status (self) |
| Receives the current status of the Fast Counter and outputs it as return value. More... | |
| def | start_measure (self) |
| Start the fast counter. More... | |
| def | stop_measure (self) |
| Stop the fast counter. More... | |
| def | pause_measure (self) |
| Pauses the current measurement. More... | |
| def | continue_measure (self) |
| Continues the current measurement. More... | |
| def | is_gated (self) |
| Check the gated counting possibility. More... | |
| def | get_binwidth (self) |
| Returns the width of a single timebin in the timetrace in seconds. More... | |
| def | get_data_trace (self) |
| Polls the current timetrace data from the fast counter. More... | |
 Public Member Functions inherited from core.module.ModuleMeta | |
| def | __new__ (cls, name, bases, attrs) |
| Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More... | |
Detailed Description
Interface class to define the controls for fast counting devices.
Member Function Documentation
◆ configure()
| def fast_counter_interface.FastCounterInterface.configure | ( | self, | |
| bin_width_s, | |||
| record_length_s, | |||
number_of_gates = 0 |
|||
| ) |
Configuration of the fast counter.
- Parameters
-
float bin_width_s: Length of a single time bin in the time trace histogram in seconds. float record_length_s: Total length of the timetrace/each single gate in seconds. int number_of_gates: optional, number of gates in the pulse sequence. Ignore for not gated counter.
- Returns
- tuple(binwidth_s, record_length_s, number_of_gates): binwidth_s float the actual set binwidth in seconds gate_length_s the actual record length in seconds number_of_gates the number of gated, which are accepted, None if not-gated
◆ continue_measure()
| def fast_counter_interface.FastCounterInterface.continue_measure | ( | self | ) |
Continues the current measurement.
If fast counter is in pause state, then fast counter will be continued.
◆ get_binwidth()
| def fast_counter_interface.FastCounterInterface.get_binwidth | ( | self | ) |
Returns the width of a single timebin in the timetrace in seconds.
- Returns
- float: current length of a single bin in seconds (seconds/bin)
◆ get_constraints()
| def fast_counter_interface.FastCounterInterface.get_constraints | ( | self | ) |
Retrieve the hardware constrains from the Fast counting device.
- Returns
- dict: dict with keys being the constraint names as string and items are the definition for the constaints.
The keys of the returned dictionary are the str name for the constraints (which are set in this method).
NO OTHER KEYS SHOULD BE INVENTED!
If you are not sure about the meaning, look in other hardware files to get an impression. If still additional constraints are needed, then they have to be added to all files containing this interface.
The items of the keys are again dictionaries which have the generic dictionary form: {'min':
, 'max':
, 'step':
, 'unit': '
'}
Only the key 'hardware_binwidth_list' differs, since they contain the list of possible binwidths.
If the constraints cannot be set in the fast counting hardware then write just zero to each key of the generic dicts. Note that there is a difference between float input (0.0) and integer input (0), because some logic modules might rely on that distinction.
ALL THE PRESENT KEYS OF THE CONSTRAINTS DICT MUST BE ASSIGNED!
Example for configuration with default values:
constraints = dict()
the unit of those entries are seconds per bin. In order to get the
current binwidth in seonds use the get_binwidth method.
constraints['hardware_binwidth_list'] = []
◆ get_data_trace()
| def fast_counter_interface.FastCounterInterface.get_data_trace | ( | self | ) |
Polls the current timetrace data from the fast counter.
Return value is a numpy array (dtype = int64). The binning, specified by calling configure() in forehand, must be taken care of in this hardware class. A possible overflow of the histogram bins must be caught here and taken care of. If the counter is NOT GATED it will return a 1D-numpy-array with returnarray[timebin_index] If the counter is GATED it will return a 2D-numpy-array with returnarray[gate_index, timebin_index]
◆ get_status()
| def fast_counter_interface.FastCounterInterface.get_status | ( | self | ) |
Receives the current status of the Fast Counter and outputs it as return value.
0 = unconfigured 1 = idle 2 = running 3 = paused -1 = error state
◆ is_gated()
| def fast_counter_interface.FastCounterInterface.is_gated | ( | self | ) |
Check the gated counting possibility.
- Returns
- bool: Boolean value indicates if the fast counter is a gated counter (TRUE) or not (FALSE).
◆ pause_measure()
| def fast_counter_interface.FastCounterInterface.pause_measure | ( | self | ) |
Pauses the current measurement.
Fast counter must be initially in the run state to make it pause.
◆ start_measure()
| def fast_counter_interface.FastCounterInterface.start_measure | ( | self | ) |
Start the fast counter.
◆ stop_measure()
| def fast_counter_interface.FastCounterInterface.stop_measure | ( | self | ) |
Stop the fast counter.
The documentation for this class was generated from the following file:
- interface/fast_counter_interface.py
