Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DM-9837 Update catalogStarSelector to new SourceSelector API #87

Merged
merged 1 commit into from
May 29, 2018
Merged

DM-9837 Update catalogStarSelector to new SourceSelector API #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
61 changes: 33 additions & 28 deletions python/lsst/meas/astrom/catalogStarSelector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@

__all__ = ["CatalogStarSelectorConfig", "CatalogStarSelectorTask"]

import numpy as np

from lsst.afw.table import SourceCatalog
from lsst.meas.algorithms import BaseStarSelectorTask, starSelectorRegistry
from lsst.meas.algorithms import BaseSourceSelectorTask, sourceSelectorRegistry
from lsst.pipe.base import Struct
import lsst.pex.config as pexConfig
import lsst.afw.display.ds9 as ds9


class CatalogStarSelectorConfig(BaseStarSelectorTask.ConfigClass):
class CatalogStarSelectorConfig(BaseSourceSelectorTask.ConfigClass):
fluxLim = pexConfig.RangeField(
doc="specify the minimum psfFlux for good Psf Candidates",
dtype=float,
Expand All @@ -43,14 +43,15 @@ class CatalogStarSelectorConfig(BaseStarSelectorTask.ConfigClass):
default=0.0,
min=0.0,
)

def setDefaults(self):
BaseStarSelectorTask.ConfigClass.setDefaults(self)
self.badFlags = [
badFlags = pexConfig.ListField(
doc="List of flags which cause a source to be rejected as bad",
dtype=str,
default=[
"base_PixelFlags_flag_edge",
"base_PixelFlags_flag_interpolatedCenter",
"base_PixelFlags_flag_saturatedCenter",
]
],
)


class CheckSource:
Expand Down Expand Up @@ -80,6 +81,7 @@ def __call__(self, source):
# \}


@pexConfig.registerConfigurable("catalog", sourceSelectorRegistry)
class CatalogStarSelectorTask:
"""!Select stars based on a reference catalog

Expand Down Expand Up @@ -141,18 +143,27 @@ def DebugInfo(name):
ConfigClass = CatalogStarSelectorConfig
usesMatches = True # `run` and `selectStars` require the `matches` argument

def selectStars(self, exposure, sourceCat, matches=None):
"""!Return a list of PSF candidates that represent likely stars

A list of PSF candidates may be used by a PSF fitter to construct a PSF.

@param[in] exposure the exposure containing the sources
@param[in] sourceCat catalog of sources that may be stars (an lsst.afw.table.SourceCatalog)
@param[in] matches a match vector as produced by meas_astrom; required
(defaults to None to match the StarSelector API and improve error handling)

@return an lsst.pipe.base.Struct containing:
- starCat catalog of selected stars (a subset of sourceCat)
def selectSources(self, sourceCat, matches=None, exposure=None):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to give matches a default value here? (Or rather, is that what we usually do for SourceSelectors with usesMatches = True?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can only find two SourceSelectors that have usesMatches = True, so there really isn't a known behavior. The first thing it does is if matches is None, so I think it's fine to default it like that.

"""Return a selection of sources based on reference catalog matches.

Parameters
----------
sourceCat : `lsst.afw.table.SourceCatalog`
Catalog of sources to select from.
This catalog must be contiguous in memory.
matches : `list` of `lsst.afw.table.ReferenceMatch`
A match vector as produced by meas_astrom; required.
exposure : `lsst.afw.image.Exposure` or None
The exposure the catalog was built from; used for debug display.

Return
------
struct : `lsst.pipe.base.Struct`
The struct contains the following data:

- selected : `numpy.ndarray` of `bool``
Boolean array of sources that were selected, same length as
sourceCat.
"""
import lsstDebug
debugInfo = lsstDebug.Info(__name__)
Expand All @@ -169,15 +180,14 @@ def selectStars(self, exposure, sourceCat, matches=None):
ds9.mtv(mi, frame=frame, title="PSF candidates")

isGoodSource = CheckSource(sourceCat, self.config.fluxLim, self.config.fluxMax, self.config.badFlags)
good = np.array([isGoodSource(record) for record in sourceCat])

starCat = SourceCatalog(sourceCat.schema)
with ds9.Buffering():
for ref, source, d in matches:
if not ref.get("resolved"):
if not isGoodSource(source):
symb, ctype = "+", ds9.RED
else:
starCat.append(source)
symb, ctype = "+", ds9.GREEN

if display:
Expand All @@ -187,9 +197,4 @@ def selectStars(self, exposure, sourceCat, matches=None):
if display and pauseAtEnd:
input("Continue? y[es] p[db] ")

return Struct(
starCat=starCat,
)


starSelectorRegistry.register("catalog", CatalogStarSelectorTask)
return Struct(selected=good)