finesse.detectors.camera.Image.at

Image.at(x=None, y=None)

Retrieves a slice or single pixel of the output image.

Parameters

x : scalar, optional

Value indicating where to take a y-slice of the image or, if used in conjunction with y, which pixel to return. Defaults to None.

y : scalar, optional

Value indicating where to take a x-slice of the image or, if used in conjunction with x, which pixel to return. Defaults to None.

magnitude : bool, optional

Returns the amplitude of the detected field if True. Otherwise returns the full complex description.

Returns

out : numpy.ndarray or float

Either a slice of the image or a single pixel at the specified co-ordinates.