Scanner Class Reference

Detailed Description

schema

The scanner circuit is designed to move the cantilever over time.

Initialisation parameters:

• pushed = True|False push the output buffer immediately if True

Initialisation Commands:

• Place(x=float,y=float,z=float) = Place the scanner at a given location.
• Move(x=float,y=float,z=float, v=float) = Move the scanner by a give vector at a given speed.
• MoveTo(x=float,y=float,z=float, v=float) = Move the scanner to a given postion at a given speed.
• MoveRecord(x=float,y=float,z=float, v=float, points=integer) = same as Move command except will only record a set number of points
• Direction(x=integer,y=integer,z=integer) = Set the direction of the fast scan using a tyical unit vector format.
• ScanArea() = Start the auto scan (this should be set up as shown in the tutorials)

Variables

• Recorder = output circuit to be used with the ScanArea function
• BlankLines True|False = To dictate if it will include blank lines in the output file, so the file will work with gnuplots pm3d.
• Resolution = A vector of the scan resoloution eg: [30,60] woudl mean 30 lines in slow direction and 60 in fast direction

Output channels:

• x = x coordinate value.
• y = y coordinate value.
• z = z coordinate value.
• record = Will output 1 when the scanner wants to output a value.

Examples:

scanner = machine.AddCircuit(type='Scanner',name='scan', pushed=True )
scanner.Place(x=0,y=0,z=0)
scanner.MoveTo(x=1,y=1,z=1,v=1)

Inherits Circuit.

Public Member Functions
def	FastScan (self, direction)
	Used to set the fast scan direction.
def	SlowScan (self, direction)
	Used to set the slow scan direction.
def	Direction (self, kw)
	Set fast and/or slow scan directions.
def	ImageArea (self, fast, slow)
	Set the size of the image along the fast and slow scan directions.

Public Attributes
	ImageSize
	Size of the image along fast and slow scan directions.
	Resolution
	Resolution of the image.
	FastSpeed
	Fastscan speed.
	SlowSpeed
	Slowscan speed.
	Recorder
	Reference to the dedicated output circuit.
	BlankLines
	Insert blank line in the dedicated output.
Public Attributes inherited from Circuit
	name
	Name of the circuit. More...
	enabled
	if it is working... More...
	machine
	Reference to the virtual machine to which this circuit belongs. More...
	pushed
	Push output buffer at the end of Update. More...
	I
	Dictionary of input channels.
	O
	Dictionary of output channels.
	cCoreID
	index of circuit in cCore