finesse.detectors.general.Detector
¶
Overview
- class finesse.detectors.general.Detector(name, *args, **kwargs)[source]¶
Bases:
ABC
,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
- namestr
Name of newly created detector.
- node
Node
orPort
Node to read output from. If a port is given, it must have one node, so that is is unambiguous which node to use.
- dtypetype, optional
The numpy datatype for which this output result will be stored in.
- unitstr, optional
A human readable unit for the output. E.g. W, m, m/rtHz.
Properties
Size of the output in terms of number of elements. |
|
Flag indicating whether the detector requires light fields (i.e. |
|
Flag indicating whether the detector requires beam traces. |
|
The nodes this detector observes. |
|