ArrayPSF

class scarlet2.ArrayPSF(morphology: Array)

Bases: PSF

PSF defined by an image array

Warning

The number of pixels in morphology should be odd, and the centroid of the PSF image should be in the central pixel. If that is not the case, one creates an effective shift by the PSF, which is not captured by the coordinate convention of the frame, e.g. its wcs.

See #96 from more details.

__call__()

Evaluate PSF

Returns:

2D image, normalized to total flux=1

Return type:

array

get(name=None)

Get parameter(s) from this module

Parameters:

name (str, optional) – Name of parameter. If not set, returns all parameters.

Returns:

requested data arrays for parameters

Return type:

dict

morphology: Array

The PSF morphology image. Can be 2D (height, width) or 3D (channel, height, width)

property parameters

Parameters defined for this module

Returns:

name: (node, param) mapping for all parameters

Return type:

dict

set(values)

Set parameter(s) from this module with values

Parameters:

values (dict[str,jnp.array]) – values to replace parameters with, identified by their name

Returns:

new module with parameter(s) replaced by values

Return type:

Module

property shape

Shape of the PSF model