|
def | loadSkyCircle (self, ctrCoord, radius, filterName, epoch=None, centroids=False) |
|
Abstract gen2 base class to load objects from reference catalogs.
Definition at line 937 of file loadReferenceObjects.py.
◆ loadSkyCircle()
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.loadSkyCircle |
( |
|
self, |
|
|
|
ctrCoord, |
|
|
|
radius, |
|
|
|
filterName, |
|
|
|
epoch = None , |
|
|
|
centroids = False |
|
) |
| |
Load reference objects that overlap a circular sky region.
Parameters
----------
ctrCoord : `lsst.geom.SpherePoint`
ICRS center of search region.
radius : `lsst.geom.Angle`
Radius of search region.
filterName : `str`
Name of filter. This can be used for flux limit comparisons.
epoch : `astropy.time.Time` or `None`, optional
Epoch to which to correct proper motion and parallax, or `None` to
not apply such corrections.
centroids : `bool`, optional
Add centroid fields to the loaded Schema. ``loadPixelBox`` expects
these fields to exist.
Returns
-------
results : `lsst.pipe.base.Struct`
A `~lsst.pipe.base.Struct` containing the following fields:
``refCat``
A catalog of reference objects with the standard
schema, as documented in the main doc string for
`LoadReferenceObjects`.
The catalog is guaranteed to be contiguous.
(`lsst.afw.catalog.SimpleCatalog`)
``fluxField``
Name of flux field for specified `filterName`. (`str`)
Notes
-----
Note that subclasses are responsible for performing the proper motion
correction, since this is the lowest-level interface for retrieving
the catalog.
Reimplemented from lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoader.
Definition at line 943 of file loadReferenceObjects.py.
◆ _DefaultName
str lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask._DefaultName = "LoadReferenceObjects" |
|
staticprotected |
The documentation for this class was generated from the following file: