This is the Interface class supplies the controls for a simple ODMR. More...
Inheritance diagram for odmr_counter_interface.ODMRCounterInterface:
Collaboration diagram for odmr_counter_interface.ODMRCounterInterface:
Public Member Functions | |
| def | set_up_odmr_clock (self, clock_frequency=None, clock_channel=None) |
| Configures the hardware clock of the NiDAQ card to give the timing. More... | |
| def | set_up_odmr (self, counter_channel=None, photon_source=None, clock_channel=None, odmr_trigger_channel=None) |
| Configures the actual counter with a given clock. More... | |
| def | set_odmr_length (self, length=100) |
| Set up the trigger sequence for the ODMR and the triggered microwave. More... | |
| def | count_odmr (self, length=100) |
| Sweeps the microwave and returns the counts on that sweep. More... | |
| def | close_odmr (self) |
| Close the odmr and clean up afterwards. More... | |
| def | close_odmr_clock (self) |
| Close the odmr and clean up afterwards. More... | |
| def | get_odmr_channels (self) |
| Return a list of channel names. 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
This is the Interface class supplies the controls for a simple ODMR.
Member Function Documentation
◆ close_odmr()
| def odmr_counter_interface.ODMRCounterInterface.close_odmr | ( | self | ) |
Close the odmr and clean up afterwards.
- Returns
- int: error code (0:OK, -1:error)
◆ close_odmr_clock()
| def odmr_counter_interface.ODMRCounterInterface.close_odmr_clock | ( | self | ) |
Close the odmr and clean up afterwards.
- Returns
- int: error code (0:OK, -1:error)
◆ count_odmr()
| def odmr_counter_interface.ODMRCounterInterface.count_odmr | ( | self, | |
length = 100 |
|||
| ) |
Sweeps the microwave and returns the counts on that sweep.
- Parameters
-
int length: length of microwave sweep in pixel
- Returns
- float[]: the photon counts per second
◆ get_odmr_channels()
| def odmr_counter_interface.ODMRCounterInterface.get_odmr_channels | ( | self | ) |
Return a list of channel names.
- Returns
- list(str): channels recorded during ODMR measurement
◆ set_odmr_length()
| def odmr_counter_interface.ODMRCounterInterface.set_odmr_length | ( | self, | |
length = 100 |
|||
| ) |
Set up the trigger sequence for the ODMR and the triggered microwave.
- Parameters
-
int length: length of microwave sweep in pixel
- Returns
- int: error code (0:OK, -1:error)
◆ set_up_odmr()
| def odmr_counter_interface.ODMRCounterInterface.set_up_odmr | ( | self, | |
counter_channel = None, |
|||
photon_source = None, |
|||
clock_channel = None, |
|||
odmr_trigger_channel = None |
|||
| ) |
Configures the actual counter with a given clock.
- Parameters
-
str counter_channel: if defined, this is the physical channel of the counter str photon_source: if defined, this is the physical channel where the photons are to count from str clock_channel: if defined, this specifies the clock for the counter str odmr_trigger_channel: if defined, this specifies the trigger output for the microwave
- Returns
- int: error code (0:OK, -1:error)
◆ set_up_odmr_clock()
| def odmr_counter_interface.ODMRCounterInterface.set_up_odmr_clock | ( | self, | |
clock_frequency = None, |
|||
clock_channel = None |
|||
| ) |
Configures the hardware clock of the NiDAQ card to give the timing.
- Parameters
-
float clock_frequency: if defined, this sets the frequency of the clock str clock_channel: if defined, this is the physical channel of the clock
- Returns
- int: error code (0:OK, -1:error)
The documentation for this class was generated from the following file:
- interface/odmr_counter_interface.py
