lsst.meas.algorithms gbe01a4569f+02d415ec64
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.makePsfCandidates.MakePsfCandidatesTask Class Reference
Inheritance diagram for lsst.meas.algorithms.makePsfCandidates.MakePsfCandidatesTask:

Public Member Functions

def __init__ (self, **kwds)
 
def run (self, starCat, exposure, psfCandidateField=None)
 
def makePsfCandidates (self, starCat, exposure)
 

Static Public Attributes

 ConfigClass = MakePsfCandidatesConfig
 

Detailed Description

Create PSF candidates given an input catalog.

Definition at line 48 of file makePsfCandidates.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.makePsfCandidates.MakePsfCandidatesTask.__init__ (   self,
**  kwds 
)

Definition at line 54 of file makePsfCandidates.py.

Member Function Documentation

◆ makePsfCandidates()

def lsst.meas.algorithms.makePsfCandidates.MakePsfCandidatesTask.makePsfCandidates (   self,
  starCat,
  exposure 
)
Make a list of PSF candidates from a star catalog.

Parameters
----------
starCat : `lsst.afw.table.SourceCatalog`
    Catalog of stars, as returned by
    ``lsst.meas.algorithms.starSelector.run()``.
exposure : `lsst.afw.image.Exposure`
    The exposure containing the sources.

Returns
-------
struct : `lsst.pipe.base.Struct`
    Results struct containing:

    - ``psfCandidates`` : List of PSF candidates
        (`list` of `lsst.meas.algorithms.PsfCandidate`).
    - ``goodStarCat`` : Subset of ``starCat`` that was successfully made
        into PSF candidates (`lsst.afw.table.SourceCatalog`).

Definition at line 91 of file makePsfCandidates.py.

◆ run()

def lsst.meas.algorithms.makePsfCandidates.MakePsfCandidatesTask.run (   self,
  starCat,
  exposure,
  psfCandidateField = None 
)
Make a list of PSF candidates from a star catalog.

Parameters
----------
starCat : `lsst.afw.table.SourceCatalog`
    Catalog of stars, as returned by
    ``lsst.meas.algorithms.starSelector.run()``.
exposure : `lsst.afw.image.Exposure`
    The exposure containing the sources.
psfCandidateField : `str` or None
    Name of flag field to set True for PSF candidates, or None to not
    set a field; the field is left unchanged for non-candidates.

Returns
-------
struct : `lsst.pipe.base.Struct`
    Results struct containing:

    - ``psfCandidates`` : List of PSF candidates
        (`list` of `lsst.meas.algorithms.PsfCandidate`).
    - ``goodStarCat`` : Subset of ``starCat`` that was successfully made
        into PSF candidates (`lsst.afw.table.SourceCatalog`).

Definition at line 57 of file makePsfCandidates.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.makePsfCandidates.MakePsfCandidatesTask.ConfigClass = MakePsfCandidatesConfig
static

Definition at line 51 of file makePsfCandidates.py.


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