odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse Class Reference

Inheritance diagram for odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse:

Collaboration diagram for odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse:

Public Member Functions
def	__init__ (self, config, kwargs)
def	on_activate (self)
	Initialisation performed during activation of the module. More...
def	on_deactivate (self)
def	set_up_odmr_clock (self, clock_frequency=None, clock_channel=None)
	ODMR counter interface commands. 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...
def	trigger (self)
	--------— Microwave interface commands --------—
def	off (self)
def	get_status (self)
def	get_power (self)
	Gets the microwave output power for the currently active mode. More...
def	get_frequency (self)
def	cw_on (self)
def	set_cw (self, frequency=None, power=None)
	Configures the device for cw-mode and optionally sets frequency and/or power. More...
def	list_on (self)
def	set_list (self, frequency=None, power=None)
	Configures the device for list-mode and optionally sets frequencies and/or power. More...
def	reset_listpos (self)
	Reset of MW list mode position to start (first frequency step) More...
def	sweep_on (self)
	Switches on the sweep mode. More...
def	set_sweep (self, start=None, stop=None, step=None, power=None)
def	reset_sweeppos (self)
	Reset of MW sweep mode position to start (start frequency) More...
def	set_ext_trigger (self, pol, timing)
	Set the external trigger for this device with proper polarization. More...
def	get_limits (self)
	Return the device-specific limits in a nested dictionary. More...

Static Public Attributes
	slowcounter = Connector(interface='SlowCounterInterface')
	microwave = Connector(interface='MicrowaveInterface')

Member Function Documentation

close_odmr()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.close_odmr

(

self

)

Close the odmr and clean up afterwards.

Returns

int: error code (0:OK, -1:error)

close_odmr_clock()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.close_odmr_clock

(

self

)

Close the odmr and clean up afterwards.

Returns

int: error code (0:OK, -1:error)

count_odmr()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.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_limits()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.get_limits

(

self

)

Return the device-specific limits in a nested dictionary.

Returns

MicrowaveLimits: Microwave limits object

get_odmr_channels()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.get_odmr_channels

(

self

)

Return a list of channel names.

Returns

list(str): channels recorded during ODMR measurement

get_power()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.get_power

(

self

)

Gets the microwave output power for the currently active mode.

Returns

float: the output power in dBm

on_activate()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.on_activate

(

self

)

Initialisation performed during activation of the module.

reset_listpos()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.reset_listpos

(

self

)

Reset of MW list mode position to start (first frequency step)

Returns

int: error code (0:OK, -1:error)

reset_sweeppos()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.reset_sweeppos

(

self

)

Reset of MW sweep mode position to start (start frequency)

Returns

int: error code (0:OK, -1:error)

set_cw()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.set_cw	(		self,
			frequency = None,
			power = None
	)

Configures the device for cw-mode and optionally sets frequency and/or power.

Parameters

float	frequency: frequency to set in Hz
float	power: power to set in dBm

Returns

tuple(float, float, str): with the relation current frequency in Hz, current power in dBm, current mode

set_ext_trigger()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.set_ext_trigger	(		self,
			pol,
			timing
	)

Set the external trigger for this device with proper polarization.

Parameters

TriggerEdge	pol: polarisation of the trigger (basically rising edge or falling edge)
timing	estimated time between triggers

Returns

object: current trigger polarity [TriggerEdge.RISING, TriggerEdge.FALLING]

set_list()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.set_list	(		self,
			frequency = None,
			power = None
	)

Configures the device for list-mode and optionally sets frequencies and/or power.

Parameters

list	frequency: list of frequencies in Hz
float	power: MW power of the frequency list in dBm

Returns

list, float, str: current frequencies in Hz, current power in dBm, current mode

set_odmr_length()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.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_microwave_interfuse.ODMRCounterMicrowaveInterfuse.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_microwave_interfuse.ODMRCounterMicrowaveInterfuse.set_up_odmr_clock	(		self,
			clock_frequency = None,
			clock_channel = None
	)

ODMR counter interface commands.

Configures the hardware clock of the NiDAQ card to give the timing.

    @param float clock_frequency: if defined, this sets the frequency of the
                                  clock
    @param str clock_channel: if defined, this is the physical channel of
                              the clock

    @return int: error code (0:OK, -1:error)

sweep_on()

def odmr_counter_microwave_interfuse.ODMRCounterMicrowaveInterfuse.sweep_on

(

self

)

Switches on the sweep mode.

Returns

int: error code (0:OK, -1:error)

---

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

• logic/interfuse/odmr_counter_microwave_interfuse.py