Detector¶
-
class
scampy.Detector.
Detector
(name, node, properties)¶ A detector for logging electric field amplitude and related properties.
An instance of the
Detector
class is created for each detector added to a model. The detector will log at least the electric field amplitude at the specified node, and optionally calculate other properties. Detectors can currently monitor:- amplitude - the amplitudes of the forward and backward
propagating S and P polarised electric fields.
- intensity - the total intensity of light passing through the
detector, including both polarisations propagating in both directions.
- S intensity - the intensity of S polarised light passing
through the detector in both directions.
- P intensity - the intensity of P polarised light passing
through the detector in both directions.
Note that calculated intensity is proportional to both the amplitude and the dielectric properties of the medium; the intensity for a detector is only directly comparable to other intensities calculated in the same medium.
- Attributes
- namestr
Unique name of the detector.
- nodestr
Node to be monitored by detector.
- propertiestuple of str
Optical properties to be logged - see description for current options.
- node_indexint
Index of the node the detector is to monitor in the solution vector.
Methods
update
(self, solution_vector)Update the detected values from solution vector.
-
update
(self, solution_vector)¶ Update the detected values from solution vector.
- Parameters
- solution_vectorndarray
solution to network matrix equation.