lsst.meas.algorithms  21.0.0-10-gbfb87ad6+c829c04f60
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.installGaussianPsf.InstallGaussianPsfTask Class Reference

Install a Gaussian PSF model in an exposure. More...

Inheritance diagram for lsst.meas.algorithms.installGaussianPsf.InstallGaussianPsfTask:

Public Member Functions

def run (self, exposure)
 Set exposure's PSF to a simple PSF model. More...
 

Static Public Attributes

 ConfigClass = InstallGaussianPsfConfig
 

Detailed Description

Install a Gaussian PSF model in an exposure.

@anchor InstallGaussianPsfTask_

@section pipe_tasks_installGaussianPsf_Contents  Contents

 - @ref pipe_tasks_installGaussianPsf_Purpose
 - @ref pipe_tasks_installGaussianPsf_Initialize
 - @ref pipe_tasks_installGaussianPsf_IO
 - @ref pipe_tasks_installGaussianPsf_Config
 - @ref pipe_tasks_installGaussianPsf_Metadata
 - @ref pipe_tasks_installGaussianPsf_Debug
 - @ref pipe_tasks_installGaussianPsf_Example

@section pipe_tasks_installGaussianPsf_Purpose  Description

Install a Gaussian PSF model in an exposure.
If the exposure already has a PSF model then the new model
has the same sigma and size (width and height in pixels) of the existing model.
If the exposure does not have a PSF model then the PSF sigma and size
are taken from the config.

At present the produced model is always circularly symmetric, but it is planned
to change this to an elliptical PSF model (only for the case that the exposure
already has a PSF model), once the necessary PSF object is available.

A variant of this task may someday exist to estimate the PSF
from the pixel data if no PSF model is present.

@section pipe_tasks_installGaussianPsf_Initialize  Task initialisation

@copydoc \_\_init\_\_

@section pipe_tasks_installGaussianPsf_IO  Invoking the Task

The main method is `run`.

@section pipe_tasks_installGaussianPsf_Config  Configuration parameters

See @ref InstallGaussianPsfConfig

@section pipe_tasks_installGaussianPsf_Debug  Debug variables

This task has no debug display

@section pipe_tasks_installGaussianPsf_Example  A complete example of using InstallGaussianPsfTask

    from lsst.afw.image import ExposureF
    from lsst.meas.algorithms.installGaussianPsf import InstallGaussianPsfTask, FwhmPerSigma

    exposure = ExposureF(100, 100)
    task = InstallGaussianPsfTask()
    task.run(exposure=exposure)

    # This particular exposure had no PSF model to begin with, so the new PSF model
    # uses the config's FWHM. However, measured FWHM is based on the truncated
    # PSF image, so it does not exactly match the input
    measFwhm = exposure.getPsf().computeShape().getDeterminantRadius() * FwhmPerSigma
    assert abs(measFwhm - task.config.fwhm) < 1e-3

Definition at line 61 of file installGaussianPsf.py.

Member Function Documentation

◆ run()

def lsst.meas.algorithms.installGaussianPsf.InstallGaussianPsfTask.run (   self,
  exposure 
)

Set exposure's PSF to a simple PSF model.

    The sigma and width of the new simple PSF model matches the sigma and width of the current model,
    if any, else the config parameters are used.

    @param[in,out] exposure  exposure to which to replace or add the PSF model

Definition at line 125 of file installGaussianPsf.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.installGaussianPsf.InstallGaussianPsfTask.ConfigClass = InstallGaussianPsfConfig
static

Definition at line 122 of file installGaussianPsf.py.


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