finesse.detectors.camera.ScanLine

Overview

class finesse.detectors.camera.ScanLine(npts, dtype, x=None, y=None, xlim=None, ylim=None)

Bases: object

Data structure representation of a slice of an image.

Parameters:

xscalar or None

The x coordinate of the slice.

yscalar or None

The y coordinate of the slice.

xlimscalar or size two sequence

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]]\).

ylimscalar or array-like

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]]\).

nptsint

Number of points in slice axis.

dtypestr or dtype

Data type of the slice to pass to NumPy for array creation.

Properties

ScanLine.direction	The slice axis - i.e. 'x' for x-axis, 'y' for y-axis.
ScanLine.npts	Number of pixels in the scanning axis.
ScanLine.x	The x co-ordinate of the slice.
ScanLine.xdata	The numeric value(s) of the x coordinate.
ScanLine.xlim	The limits of the slice in the x-axis.
ScanLine.y	The y co-ordinate of the slice.
ScanLine.ydata	The numeric value(s) of the y coordinate.
ScanLine.ylim	The limits of the slice in the y-axis.