API Reference v9.1.0

FilterChangerclass

Module: zaber_motion.microscopy

A generic turret device.

The following examples illustrate how you can obtain an instance of this type:

Example 1

Example 2

from zaber_motion.ascii import Connection
from zaber_motion.microscopy import Microscope

connection = Connection.open_serial_port('COM3')
microscope = Microscope.find(connection)
filter_changer = microscope.filter_changer

from zaber_motion.ascii import Connection
from zaber_motion.microscopy import FilterChanger

connection = Connection.open_serial_port('COM3')
device = connection.get_device(1)
filter_changer = FilterChanger(device)

Related Guides:

Microscope

Index

pProperties

mMethods

get_current_filter()

get_number_of_filters()

Constructor

FilterChanger(device)

Creates instance of `FilterChanger` based on the given device.

Arguments

Name	Type	Description
device	`Device`	The base device of this turret.

Properties

p

device

readonly

filter_changer.device

Device The base device of this turret.

Methods

m

change()

async available

filter_changer.change(filter)

Changes to the specified filter.

Arguments

Name	Type	Description
filter	`int`	Filter number starting from 1.

m

get_current_filter()

async available

filter_changer.get_current_filter()

Returns the current filter number starting from 1. The value of 0 indicates that the position is either unknown or between two filters.

Return Value

int Filter number starting from 1 or 0 if the position cannot be determined.

m

get_number_of_filters()

async available

filter_changer.get_number_of_filters()

Gets number of filters of the changer.

Return Value

int Number of positions.

m

repr()

filter_changer.__repr__()

Returns a string that represents the device.

Return Value

str A string that represents the device.