scanner_tilt_interfuse.ScannerTiltInterfuse Class Reference

This interfuse produces a Z correction corresponding to a tilted surface. More...

Inheritance diagram for scanner_tilt_interfuse.ScannerTiltInterfuse:

Collaboration diagram for scanner_tilt_interfuse.ScannerTiltInterfuse:

Public Member Functions
def	__init__ (self, kwargs)
def	on_activate (self)
	Initialisation performed during activation of the module.
def	on_deactivate (self)
	Deinitialisation performed during deactivation of the module.
def	reset_hardware (self)
	Resets the hardware, so the connection is lost and other programs can access it. More...
def	get_position_range (self)
	Returns the physical range of the scanner. More...
def	set_position_range (self, myrange=None)
	Sets the physical range of the scanner. More...
def	set_voltage_range (self, myrange=None)
	Sets the voltage range of the NI Card. More...
def	get_scanner_axes (self)
	Pass through scanner axes.
def	get_scanner_count_channels (self)
	Pass through scanner counting channels.
def	set_up_scanner_clock (self, clock_frequency=None, clock_channel=None)
	Configures the hardware clock of the NiDAQ card to give the timing. More...
def	set_up_scanner (self, counter_channel=None, photon_source=None, clock_channel=None, scanner_ao_channels=None)
	Configures the actual scanner with a given clock. More...
def	scanner_set_position (self, x=None, y=None, z=None, a=None)
	Move stage to x, y, z, a (where a is the fourth voltage channel). More...
def	get_scanner_position (self)
	Get the current position of the scanner hardware. More...
def	set_up_line (self, length=100)
	Sets up the analoque output for scanning a line. More...
def	scan_line (self, line_path=None, pixel_clock=False)
	Scans a line and returns the counts on that line. More...
def	close_scanner (self)
	Closes the scanner and cleans up afterwards. More...
def	close_scanner_clock (self, power=0)
	Closes the clock and cleans up afterwards. More...

Public Attributes
	tilt_variable_ax
	tilt_variable_ay
	tiltcorrection
	tilt_reference_x
	tilt_reference_y

Static Public Attributes
	confocalscanner1 = Connector(interface='ConfocalScannerInterface')

Detailed Description

This interfuse produces a Z correction corresponding to a tilted surface.

Member Function Documentation

close_scanner()

def scanner_tilt_interfuse.ScannerTiltInterfuse.close_scanner

(

self

)

Closes the scanner and cleans up afterwards.

Returns

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

close_scanner_clock()

def scanner_tilt_interfuse.ScannerTiltInterfuse.close_scanner_clock	(		self,
			power = 0
	)

Closes the clock and cleans up afterwards.

Returns

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

get_position_range()

def scanner_tilt_interfuse.ScannerTiltInterfuse.get_position_range

(

self

)

Returns the physical range of the scanner.

Returns

float [4][2]: array of 4 ranges with an array containing lower and upper limit

get_scanner_position()

def scanner_tilt_interfuse.ScannerTiltInterfuse.get_scanner_position

(

self

)

Get the current position of the scanner hardware.

Returns

float[]: current position in (x, y, z, a).

reset_hardware()

def scanner_tilt_interfuse.ScannerTiltInterfuse.reset_hardware

(

self

)

Resets the hardware, so the connection is lost and other programs can access it.

Returns

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

scan_line()

def scanner_tilt_interfuse.ScannerTiltInterfuse.scan_line	(		self,
			line_path = None,
			pixel_clock = False
	)

Scans a line and returns the counts on that line.

Parameters

float[][4]	line_path: array of 4-part tuples defining the positions pixels
bool	pixel_clock: whether we need to output a pixel clock for this line

Returns

float[]: the photon counts per second

scanner_set_position()

def scanner_tilt_interfuse.ScannerTiltInterfuse.scanner_set_position	(		self,
			x = None,
			y = None,
			z = None,
			a = None
	)

Move stage to x, y, z, a (where a is the fourth voltage channel).

Parameters

float	x: postion in x-direction (volts)
float	y: postion in y-direction (volts)
float	z: postion in z-direction (volts)
float	a: postion in a-direction (volts)

Returns

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

set_position_range()

def scanner_tilt_interfuse.ScannerTiltInterfuse.set_position_range	(		self,
			myrange = None
	)

Sets the physical range of the scanner.

Parameters

float

[4][2] myrange: array of 4 ranges with an array containing lower and upper limit

Returns

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

set_up_line()

def scanner_tilt_interfuse.ScannerTiltInterfuse.set_up_line	(		self,
			length = 100
	)

Sets up the analoque output for scanning a line.

Parameters

int	length: length of the line in pixel

Returns

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

set_up_scanner()

def scanner_tilt_interfuse.ScannerTiltInterfuse.set_up_scanner	(		self,
			counter_channel = None,
			photon_source = None,
			clock_channel = None,
			scanner_ao_channels = None
	)

Configures the actual scanner 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	scanner_ao_channels: if defined, this specifies the analoque output channels

Returns

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

set_up_scanner_clock()

def scanner_tilt_interfuse.ScannerTiltInterfuse.set_up_scanner_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)

set_voltage_range()

def scanner_tilt_interfuse.ScannerTiltInterfuse.set_voltage_range	(		self,
			myrange = None
	)

Sets the voltage range of the NI Card.

Parameters

float

[2] myrange: array containing lower and upper limit

Returns

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

---

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

• logic/interfuse/scanner_tilt_interfuse.py