lantz.drivers.prior

company:PRIOR Scientific
description:Microscope Automation & Custom Solutions
website:http://www.prior.com/

copyright:2015 by Lantz Authors, see AUTHORS for more details.
license:BSD, see LICENSE for more details.
class lantz.drivers.prior.NanoScanZ(resource_name, name=None, **kwargs)

Bases: lantz.messagebased.MessageBasedDriver

Driver for the NanoScanZ Nano Focusing Piezo Stage from Prior.

Parameters:
  • resource_name (str) – The resource name
  • kwargs – keyword arguments passed to the resource during initialization.
Params name:

easy to remember identifier given to the instance for logging purposes.

move_absolute_async(*args, **kwargs)

(Async) Move to absolute position n, range (0,100). This is a “real” absolute position and is independent of any relative offset added by the position Feat.

move_relative_async(*args, **kwargs)

(Async) Move the stage position relative to the current position by an amount determined by ‘value’. If value is given in micrometer, thats the amount the stage is going to move, in microns. If value is given in steps, the stage will move a distance value.magnitude * step. The step is defined by the step Feat

query(command, *, send_args=(None, None), recv_args=(None, None))

Send query to the stage and return the answer, after handling possible errors.

Parameters:command (string) – command to be sent to the instrument
zero_position_async(*args, **kwargs)

(Async) Move to zero including any position redefinitions done by the position Feat

DEFAULTS = {'ASRL': {'baud_rate': 9600, 'write_termination': '\n', 'timeout': 2000, 'parity': <Parity.none: 0>, 'bytesize': 8, 'encoding': 'ascii', 'stop_bits': <StopBits.one: 10>, 'read_termination': '\n'}}
DEFAULTS_changed
device_baudrate
Reports and sets the baud rate.
NOTE: DO NOT change the baud rate of the Piezo controller when daisy chained to ProScan.
Values:{38400, 19200, 9600}
device_baudrate_changed
idn

Identification of the device

idn_changed
move_absolute = functools.partial(<bound method Action.call of <lantz.action.Action object at 0x7f38049c9940>>, None)
move_absolute_changed
move_relative = functools.partial(<bound method Action.call of <lantz.action.Action object at 0x7f38049c9b00>>, None)
move_relative_changed
moving

Returns the movement status, 0 stationary, 4 moving

Values:{False: ‘00000’, True: ‘4’}
moving_changed
position
Gets and sets current position.
If the value is set to z = 0, the display changes to REL 0 (relative display mode). To return to ABS mode use inst.move_absolute(0) and then inst.position = 0. Thus, the stage will return to 0 micrometers and the display screen will switch to ABS mode.
Units:micrometer
position_changed
query_changed
software_version

Software version

software_version_changed
step

Report and set the default step size, in microns

Units:micrometer
step_changed
zero_position = functools.partial(<bound method Action.call of <lantz.action.Action object at 0x7f38049c98d0>>, None)
zero_position_changed