mw_source_gigatronics.MicrowaveGigatronics Class Reference

Hardware file for Gigatronics. More...

Inheritance diagram for mw_source_gigatronics.MicrowaveGigatronics:

Collaboration diagram for mw_source_gigatronics.MicrowaveGigatronics:

Public Member Functions
def	on_activate (self)
	Initialisation performed during activation of the module.
def	on_deactivate (self)
	Deinitialisation performed during deactivation of the module.
def	get_limits (self)
	Limits of Gigatronics 2400/2500 microwave source series. More...
def	off (self)
def	get_status (self)
def	get_power (self)
	Gets the microwave output power. More...
def	get_frequency (self)
def	cw_on (self)
	Switches on any preconfigured microwave output. More...
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 from first given frequency. More...
def	set_ext_trigger (self, pol, timing)
	Set the external trigger for this device with proper polarization. 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	trigger (self)
	Trigger the next element in the list or sweep mode programmatically. More...
Public Member Functions inherited from core.module.BaseMixin
def	__init__ (self, manager, name, config=None, callbacks=None, kwargs)
	Initialise Base class object and set up its state machine. More...
def	log (self)
	Returns a logger object.
def	is_module_threaded (self)
	Returns whether the module shall be started in a thread.
def	on_activate (self)
	Method called when module is activated. More...
def	on_deactivate (self)
	Method called when module is deactivated. More...
def	getStatusVariables (self)
	Return a dict of variable names and their content representing the module state for saving. More...
def	setStatusVariables (self, variableDict)
	Give a module a dict of variable names and their content representing the module state. More...
def	getConfiguration (self)
	Return the configration dictionary for this module. More...
def	get_connector (self, connector_name)
	Return module connected to the given named connector. More...
Public Member Functions inherited from core.module.ModuleMeta
def	__new__ (cls, name, bases, attrs)
	Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More...

Public Attributes
	rm
	model
Public Attributes inherited from core.module.BaseMixin
	module_state
	connectors

Detailed Description

Hardware file for Gigatronics.

Tested for the model 2400/2500.

Example config for copy-paste:

mw_source_gigatronics: module 'microwave.mw_source_gigatronics.MicrowaveGigatronics' gpib_address 'GPIB0::12::INSTR' gpib_timeout 10

Member Function Documentation

cw_on()

def mw_source_gigatronics.MicrowaveGigatronics.cw_on

(

self

)

Switches on any preconfigured microwave output.

Returns

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

get_limits()

def mw_source_gigatronics.MicrowaveGigatronics.get_limits

(

self

)

Limits of Gigatronics 2400/2500 microwave source series.

return limits of the particular Gigatronics MW source model

get_power()

def mw_source_gigatronics.MicrowaveGigatronics.get_power

(

self

)

Gets the microwave output power.

Returns

float: the power set at the device in dBm

reset_listpos()

def mw_source_gigatronics.MicrowaveGigatronics.reset_listpos

(

self

)

Reset of MW List Mode position to start from first given frequency.

Returns

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

reset_sweeppos()

def mw_source_gigatronics.MicrowaveGigatronics.reset_sweeppos

(

self

)

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

Returns

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

set_cw()

def mw_source_gigatronics.MicrowaveGigatronics.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

float, float, str: current frequency in Hz, current power in dBm, current mode

set_ext_trigger()

def mw_source_gigatronics.MicrowaveGigatronics.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)
float	timing: estimated time between triggers

Returns

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

set_list()

def mw_source_gigatronics.MicrowaveGigatronics.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

sweep_on()

def mw_source_gigatronics.MicrowaveGigatronics.sweep_on

(

self

)

Switches on the sweep mode.

Returns

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

trigger()

def mw_source_gigatronics.MicrowaveGigatronics.trigger

(

self

)

Trigger the next element in the list or sweep mode programmatically.

Returns

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

Ensure that the Frequency was set AFTER the function returns, or give the function at least a save waiting time.

---

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

• hardware/microwave/mw_source_gigatronics.py