Detector

class hcipy.optics.Detector(detector_grid, subsamping=1)

Bases: object

Base class for a detector.

Parameters

detector_gridGrid

The grid on which the detector returns its images. These indicate the centers of the pixels.

subsampinginteger or scalar or ndarray

The number of subpixels per pixel along one axis. For example, a value of 2 indicates that 2x2=4 subpixels are used per pixel. If this is a scalar, it will be rounded to the nearest integer. If this is an array, the subsampling factor will be different for each dimension. Default: 1.

Attributes

input_gridGrid

The grid that is expected as input.

Methods Summary

__call__(wavefront[, dt, weight])	Integrate and read out the detector.
integrate(wavefront, dt[, weight])	Integrates the detector.
read_out()	Reads out the detector.

Methods Documentation

__call__(wavefront, dt=1, weight=1)

Integrate and read out the detector.

This is a convenience function to avoid having to call two functions in quick succession.

Parameters

wavefrontWavefront or array_like

The wavefront sets the amount of power generated per unit time.

dtscalar

The integration time in units of time.

weightscalar

Weight of every unit of integration time.

Returns

Field

The final detector image.

integrate(wavefront, dt, weight=1)

Integrates the detector.

Parameters

wavefrontWavefront or array_like

The wavefront sets the amount of power generated per unit time.

dtscalar

The integration time in units of time.

weightscalar

Weight of every unit of integration time.

read_out()

Reads out the detector.

No noise will be added to the image.

Returns

Field

The final detector image.