finesse.detectors.camera.Image

Overview

class finesse.detectors.camera.Image(xlim, ylim, npts, dtype)

Bases: object

Data structure representation of an image.

Parameters

xlimsequence or scalar

Limits of the x-dimension of the image. If a single number is given then this will be computed as \(x_{\mathrm{lim}} = [-|x|, +|x|]\).

ylimsequence or scalar

Limits of the y-dimension of the image. If a single number is given then this will be computed as \(y_{\mathrm{lim}} = [-|y|, +|y|]\).

nptsint

Number of points for both the x and y axes.

dtypestr or dtype

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

Properties

Image.npts	Number of pixels in each axis.
Image.resolution	The resolution of the image.
Image.xdata	The array of data points for the x-axis.
Image.xlim	The limits of the x coordinate data.
Image.ydata	The array of data points for the y-axis.
Image.ylim	The limits of the y coordinate data.

Methods

Image.__init__(xlim, ylim, npts, dtype)
Image.at([x, y])	Retrieves a slice or single pixel of the output image.