lsst.meas.algorithms
14.0-14-gbf7a6f8a
|
Abstract base class to load objects from reference catalogs. More...
Public Member Functions | |
def | __init__ (self, butler=None, args, kwargs) |
Construct a LoadReferenceObjectsTask. More... | |
def | loadPixelBox (self, bbox, wcs, filterName=None, calib=None) |
Load reference objects that overlap a pixel-based rectangular region. More... | |
def | loadSkyCircle (self, ctrCoord, radius, filterName=None) |
Load reference objects that overlap a circular sky region. More... | |
def | getMetadataBox (self, bbox, wcs, filterName=None, calib=None) |
Return metadata about the load. More... | |
def | getMetadataCircle (self, coord, radius, filterName, calib=None) |
Return metadata about the load. More... | |
def | joinMatchListWithCatalog (self, matchCat, sourceCat) |
Relink an unpersisted match list to sources and reference objects. More... | |
Static Public Member Functions | |
def | makeMinimalSchema (filterNameList, addFluxSigma=False, addIsPhotometric=False, addIsResolved=False, addIsVariable=False) |
Make the standard schema for reference object catalogs. More... | |
Public Attributes | |
butler | |
Static Public Attributes | |
ConfigClass = LoadReferenceObjectsConfig | |
Abstract base class to load objects from reference catalogs.
Abstract base class for tasks that load objects from a reference catalog in a particular region of the sky.
Implementations must subclass this class, override the loadSkyCircle method, and will typically override the value of ConfigClass with a task-specific config class.
Construct a LoadReferenceObjectsTask.
[in] | butler | A daf.persistence.Butler object. This allows subclasses to use the butler to access reference catalog files using the stack I/O abstraction scheme. |
Reference object catalogs are instances of lsst.afw.table.SimpleCatalog with the following schema (other fields may also be present):
See LoadReferenceObjectsConfig for a base set of configuration parameters. Most subclasses will add configuration variables.
Definition at line 119 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.__init__ | ( | self, | |
butler = None , |
|||
args, | |||
kwargs | |||
) |
Construct a LoadReferenceObjectsTask.
[in] | butler | A daf.persistence.Butler object. This allows subclasses to use the butler to access reference catalog files using the stack I/O abstraction scheme. |
Definition at line 178 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.getMetadataBox | ( | self, | |
bbox, | |||
wcs, | |||
filterName = None , |
|||
calib = None |
|||
) |
Return metadata about the load.
This metadata is used for reloading the catalog (e.g., for reconstituting a normalised match list.
[in] | bbox | bounding box for pixels (an lsst.afw.geom.Box2I or Box2D) |
[in] | wcs | WCS (an lsst.afw.image.Wcs) |
[in] | filterName | name of camera filter, or None or blank for the default filter |
[in] | calib | calibration, or None if unknown |
Definition at line 377 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.getMetadataCircle | ( | self, | |
coord, | |||
radius, | |||
filterName, | |||
calib = None |
|||
) |
Return metadata about the load.
This metadata is used for reloading the catalog (e.g., for reconstituting a normalised match list.
[in] | coord | central coordinate of circle (lsst.afw.coord.Coord) |
[in] | radius | radius of circle (lsst.afw.geom.Angle) |
[in] | filterName | name of camera filter, or None or blank for the default filter |
[in] | calib | calibration, or None if unknown |
Definition at line 392 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.joinMatchListWithCatalog | ( | self, | |
matchCat, | |||
sourceCat | |||
) |
Relink an unpersisted match list to sources and reference objects.
A match list is persisted and unpersisted as a catalog of IDs produced by afw.table.packMatches(), with match metadata (as returned by the astrometry tasks) in the catalog's metadata attribute. This method converts such a match catalog into a match list (an lsst.afw.table.ReferenceMatchVector) with links to source records and reference object records.
[in] | matchCat | Unperisted packed match list (an lsst.afw.table.BaseCatalog). matchCat.table.getMetadata() must contain match metadata, as returned by the astrometry tasks. |
[in,out] | sourceCat | Source catalog (an lsst.afw.table.SourceCatalog). As a side effect, the catalog will be sorted by ID. |
Definition at line 413 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.loadPixelBox | ( | self, | |
bbox, | |||
wcs, | |||
filterName = None , |
|||
calib = None |
|||
) |
Load reference objects that overlap a pixel-based rectangular region.
The search algorithm works by searching in a region in sky coordinates whose center is the center of the bbox and radius is large enough to just include all 4 corners of the bbox. Stars that lie outside the bbox are then trimmed from the list.
[in] | bbox | bounding box for pixels (an lsst.afw.geom.Box2I or Box2D) |
[in] | wcs | WCS (an lsst.afw.image.Wcs) |
[in] | filterName | name of camera filter, or None or blank for the default filter |
[in] | calib | calibration, or None if unknown |
Definition at line 188 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.loadSkyCircle | ( | self, | |
ctrCoord, | |||
radius, | |||
filterName = None |
|||
) |
Load reference objects that overlap a circular sky region.
[in] | ctrCoord | center of search region (an lsst.afw.geom.Coord) |
[in] | radius | radius of search region (an lsst.afw.geom.Angle) |
[in] | filterName | name of filter, or None for the default filter; used for flux values in case we have flux limits (which are not yet implemented) |
Definition at line 226 of file loadReferenceObjects.py.
|
static |
Make the standard schema for reference object catalogs.
[in] | filterNameList | list of filter names; used to create filterName_flux fields |
[in] | addFluxSigma | if True then include flux sigma fields |
[in] | addIsPhotometric | if True add field "photometric" |
[in] | addIsResolved | if True add field "resolved" |
[in] | addIsVariable | if True add field "variable" |
Definition at line 305 of file loadReferenceObjects.py.
lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.butler |
Definition at line 185 of file loadReferenceObjects.py.
|
static |
Definition at line 175 of file loadReferenceObjects.py.