Inheritance diagram for lsst.meas.algorithms.makePsfCandidates.MakePsfCandidatesTask:

Public Member Functions
	run (self, starCat, exposure, psfCandidateField=None)
	makePsfCandidates (self, starCat, exposure)

Static Public Attributes
	ConfigClass = MakePsfCandidatesConfig

Static Protected Attributes
str	_DefaultName = "makePsfCandidates"

Detailed Description

Create PSF candidates given an input catalog.

Definition at line 47 of file makePsfCandidates.py.

Member Function Documentation

◆ makePsfCandidates()

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 87 of file makePsfCandidates.py.

◆ run()

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`, optional
    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 53 of file makePsfCandidates.py.

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.makePsfCandidates.MakePsfCandidatesTask._DefaultName = "makePsfCandidates"

staticprotected

Definition at line 51 of file makePsfCandidates.py.

◆ ConfigClass

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

static

Definition at line 50 of file makePsfCandidates.py.

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

python/lsst/meas/algorithms/makePsfCandidates.py

Public Member Functions

Static Public Attributes