|
def | getWcs (self, dataRef) |
|
def | fetchInPatches (self, dataRef, patchList) |
|
def | fetchInBox (self, dataRef, bbox, wcs, pad=0) |
|
def | fetchInBox (self, dataRef, bbox, wcs) |
|
def | getSchema (self, butler) |
|
def | subset (self, sources, bbox, wcs) |
|
Loads references from the multi-band processing scheme.
Definition at line 381 of file references.py.
◆ fetchInBox() [1/2]
def lsst.meas.base.references.BaseReferencesTask.fetchInBox |
( |
|
self, |
|
|
|
dataRef, |
|
|
|
bbox, |
|
|
|
wcs |
|
) |
| |
|
inherited |
Return reference sources within a given bounding box.
Reference sources are selected if they overlap a region defined by a
pixel-coordinate bounding box and corresponding WCS.
Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
Butler data reference. The implied data ID must contain the
``tract`` key.
bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
Defines the selection region in pixel coordinates.
wcs : `lsst.afw.image.SkyWcs`
Maps ``bbox`` to sky coordinates.
Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
Reference sources. May be any Python iterable, including a lazy
iterator.
Notes
-----
The returned set of sources should be complete and close to minimal.
Definition at line 108 of file references.py.
◆ fetchInBox() [2/2]
def lsst.meas.base.references.CoaddSrcReferencesTask.fetchInBox |
( |
|
self, |
|
|
|
dataRef, |
|
|
|
bbox, |
|
|
|
wcs, |
|
|
|
pad = 0 |
|
) |
| |
|
inherited |
Return reference sources within a given bounding box.
Reference sources are selected if they overlap a region defined by a
pixel-coordinate bounding box and corresponding WCS.
Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
Butler data reference. The implied data ID must contain the
``tract`` key.
bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
Defines the selection region in pixel coordinates.
wcs : `lsst.afw.image.SkyWcs`
Maps ``bbox`` to sky coordinates.
pad : `int`
a buffer to grow the bounding box by after catalogs have been loaded, but
before filtering them to include just the given bounding box.
Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
Reference sources. May be any Python iterable, including a lazy
iterator.
Definition at line 329 of file references.py.
◆ fetchInPatches()
def lsst.meas.base.references.CoaddSrcReferencesTask.fetchInPatches |
( |
|
self, |
|
|
|
dataRef, |
|
|
|
patchList |
|
) |
| |
|
inherited |
Fetch the source catalog using the Butler.
Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
Butler data reference. The implied data ID must contain the
``tract`` key.
patchList : `list` of `lsst.skymap.PatchInfo`
Patches for which to fetch reference sources.
Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
Reference sources. May be any Python iterable, including a lazy
iterator.
Notes
-----
An implementation of `BaseReferencesTask.fetchInPatches` that loads
``Coadd_`` + `datasetSuffix` catalogs using the butler.
Reimplemented from lsst.meas.base.references.BaseReferencesTask.
Definition at line 284 of file references.py.
◆ getSchema()
def lsst.meas.base.references.BaseReferencesTask.getSchema |
( |
|
self, |
|
|
|
butler |
|
) |
| |
|
inherited |
Return the schema for the reference sources.
Parameters
----------
butler : `lsst.daf.persistence.butler.Butler`
Data butler from which the schema will be fetched.
Notes
-----
Must be available even before any data has been processed.
Definition at line 83 of file references.py.
◆ getWcs()
def lsst.meas.base.references.CoaddSrcReferencesTask.getWcs |
( |
|
self, |
|
|
|
dataRef |
|
) |
| |
|
inherited |
◆ subset()
def lsst.meas.base.references.BaseReferencesTask.subset |
( |
|
self, |
|
|
|
sources, |
|
|
|
bbox, |
|
|
|
wcs |
|
) |
| |
|
inherited |
Filter a list of sources to only those within the bounding box.
Parameters
----------
sources : iterable of `~lsst.afw.table.SourceRecord`
Reference sources. May be any Python iterable, including a lazy
iterator.
bbox : `lsst.afw.geom.Box2I` or `lsst.afw.geom.Box2D`
Defines the selection region.
wcs : `lsst.afw.image.SkyWcs`
Maps ``bbox`` to sky coordinates.
Returns
-------
sources : iterable of `~lsst.afw.table.SourceRecord`
Filtered sources. May be any Python iterable, including a lazy
iterator.
Notes
-----
Instead of filtering sources directly via their positions, we filter
based on the positions of parent objects, then include or discard all
children based on their parent's status. This is necessary to support
replacement with noise in measurement, which requires all child
sources have their parent present.
This is not a part of the required `BaseReferencesTask` interface;
it's a convenience function used in implementing `fetchInBox` that may
be of use to subclasses.
Definition at line 162 of file references.py.
◆ ConfigClass
◆ datasetSuffix
string lsst.meas.base.references.MultiBandReferencesTask.datasetSuffix = "ref" |
|
static |
◆ schema
lsst.meas.base.references.CoaddSrcReferencesTask.schema |
|
inherited |
The documentation for this class was generated from the following file: