Common optical building blocks are provided for building up an optical system. Some have more detailed pages which are listed in the table of contents below.
Represents a directional beamsplitter optical component.
name: Name of newly created directional beamsplitter.
Represents a thin lens optical component with an associated focal length.
lens name f=inf
name: Name of newly created lens.
f: Focal length of the lens in metres; defaults to infinity.
Name Description Units Data type Can change during simualation f Focal length m float ✓
Represents a modulator optical component with associated properties such as modulation frequency, index and order.
mod name f midx order=1 mod_type=pm phase=0.0 positive_only=false
name: Name of newly created modulator.
midx: Modulation index, >= 0.
f: Frequency of the modulation (in Hz) or
order: Maximum order of modulations to produce. Must be 1 for amplitude modulation. Defaults to 1.
mod_type: Modulation type, either ‘am’ (amplitude modulation) or ‘pm’ (phase modulation). Defaults to ‘pm’.
phase: Relative phase of modulation (in degrees). Defaults to 0.0.
positive_only: If True, only produce positive-frequency sidebands. Defaults to False.
Name Description Units Data type Can change during simualation f Frequency Hz float ✓ midx Modulation index None float ✓ phase Phase degrees float ✓ order Maximum modulation order None int ✗ mod_type Modulation type ('am', 'pm') None int ✗ positive_only Positive only None bool ✗
An idealised optical bandpass filter that will transmit an optical frequency around some central frequency with a 3dB bandwidth.
obp name fc=0 bandwidth=1000 filter_hom=none
name: Name of element
fc: Central frequency
bandwidth: Filter 3dB bandwidth
filter_hom: Individual higher order modes can be filtered and transmitted by setting this to a tuple of (n, m). If
Nonethen no mode filtering is done. This cannot be changed during a simulation.
Name Description Units Data type Can change during simualation fc Central frequency Hz float ✓ bandwidth Bandpass bandwidth Hz float ✓