finesse.model.Model.modes

Model.modes(modes=None, maxtem=None, include=None, remove=None)[source]

Select the HOM indices to include in the model.

See Selecting the modes to model for examples on using this method.

Parameters:
modessequence, str, optional; default: None

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 “off”, “even”, “odd”, “tangential” (or “x”) or “sagittal” (or “y”).

maxtemint, optional; default: None

Optional maximum mode order.

includesequence, str, optional

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

removesequence, str, optional

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

See also

Model.include_modes

Insert mode indices into Model.homs at the correct (sorted) positions.

Model.remove_modes

Remove mode index pairs from the model.

Examples

See Selecting the modes to model.