finesse.detectors.map_detector module

Single-frequency array of complex amplitudes detector.

class finesse.detectors.map_detector.MapAmplitudeDetector(*args, **kwargs)

Bases: MapDetector

Outputs the amplitude of a Map object.

Parameters

namestr

The name of the detector.

map_objectMap

The Map object from which the optical path difference is derived. This should be a string of the form “element.map” attribute. e.g. “ITM.surface_map”.

x_sliceslice, optional

The slice object to apply on the x-axis of the map. Default is None.

y_sliceslice, optional

The slice object to apply on the y-axis of the map. Default is None.

Methods

_get_workspace(sim)

Creates and returns a workspace for the detector, updating the data type shape based on the map object’s optical path difference.

class finesse.detectors.map_detector.MapAmplitudeDetectorWorkspace(owner, sim, map_object)

Bases: MapDetectorWorkspace

class finesse.detectors.map_detector.MapDetector(*args, **kwargs)

Bases: Detector, ABC

class finesse.detectors.map_detector.MapDetectorWorkspace(owner, sim, map_object)

Bases: DetectorWorkspace, ABC

class finesse.detectors.map_detector.MapOPDDetector(*args, **kwargs)

Bases: MapDetector

Outputs the optical path difference of a Map object.

Parameters

namestr

The name of the detector.

map_objectMap

The Map object from which the optical path difference is derived. This should be a string of the form “element.map” attribute. e.g. “ITM.surface_map”.

x_sliceslice, optional

The slice object to apply on the x-axis of the map. Default is None.

y_sliceslice, optional

The slice object to apply on the y-axis of the map. Default is None.

Methods

_get_workspace(sim)

Creates and returns a workspace for the detector, updating the data type shape based on the map object’s optical path difference.

class finesse.detectors.map_detector.MapOPDDetectorWorkspace(owner, sim, map_object)

Bases: MapDetectorWorkspace