finesse.detectors.general.Detector

Overview

class finesse.detectors.general.Detector(name, node=None, dtype=<class 'numpy.complex128'>, shape=(), unit='arb.', label=None, needs_fields=True, needs_trace=False)

Bases: abc.ABC, finesse.element.ModelElement

Abstract representation of a component that produces a numerical output.

User detector classes should subclass this class. The simulation will then generate a dictionary of output values.

Parameters

name : str

Name of newly created detector.

node : Node

Node to read output from.

dtype : type, optional

The numpy datatype for which this output result will be stored in.

unit : str, optional

A human readable unit for the output. E.g. W, m, m/rtHz.

Properties

Detector.dtype
Detector.dtype_shape
Detector.dtype_size	Size of the output in terms of number of elements.
Detector.label
Detector.needs_fields	Flag indicating whether the detector requires light fields (i.e.
Detector.needs_trace	Flag indicating whether the detector requires beam traces.
Detector.node	The nodes this detector observes.
Detector.output_information
Detector.unit