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

Object representing a single atomic element in a pulse block. More...

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

Public Member Functions

def __init__ (self, init_length_s=10e-9, increment_s=0, pulse_function=None, digital_high=None)
 The constructor for a Pulse_Block_Element needs to have: More...
 
def __repr__ (self)
 
def __str__ (self)
 
def __eq__ (self, other)
 
def get_dict_representation (self)
 

Static Public Member Functions

def element_from_dict (element_dict)
 

Public Attributes

 init_length_s
 
 increment_s
 
 pulse_function
 
 digital_high
 
 analog_channels
 
 digital_channels
 
 channel_set
 

Detailed Description

Object representing a single atomic element in a pulse block.

This class can build waiting times, sine waves, etc. The pulse block may contain many Pulse_Block_Element Objects. These objects can be displayed in a GUI as single rows of a Pulse_Block.

Constructor & Destructor Documentation

◆ __init__()

def pulse_objects.PulseBlockElement.__init__ (   self,
  init_length_s = 10e-9,
  increment_s = 0,
  pulse_function = None,
  digital_high = None 
)

The constructor for a Pulse_Block_Element needs to have:

Parameters
floatinit_length_s: an initial length of the element, this parameters should not be zero but must have a finite value.
floatincrement_s: the number which will be incremented during each repetition of this element.
dictpulse_function: dictionary with keys being the qudi analog channel string descriptors ('a_ch1', 'a_ch2' etc.) and the corresponding objects being instances of the mathematical function objects provided by SamplingFunctions class.
dictdigital_high: dictionary with keys being the qudi digital channel string descriptors ('d_ch1', 'd_ch2' etc.) and the corresponding objects being boolean values describing if the channel should be logical low (False) or high (True). For 3 digital channel it may look like: {'d_ch1': True, 'd_ch2': False, 'd_ch5': False}

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