finesse.detectors.camera.FieldScanLine
¶
Overview
- class finesse.detectors.camera.FieldScanLine(name, node, npts, x=None, y=None, xlim=None, ylim=None, f=0, w0_scaled=True)[source]¶
Bases:
finesse.detectors.camera.ComplexCamera
,finesse.detectors.camera.ScanLine
Camera for detecting a slice of the beam in terms of amplitude and phase.
The
ScanLine.direction
(i.e. axis of slice) is determined from which of xlim or ylim is specified.Get the unscaled x and y coordinate data via
ScanLine.xdata
andScanLine.ydata
, respectively.- Parameters
name : str
Unique name of the camera.
node :
OpticalNode
Node at which to detect.
npts : int
Number of points in slice axis.
x : scalar or None; default: None
The x coordinate of the slice. If ylim is given and this is not specified then defaults to zero. If xlim is given and this is also specified then it is ignored.
y : scalar or None; default: None
The y coordinate of the slice. If xlim is given and this is not specified then defaults to zero. If ylim is given and this is also specified then it is ignored.
xlim : scalar or size two sequence; default: None
The limits of the x-axis scan lines. A single number gives \(x_{\mathrm{axis}} \in [-|x|, +|x|]\), or a tuple of size two gives \(x_{\mathrm{axis}} \in [x[0], x[1]]\).
ylim : scalar or array-like; default: None
The limits of the y-axis scan lines. A single number gives \(y_{\mathrm{axis}} \in [-|y|, +|y|]\), or a tuple of size two gives \(y_{\mathrm{axis}} \in [y[0], y[1]]\).
f : scalar, optional; default: 0
Field frequency offset from the carrier to detect.
w0_scaled : bool, optional; default: True
Flag indicating whether the \(x\), \(y\) axes should be scaled to the waist-size of the beam parameter at node.
Properties
Number of pixels in the scanning axis. |