finesse.detectors.general.MaskedDetector

Overview

class finesse.detectors.general.MaskedDetector(*args, **kwargs)[source]

Bases: Detector, ABC

An abstract class from which detector types which can have mode masks derive.

Any detector object which calculates quantities involving loops over the modes of a model should inherit from this — allowing masks to be applied to mode patterns via the methods of this class. Examples of detectors which should derive from MaskedDetector are power-detectors, amplitude-detectors and cameras.

Properties

MaskedDetector.has_mask

Whether the detector has a mask applied to it.

MaskedDetector.mask

An array of HOMs to mask from the output.

Methods

MaskedDetector.__init__(*args, **kwargs)

MaskedDetector.add_to_mask(modes)

Inserts the specified mode indices into the detector mask.

MaskedDetector.remove_from_mask(modes)

Removes the specified mode indices from the detector mask.

MaskedDetector.select_mask([modes, maxtem, ...])

Select the HOM indices to include in the mask.