lsst.meas.algorithms  20.0.0-6-g01203fff+f7be93c67b
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask Class Reference

Base class for PSF determiners. More...

Inheritance diagram for lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask:
lsst.meas.algorithms.pcaPsfDeterminer.PcaPsfDeterminerTask

Public Member Functions

def __init__ (self, config, schema=None, **kwds)
 
def determinePsf (self, exposure, psfCandidateList, metadata=None)
 

Static Public Attributes

bool usesMatches = False
 
 ConfigClass = BasePsfDeterminerConfig
 

Detailed Description

Base class for PSF determiners.

Register all PSF determiners with the psfDeterminerRegistry using: psfDeterminerRegistry.register(name, class)

Definition at line 54 of file psfDeterminer.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask.__init__ (   self,
  config,
  schema = None,
**  kwds 
)
Construct a PSF Determiner

@param[in]       config   an instance of pexConfig.Config that configures this algorithm
@param[in,out]   schema   an instance of afw.table.Schema used for sources; passing a
                  schema allows the determiner to reserve a flag field to mark stars
                  used in PSF measurement, but some PSF determiners ignore this argument

Definition at line 65 of file psfDeterminer.py.

Member Function Documentation

◆ determinePsf()

def lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask.determinePsf (   self,
  exposure,
  psfCandidateList,
  metadata = None 
)
Determine a PSF model

@param[in] exposure            exposure containing the psf candidates (lsst.afw.image.Exposure)
@param[in] psfCandidateList:   a sequence of PSF candidates (each an
                       lsst.meas.algorithms.PsfCandidate); typically obtained by
                       detecting sources and then running them through a star selector
@param[in,out] metadata        a place to save interesting items

@return
    - psf: the fit PSF; a subclass of lsst.afw.detection.Psf
    - cellSet: the spatial cell set used to determine the PSF (lsst.afw.math.SpatialCellSet)

Definition at line 76 of file psfDeterminer.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask.ConfigClass = BasePsfDeterminerConfig
static

Definition at line 62 of file psfDeterminer.py.

◆ usesMatches

bool lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask.usesMatches = False
static

Definition at line 61 of file psfDeterminer.py.


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