Qudi
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
pulse_objects.PulseSequence Class Reference

Higher order object for sequence capability. More...

Inheritance diagram for pulse_objects.PulseSequence:
Inheritance graph
[legend]
Collaboration diagram for pulse_objects.PulseSequence:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, name, ensemble_list=None, rotating_frame=False)
 The constructor for a PulseSequence objects needs to have: More...
 
def refresh_parameters (self)
 
def __repr__ (self)
 
def __str__ (self)
 
def __eq__ (self, other)
 
def __len__ (self)
 
def __getitem__ (self, key)
 
def __setitem__ (self, key, value)
 
def __delitem__ (self, key)
 
def pop (self, position=None)
 
def insert (self, position, element)
 
def append (self, element)
 
def extend (self, iterable)
 
def clear (self)
 
def reverse (self)
 
def get_dict_representation (self)
 

Static Public Member Functions

def sequence_from_dict (sequence_dict)
 

Public Attributes

 name
 
 rotating_frame
 
 ensemble_list
 
 is_finite
 
 sampling_information
 
 measurement_information
 

Detailed Description

Higher order object for sequence capability.

Represents a playback procedure for a number of PulseBlockEnsembles. Unused for pulse generator hardware without sequencing functionality.

Constructor & Destructor Documentation

◆ __init__()

def pulse_objects.PulseSequence.__init__ (   self,
  name,
  ensemble_list = None,
  rotating_frame = False 
)

The constructor for a PulseSequence objects needs to have:

Parameters
strname: the actual name of the sequence
listensemble_list: list containing a tuple of two entries: [(PulseBlockEnsemble name, seq_param), (PulseBlockEnsemble name, seq_param), ...] The seq_param is a dictionary, where the various sequence parameters are saved with their keywords and the according parameter (as item). Available parameters are: 'repetitions': The number of repetitions for that sequence step. (Default 0) 0 meaning the step is played once. Set to -1 for infinite looping. 'go_to': The sequence step index to jump to after having played all repetitions. (Default -1) Indices starting at 1 for first step. Set to 0 or -1 to follow up with the next step. 'event_jump_to': The sequence step to jump to (starting from 1) in case of a trigger event (see event_trigger). Setting it to 0 or -1 means jump to next step. Ignored if event_trigger is 'OFF'. 'event_trigger': The trigger input to listen to in order to perform sequence jumps. Set to 'OFF' (default) in order to ignore triggering. 'wait_for': The trigger input to wait for before playing this sequence step. Set to 'OFF' (default) in order to play the current step immediately. 'flag_trigger': The flag to trigger when this sequence step starts playing. Select 'OFF' (default) for no flag trigger. 'flag_high': The flag to set to high while this step is playing. Select 'OFF' (default) to set all flags to low.

If only 'repetitions' are in the dictionary, then the dict will look like: seq_param = {'repetitions': 41} and so the respective sequence step will play 42 times.

Parameters
boolrotating_frame: indicates, whether the phase has to be preserved in all analog signals ACROSS different waveforms

The documentation for this class was generated from the following file: