Commands¶

Commands set some properties of the model or its elements. Some commands may only be specified once per model, others multiple times.

fsig¶

Signal input frequency.

Syntax: fsig(f)
Required: f: The frequency.

lambda¶

Reference wavelength.

Syntax: lambda(lambda0)
Required: lambda0: The reference wavelength.

modes¶

Select the HOM indices to include in the model.

Syntax

modes(modes=none, maxtem=none, include=none, remove=none)

Optional

modes: Identifier for the mode indices to generate. This can be: - An iterable of mode indices, where each element in the iterable must unpack to two integer convertible values. - A string identifying the type of modes to include, must be one of “even”, “odd”, “tangential” (or “x”) or “sagittal” (or “y”).

maxtem: Optional maximum mode order.

include: A single mode index pair, or an iterable of mode indices, to include. Each element must unpack to two integer convertible values.

remove: A single mode index pair, or an iterable of mode indices, to remove. Each element must unpack to two integer convertible values.

link¶

Syntax: link({arg1{, arg2{, ...}}}, {kwarg1=value{, kwarg2=value{, ...}}})
See Also: space

intrix¶

Set input matrix.

Syntax: intrix({arg1{, arg2{, ...}}}, {kwarg1=value{, kwarg2=value{, ...}}})

tem¶

Set laser TEM.

Syntax: tem(laser, {arg1{, arg2{, ...}}}, {kwarg1=value{, kwarg2=value{, ...}}})