finesse.detectors.mismatch_detector module

Detectors for calculating mode mismatches in an optical configuration.

class finesse.detectors.mismatch_detector.ModeMismatchDetector(*args, **kwargs)

Bases: Detector

Detector for mode mismatch figure-of-merit for a specified node coupling.

The computed quantity is given in finesse.gaussian.BeamParam.mismatch() where \(q_1\) is the input beam parameter at node1 propagated via the associated ABCD matrix to node2, and \(q_2\) is the beam parameter at node2.

As mode mismatches cannot occur over spaces in Finesse, node1 must be an input node and node2 must be an output node.

Parameters

namestr

Name of the detector.

node1OpticalNode or Port

Input node or port. If a Port instance is given then this node will be the input node of that port. Note that this node cannot be an output node.

node2OpticalNode or Port

Output node or port. If a Port instance is given then this node will be the output node of that port. Note that this node cannot be an input node.

directionstr, optional; default: “x”

Plane of computation, defaults to “x” for the tangential plane. Changing to “y” will compute the mode mismatch in the sagittal plane.

percentbool, optional; default: True

Whether to calculate the mode mismatch as a fraction (default behaviour) or a percentage.

property component

The component at which the mode mismatch is calculated.

Getter:

Returns the associated component (read-only).

property direction

The plane in which the mode mismatch is calculated.

A value of “x” represents the tangential plane, whilst “y” gives the sagittal plane.

Getter:

Returns the plane of computation as a string representation (read-only).

property in_node

Input node.

Getter:

Returns the input node (read-only).

property in_percent

Flag indicating whether the mismatch is computed as a percentage.

Getter:

Returns the percentage flag.

Setter:

Sets the percentage flag.

property needs_fields

Flag indicating whether the detector requires light fields (i.e. solving of the interferometer matrix).

property needs_trace

Flag indicating whether the detector requires beam traces.

property out_node

Output node.

Getter:

Returns the output node (read-only).