Shutter

Class Arguments

Argument	Type	Default Value
switch	Switchable
invert	TBool	False
opening_time	TFloat	0
closing_time	TFloat	0

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Example Component Dictionary

   {
    "lightmodulator_example": {
        "classname": "atomiq.components.optoelectronics.lightmodulator.Shutter",
        "arguments": {
            "switch": "<mandatory parameter (Switchable)>",
            "invert": false,
            "opening_time": 0,
            "closing_time": 0
        }
    }
}

Class Description

class atomiq.components.optoelectronics.lightmodulator.Shutter(switch, invert=False, opening_time=0, closing_time=0, *args, **kwargs)

Bases: Component, Switchable

Component to switch light on or off depending on a logical signal. This could be a mechanical shutter or a binary only amplitude modulator (e.g. AOM, EOM, Pockels cell etc.). It requires a class:Switchable switch that operates the shutter

Parameters:

• switch (Switchable) -- Switch that operates the shutter, e.g. TTL

• invert (TBool) -- invert the logic of on and off

• opening_time (TFloat) -- Time in s it takes from the arrival of the TTL until the shutter is fully opened (default 0)

• closing_time (TFloat) -- Time in s it takes from the arrival of the TTL until the shutter is completely closed (default 0). Note that if closing_time is > 0 the shutter is already closing before the time at which the off() method is called

A Switchable has one ore more channel(s) that can be switched on or off

on()

Opens the shutter. The time cursor is moved back in time to accommodate the opening_time of the shutter. After executing the on (or off if inverted) method of the defined switch the time cursor is then forwarded by opening_time again. The time cursor advancement is therefore given by the switch.on() or switch.off() method.

off()

Closes the shutter. The time cursor is moved back in time to accommodate the closing_time of the shutter. After executing the off (or on if inverted) method of the defined switch the time cursor is then forwarded by closing_time again. The time cursor advancement is therefore given by the switch.on() or switch.off() method.