Qudi
Public Member Functions | Public Attributes | List of all members
mw_source_anritsu_mg3691c.MicrowaveAnritsu Class Reference

Hardware control file for Anritsu Devices. More...

Inheritance diagram for mw_source_anritsu_mg3691c.MicrowaveAnritsu:
Inheritance graph
[legend]
Collaboration diagram for mw_source_anritsu_mg3691c.MicrowaveAnritsu:
Collaboration graph
[legend]

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)
 Right now, this is for Anritsu MG3691C with Option 2 only. 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 (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 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 control file for Anritsu Devices.

Tested for the model MG3691C with OPTION 2. cw and list modes are tested. Important Trigger for frequency sweep is totally independent with most trigger syntax. In addition, it has to be Aux I/O pin connection.

Example config for copy-paste:

mw_source_anritsu_mg3691c: module 'microwave.mw_source_anritsu_mg3691.MicrowaveAnritsu' gpib_address 'GPIB0::12::INSTR' gpib_timeout 10 # in seconds

Member Function Documentation

◆ cw_on()

def mw_source_anritsu_mg3691c.MicrowaveAnritsu.cw_on (   self)

Switches on any preconfigured microwave output.

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

◆ get_limits()

def mw_source_anritsu_mg3691c.MicrowaveAnritsu.get_limits (   self)

Right now, this is for Anritsu MG3691C with Option 2 only.

◆ get_power()

def mw_source_anritsu_mg3691c.MicrowaveAnritsu.get_power (   self)

Gets the microwave output power.

Returns
float: the power set at the device in dBm

◆ reset_listpos()

def mw_source_anritsu_mg3691c.MicrowaveAnritsu.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 mw_source_anritsu_mg3691c.MicrowaveAnritsu.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_anritsu_mg3691c.MicrowaveAnritsu.set_cw (   self,
  frequency = None,
  power = None 
)

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

Parameters
floatfrequency: frequency to set in Hz
floatpower: power to set in dBm
booluseinterleave: If this mode exists you can choose it.
Returns
float, float, str: current frequency in Hz, current power in dBm, current mode

Interleave option is used for arbitrary waveform generator devices.

◆ set_ext_trigger()

def mw_source_anritsu_mg3691c.MicrowaveAnritsu.set_ext_trigger (   self,
  pol,
  timing 
)

Set the external trigger for this device with proper polarization.

Parameters
TriggerEdgepol: polarisation of the trigger (basically rising edge or falling edge)
floattiming: estimated time between triggers
Returns
object, float: current trigger polarity [TriggerEdge.RISING, TriggerEdge.FALLING], trigger timing

◆ set_list()

def mw_source_anritsu_mg3691c.MicrowaveAnritsu.set_list (   self,
  frequency = None,
  power = None 
)

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

Parameters
listfrequency: list of frequencies in Hz
floatpower: 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_anritsu_mg3691c.MicrowaveAnritsu.sweep_on (   self)

Switches on the sweep mode.

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

◆ trigger()

def mw_source_anritsu_mg3691c.MicrowaveAnritsu.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: