LightModulator

Class Arguments

Argument	Type	Default Value
debug_output	TBool	False

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.LightModulator",
        "arguments": {
            "debug_output": false
        }
    }
}

Class Description

class atomiq.components.optoelectronics.lightmodulator.LightModulator(*args, **kwargs)

Bases: Component, Parametrizable

An abstract light modulator for frequency, amplitude, phase, polarisation

This class serves as a base class for all kinds of electro-optic devices that can change the properties of light.

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

set_frequency(frequency)

Set the frequency by which the light is shifted.

Parameters:

frequency (artiq.language.types.TFloat) -- Frequency in Hz by which the light is shifted.

get_frequency()

Return type:

artiq.language.types.TFloat

set_amplitude(amplitude)

Set the amplitude of the light after the modulator

Parameters:

amplitude (artiq.language.types.TFloat) -- Relative amplitude [0 .. 1] of the light after the modulator

set_phase(phase)

Set the phase shift of the light imposed by the modulator

Parameters:

phase (artiq.language.types.TFloat) -- Phase shift in radians

set_polarisation(angle)

Set the polarization rotation imposed by the modulator

Parameters:

angle (artiq.language.types.TFloat) -- Rotation angle in radians

set_parameter(value, channel=None)

Parameters:

• value (artiq.language.types.TFloat)

• channel (artiq.language.types.TStr)