LightModulator

Class Arguments

The class does not take any arguments

Inheritance Diagram

Example Component Dictionary

   {
    "lightmodulator_example": {
        "classname": "atomiq.components.optoelectronics.lightmodulator.LightModulator",
        "arguments": {}
    }
}

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.compiler.types.TMono('float', OrderedDict())) -- Frequency in Hz by which the light is shifted.

set_amplitude(amplitude)

Set the amplitude of the light after the modulator

Parameters:

amplitude (artiq.compiler.types.TMono('float', OrderedDict())) -- 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.compiler.types.TMono('float', OrderedDict())) -- Phase shift in radians

set_polarisation(angle)

Set the polarization rotation imposed by the modulator

Parameters:

angle (artiq.compiler.types.TMono('float', OrderedDict())) -- Rotation angle in radians