lantz.drivers.olympus

company:Olympus.
description:Research and clinical microscopes.
website:http://www.microscopy.olympus.eu/microscopes/

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

Bases: lantz.drivers.olympus.ixbx.IXBX

Olympus IX2 Body

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.

bottom_port_closed
Values:{False: ‘OUT’, True: ‘IN’}
bottom_port_closed_changed
camera_port_enabled
Values:{False: ‘2’, True: ‘1’}
camera_port_enabled_changed
condensor
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
condensor_changed
filter_wheel
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
filter_wheel_changed
mirror_unit
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
mirror_unit_changed
shutter1_closed
Values:{False: ‘OUT’, True: ‘IN’}
shutter1_closed_changed
shutter2_closed
Values:{False: ‘OUT’, True: ‘IN’}
shutter2_closed_changed
class lantz.drivers.olympus.BX2A(resource_name, name=None, **kwargs)

Bases: lantz.drivers.olympus.ixbx.IXBX

Olympus BX2A Body

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.

aperture_stop_diameter
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
aperture_stop_diameter_changed
condenser_top_lens_enabled
Values:{False: ‘OUT’, True: ‘IN’}
condenser_top_lens_enabled_changed
configure_filterwheel
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
configure_filterwheel_changed
cube
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
cube_changed
shutter_closed
Values:{False: ‘OUT’, True: ‘IN’}
shutter_closed_changed
turret
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
turret_changed
class lantz.drivers.olympus.IXBX(resource_name, name=None, **kwargs)

Bases: lantz.messagebased.MessageBasedDriver

IX or BX Olympus microscope body.

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.

init_origin()

Init origin

initialize()
lamp_status()
move_relative_async(*args, **kwargs)
query(command, *, send_args=(None, None), recv_args=(None, None))

Query the instrument and parse the response.

Raises:InstrumentError
stop()

Stop any currently executing motion

DEFAULTS = {'ASRL': {'write_termination': '\r\n', 'bytesize': 8, 'stop_bits': <StopBits.one: 10>, 'read_termination': '\r\n', 'parity': <Parity.even: 2>, 'baud_rate': 19200, 'encoding': 'ascii'}}
DEFAULTS_changed
body_locked
Values:{False: ‘OFF’, True: ‘ON’}
body_locked_changed
fluo_shutter
Values:{False: ‘0’, True: ‘1’}
fluo_shutter_changed
focus_locked
Values:{False: ‘OFF’, True: ‘ON’}
focus_locked_changed
idn

Microscope identification

idn_changed
init_origin_changed
initialize_changed
jog_dial
Values:{False: ‘FRM’, True: ‘FH’}
jog_dial_changed
jog_enabled
Values:{False: ‘OFF’, True: ‘ON’}
jog_enabled_changed
jog_limit_enabled
Values:{False: ‘OFF’, True: ‘ON’}
jog_limit_enabled_changed
jog_sensitivity
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
jog_sensitivity_changed
lamp_enabled
Values:{False: ‘OFF’, True: ‘ON’}
lamp_enabled_changed
lamp_epi_enabled
Values:{False: ‘DIA’, True: ‘EPI’}
lamp_epi_enabled_changed
lamp_intensity
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
lamp_intensity_changed
lamp_status_changed
move_relative = functools.partial(<bound method Action.call of <lantz.action.Action object at 0x7f11128ce668>>, None)
move_relative_changed
move_to_start_enabled
Values:{False: ‘OFF’, True: ‘ON’}
move_to_start_enabled_changed
movement_status
movement_status_changed
objective
Get procs:
  • <class ‘int’>:set procs: - <class ‘str’>
objective_changed
query_changed
soft_limits
Units:(<Quantity(0.01, ‘micrometer’)>, <Quantity(0.01, ‘micrometer’)>)
soft_limits_changed
stop_changed
z

Position of the objective.

Units:0.01 micrometer
z_changed