Thorlabs Motorized Filter Flip Mount (MFF10X)¶
Driver for controlling Thorlabs Flipper Filters using the Kinesis SDK.
One must place Thorlabs.MotionControl.DeviceManager.dll and Thorlabs.MotionControl.FilterFlipper.dll in the path
-
exception
instrumental.drivers.motion.filter_flipper.
FilterFlipperError
¶
-
class
instrumental.drivers.motion.filter_flipper.
Filter_Flipper
(serial, polling_period='200ms')¶ Driver for controlling Thorlabs Filter Flippers
Takes the serial number of the device as a string.
The polling period, which is how often the device updates its status, is passed as a pint quantity with units of time and is optional argument, with a default of 200ms
-
__init__
(serial, polling_period='200ms')¶ Parameters: - serial_number (str) –
- polling_period (pint quantity with units of time) –
-
close
()¶
-
flip
()¶ Flips the position of the filter.
-
get_position
()¶ Get the position of the flipper.
Returns an instance of Position. Note that this represents the position at the most recent polling event.
-
get_transit_time
()¶ Returns the transit time.
The transit time is the time to transition from one filter position to the next.
-
home
()¶ Homes the device
-
isValidPosition
(position)¶ Indicates if it is possible to move to the given position.
Parameters: position (instance of Position) –
-
move_and_wait
(position, delay='100ms')¶ Moves to the indicated position and waits until that position is reached.
Parameters: - position (instance of Position) – should not be ‘Position.moving’
- delay (pint quantity with units of time) – the period with which the position of the flipper is checked.
-
move_to
(position)¶ Moves the flipper to the indicated position.
Returns immediatley.
Parameters: position (instance of Position) – should not be ‘Position.moving’
-
set_transit_time
(transit_time='500ms')¶ Sets the transit time. The transit time is the time to transition from one filter position to the next.
Parameters: transit_time (pint quantity with units of time) –
-
-
class
instrumental.drivers.motion.filter_flipper.
Position
¶ The position of the flipper.
-
moving
= 0¶
-
one
= 1¶
-
two
= 2¶
-
-
instrumental.drivers.motion.filter_flipper.
list_instruments
()¶