finesse.detectors.camera.Camera

Overview

class finesse.detectors.camera.Camera(name, node, w0_scaled, dtype, shape, **kwargs)

Bases: finesse.detectors.general.MaskedDetector, abc.ABC

Base camera class.

Parameters

name : str

Unique name of the camera.

node : OpticalNode

Node at which to detect.

w0_scaled : bool

Flag indicating whether the \(x\), \(y\) axes should be scaled to the waist-size of the beam parameter at node.

dtype : numpy.dtype or str

The data-type of the pixels.

shape : tuple

Dimensions of the camera image.

Properties

Camera.needs_trace	Flag indicating whether the detector requires beam traces.
Camera.scaled_xdata	Coordinate data in the x-axis scaled to metres.
Camera.scaled_ydata	Coordinate data in the y-axis scaled to metres.
Camera.w0_scaled	Flag for whether the x and y co-ordinates have been scaled by the waist-size of the beam parameter at the detection node.