LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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.

54  def __init__(self, **kwds):
55  pipeBase.Task.__init__(self, **kwds)
56 

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.

91  def makePsfCandidates(self, starCat, exposure):
92  """Make a list of PSF candidates from a star catalog.
93 
94  Parameters
95  ----------
96  starCat : `lsst.afw.table.SourceCatalog`
97  Catalog of stars, as returned by
98  ``lsst.meas.algorithms.starSelector.run()``.
99  exposure : `lsst.afw.image.Exposure`
100  The exposure containing the sources.
101 
102  Returns
103  -------
104  struct : `lsst.pipe.base.Struct`
105  Results struct containing:
106 
107  - ``psfCandidates`` : List of PSF candidates
108  (`list` of `lsst.meas.algorithms.PsfCandidate`).
109  - ``goodStarCat`` : Subset of ``starCat`` that was successfully made
110  into PSF candidates (`lsst.afw.table.SourceCatalog`).
111  """
112  goodStarCat = SourceCatalog(starCat.schema)
113 
114  psfCandidateList = []
115  didSetSize = False
116  for star in starCat:
117  try:
118  psfCandidate = makePsfCandidate(star, exposure)
119 
120  # The setXXX methods are class static, but it's convenient to call them on
121  # an instance as we don't know exposures's pixel type
122  # (and hence psfCandidate's exact type)
123  if not didSetSize:
124  psfCandidate.setBorderWidth(self.config.borderWidth)
125  psfCandidate.setWidth(self.config.kernelSize + 2*self.config.borderWidth)
126  psfCandidate.setHeight(self.config.kernelSize + 2*self.config.borderWidth)
127  didSetSize = True
128 
129  im = psfCandidate.getMaskedImage().getImage()
130  except lsst.pex.exceptions.Exception as err:
131  self.log.warning("Failed to make a psfCandidate from star %d: %s", star.getId(), err)
132  continue
133 
134  vmax = afwMath.makeStatistics(im, afwMath.MAX).getValue()
135  if not np.isfinite(vmax):
136  continue
137  psfCandidateList.append(psfCandidate)
138  goodStarCat.append(star)
139 
140  return pipeBase.Struct(
141  psfCandidates=psfCandidateList,
142  goodStarCat=goodStarCat,
143  )
lsst.pex::exceptions::Exception
Provides consistent interface for LSST exceptions.
Definition: Exception.h:107
lsst::afw::math::makeStatistics
Statistics makeStatistics(lsst::afw::image::Image< Pixel > const &img, lsst::afw::image::Mask< image::MaskPixel > const &msk, int const flags, StatisticsControl const &sctrl=StatisticsControl())
Handle a watered-down front-end to the constructor (no variance)
Definition: Statistics.h:359
lsst::afw::table::SourceCatalog
SortedCatalogT< SourceRecord > SourceCatalog
Definition: fwd.h:85
lsst::meas::algorithms::makePsfCandidate
std::shared_ptr< PsfCandidate< PixelT > > makePsfCandidate(std::shared_ptr< afw::table::SourceRecord > const &source, std::shared_ptr< afw::image::Exposure< PixelT >> image)
Return a PsfCandidate of the right sort.
Definition: PsfCandidate.h:176

◆ 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.

57  def run(self, starCat, exposure, psfCandidateField=None):
58  """Make a list of PSF candidates from a star catalog.
59 
60  Parameters
61  ----------
62  starCat : `lsst.afw.table.SourceCatalog`
63  Catalog of stars, as returned by
64  ``lsst.meas.algorithms.starSelector.run()``.
65  exposure : `lsst.afw.image.Exposure`
66  The exposure containing the sources.
67  psfCandidateField : `str` or None
68  Name of flag field to set True for PSF candidates, or None to not
69  set a field; the field is left unchanged for non-candidates.
70 
71  Returns
72  -------
73  struct : `lsst.pipe.base.Struct`
74  Results struct containing:
75 
76  - ``psfCandidates`` : List of PSF candidates
77  (`list` of `lsst.meas.algorithms.PsfCandidate`).
78  - ``goodStarCat`` : Subset of ``starCat`` that was successfully made
79  into PSF candidates (`lsst.afw.table.SourceCatalog`).
80 
81  """
82  psfResult = self.makePsfCandidates(starCat, exposure)
83 
84  if psfCandidateField is not None:
85  isStarKey = starCat.schema[psfCandidateField].asKey()
86  for star in psfResult.goodStarCat:
87  star.set(isStarKey, True)
88 
89  return psfResult
90 
lsst::ip::diffim.getTemplate.run
def run(self, coaddExposures, bbox, wcs)
Definition: getTemplate.py:603

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:
Generated on Fri Nov 26 2021 10:16:22 for LSST Applications by doxygen 1.9.1