lsst.scarlet.lite gee10cc3b42+772f6ae910
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
lsst.scarlet.lite.models.fit_psf.FittedPsfObservation Class Reference
Inheritance diagram for lsst.scarlet.lite.models.fit_psf.FittedPsfObservation:
lsst.scarlet.lite.observation.Observation

Public Member Functions

 __init__ (self, np.ndarray|Image images, np.ndarray|Image variance, np.ndarray|Image weights, np.ndarray psfs, np.ndarray|None model_psf=None, np.ndarray|None noise_rms=None, Box|None bbox=None, tuple|None bands=None, int padding=3, str convolution_mode="fft")
 
np.ndarray grad_fit_kernel (self, np.ndarray input_grad, np.ndarray kernel, np.ndarray model_fft)
 
np.ndarray prox_kernel (self, np.ndarray kernel)
 
np.ndarray fitted_kernel (self)
 
 cached_kernel (self)
 
Image convolve (self, Image image, str|None mode=None, bool grad=False)
 
 update (self, int it, np.ndarray input_grad, Image model)
 
None parameterize (self, Callable parameterization)
 
- Public Member Functions inherited from lsst.scarlet.lite.observation.Observation
tuple bands (self)
 
Box bbox (self)
 
float log_likelihood (self, Image model)
 
tuple[int, int, int] shape (self)
 
int n_bands (self)
 
npt.DTypeLike dtype (self)
 
tuple[int, int, int, int] convolution_bounds (self)
 

Public Attributes

 axes
 
 fft_shape
 
- Public Attributes inherited from lsst.scarlet.lite.observation.Observation
 images
 
 variance
 
 weights
 
 psfs
 
 mode
 
 noise_rms
 
 model_psf
 
 padding
 
 diff_kernel
 
 grad_kernel
 

Protected Attributes

 _fitted_kernel
 
- Protected Attributes inherited from lsst.scarlet.lite.observation.Observation
 _convolution_bounds
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst.scarlet.lite.observation.Observation
Observation empty (tuple[Any] bands, np.ndarray psfs, np.ndarray model_psf, Box bbox, npt.DTypeLike dtype)
 

Detailed Description

An observation that fits the PSF used to convolve the model.

Constructor & Destructor Documentation

◆ __init__()

lsst.scarlet.lite.models.fit_psf.FittedPsfObservation.__init__ ( self,
np.ndarray | Image images,
np.ndarray | Image variance,
np.ndarray | Image weights,
np.ndarray psfs,
np.ndarray | None model_psf = None,
np.ndarray | None noise_rms = None,
Box | None bbox = None,
tuple | None bands = None,
int padding = 3,
str convolution_mode = "fft" )
Initialize a `FitPsfObservation`

See `Observation` for a description of the parameters.

Reimplemented from lsst.scarlet.lite.observation.Observation.

Member Function Documentation

◆ convolve()

Image lsst.scarlet.lite.models.fit_psf.FittedPsfObservation.convolve ( self,
Image image,
str | None mode = None,
bool grad = False )
Convolve the model into the observed seeing in each band.

Parameters
----------
image:
    The image to convolve
mode:
    The convolution mode to use.
    This should be "real" or "fft" or `None`,
    where `None` will use the default `convolution_mode`
    specified during init.
grad:
    Whether this is a backward gradient convolution
    (`grad==True`) or a pure convolution with the PSF.

Reimplemented from lsst.scarlet.lite.observation.Observation.

◆ parameterize()

None lsst.scarlet.lite.models.fit_psf.FittedPsfObservation.parameterize ( self,
Callable parameterization )
Convert the component parameter arrays into Parameter instances

Parameters
----------
parameterization: Callable
    A function to use to convert parameters of a given type into
    a `Parameter` in place. It should take a single argument that
    is the `Component` or `Source` that is to be parameterized.

The documentation for this class was generated from the following file: