Load multi-band reference objects from a reference catalog.
Parameters
----------
dataIds : iterable of `lsst.daf.butler.dataId`
An iterable object of dataIds which point to reference catalogs
in a Gen3 repository. Required for Gen3.
refCats : iterable of `lsst.daf.butler.DeferredDatasetHandle`
An iterable object of dataset refs for reference catalogs in
a Gen3 repository.
name : `str`
The name of the refcat that this object will load. This name is used
for applying colorterms, for example.
Raises
------
RuntimeError if dataIds or refCats is None.
Definition at line 77 of file loadReferenceCatalog.py.
def lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask.getPixelBoxCatalog |
( |
|
self, |
|
|
|
bbox, |
|
|
|
wcs, |
|
|
|
filterList, |
|
|
|
epoch = None , |
|
|
|
bboxToSpherePadding = None |
|
) |
| |
Get a multi-band reference catalog by specifying a bounding box and WCS.
The catalog will be in `numpy.ndarray`, with positions proper-motion
corrected to "epoch" (if specified, and if the reference catalog has
proper motions); sources cut on a reference selector (if
"config.doReferenceSelection = True"); and color-terms applied (if
"config.doApplyColorTerms = True").
The format of the reference catalog will be of the format:
dtype = [('ra', 'np.float64'),
('dec', 'np.float64'),
('refMag', 'np.float32', (len(filterList), )),
('refMagErr', 'np.float32', (len(filterList), ))]
Reference magnitudes (AB) and errors will be 99 for non-detections
in a given band.
Parameters
----------
bbox : `lsst.geom.Box2I`
Box which bounds a region in pixel space.
wcs : `lsst.afw.geom.SkyWcs`
Wcs object defining the pixel to sky (and reverse) transform for
the supplied bbox.
filterList : `List` [ `str` ]
List of camera physicalFilter names to retrieve magnitudes.
epoch : `astropy.time.Time`, optional
Epoch to which to correct proper motion and parallax
(if available), or `None` to not apply such corrections.
bboxToSpherePadding : `int`, optional
Padding to account for translating a set of corners into a
spherical (convex) boundary that is certain to encompass the
entire area covered by the bbox.
Returns
-------
refCat : `numpy.ndarray`
Reference catalog.
Definition at line 114 of file loadReferenceCatalog.py.
def lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask.getSkyCircleCatalog |
( |
|
self, |
|
|
|
center, |
|
|
|
radius, |
|
|
|
filterList, |
|
|
|
epoch = None , |
|
|
|
catalogFormat = 'numpy' |
|
) |
| |
Get a multi-band reference catalog by specifying a center and radius.
The catalog will be in `numpy.ndarray`, with positions proper-motion
corrected to "epoch" (if specified, and if the reference catalog has
proper motions); sources cut on a reference selector (if
"config.doReferenceSelection = True"); and color-terms applied (if
"config.doApplyColorTerms = True").
The format of the reference catalog will be of the format:
dtype = [('ra', 'np.float64'),
('dec', 'np.float64'),
('refMag', 'np.float32', (len(filterList), )),
('refMagErr', 'np.float32', (len(filterList), ))]
Reference magnitudes (AB) and errors will be 99 for non-detections
in a given band.
Parameters
----------
center : `lsst.geom.SpherePoint`
Point defining the center of the circular region.
radius : `lsst.geom.Angle`
Defines the angular radius of the circular region.
filterList : `List` [ `str` ]
List of camera physicalFilter names to retrieve magnitudes.
epoch : `astropy.time.Time`, optional
Epoch to which to correct proper motion and parallax
(if available), or `None` to not apply such corrections.
Returns
-------
refCat : `numpy.ndarray`
Reference catalog.
Definition at line 172 of file loadReferenceCatalog.py.