finesse.components.modulator.Modulator

Overview

class finesse.components.modulator.Modulator(name, f, midx, order=1, mod_type='pm', phase=0, positive_only=False)[source]

Bases: finesse.components.general.Connector, finesse.components.general.FrequencyGenerator

Represents a modulator optical component with associated properties such as modulation frequency, index and order.

Parameters

name : str

Name of newly created modulator.

f : float or Frequency, optional

Frequency of the modulation (in Hz) or Frequency object.

midx : float

Modulation index, >= 0.

order : int, optional

Maximum order of modulations to produce. Must be 1 for amplitude modulation. Defaults to 1.

mod_type : str, optional

Modulation type, either ‘am’ (amplitude modulation) or ‘pm’ (phase modulation). Defaults to ‘pm’.

phase : float, optional

Relative phase of modulation (in degrees). Defaults to 0.

positive_only : bool, optional

If True, only produce positive-frequency sidebands. Defaults to False.

Properties

Modulator.f

Descriptor class for declaring a simulation parameter.

Modulator.order

Descriptor class for declaring a simulation parameter.