finesse.components.modulator.Modulator
¶
Overview
- class finesse.components.modulator.Modulator(name, f, midx, order=1, mod_type=ModulatorType.pm, phase=0.0, positive_only=False)[source]¶
Bases:
Connector
,FrequencyGenerator
Represents a modulator optical component with associated properties such as modulation frequency, index and order.
- Parameters:
- namestr
Name of newly created modulator.
- ffloat or
Frequency
, optional Frequency of the modulation (in Hz) or
Frequency
object.- midxfloat
Modulation index, >= 0.
- orderint, optional
Maximum order of modulations to produce. Must be 1 for amplitude modulation. Defaults to 1.
- mod_typestr, optional
Modulation type, either ‘am’ (amplitude modulation) or ‘pm’ (phase modulation). Defaults to ‘pm’.
- phasefloat, optional
Relative phase of modulation (in degrees). Defaults to 0.0.
- positive_onlybool, optional
If True, only produce positive-frequency sidebands. Defaults to False.
Properties
f : float or |
|
order : int, optional Maximum order of modulations to produce. |