|
def | __init__ (self, dataIds, refCats, config, log=None) |
|
def | loadPixelBox (self, bbox, wcs, filterName=None, epoch=None, photoCalib=None, bboxToSpherePadding=100) |
|
def | loadRegion (self, region, filtFunc=None, filterName=None, epoch=None) |
|
def | loadSkyCircle (self, ctrCoord, radius, filterName=None, epoch=None) |
|
def | joinMatchListWithCatalog (self, matchCat, sourceCat) |
|
def | getMetadataBox (self, bbox, wcs, filterName=None, photoCalib=None, epoch=None, bboxToSpherePadding=100) |
|
This class facilitates loading reference catalogs with gen 3 middleware
The middleware preflight solver will create a list of datarefs that may
possibly overlap a given region. These datarefs are then used to construct
and instance of this class. The class instance should then be passed into
a task which needs reference catalogs. These tasks should then determine
the exact region of the sky reference catalogs will be loaded for, and
call a corresponding method to load the reference objects.
Definition at line 255 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoader.getMetadataBox |
( |
|
self, |
|
|
|
bbox, |
|
|
|
wcs, |
|
|
|
filterName = None , |
|
|
|
photoCalib = None , |
|
|
|
epoch = None , |
|
|
|
bboxToSpherePadding = 100 |
|
) |
| |
Return metadata about the load
This metadata is used for reloading the catalog (e.g., for
reconstituting a normalised match list.)
Parameters
----------
bbox : `lsst.geom.Box2I` or `lsst.geom.Box2D`
Bounding box for the pixels.
wcs : `lsst.afw.geom.SkyWcs`
The WCS object associated with ``bbox``.
filterName : `str` or `None`, optional
Name of the camera filter, or `None` or blank for the default
filter.
photoCalib : `None`
Deprecated, only included for api compatibility.
epoch : `astropy.time.Time` or `None`, optional
Epoch to which to correct proper motion and parallax, 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 encompase the
enitre area covered by the box.
Returns
-------
md : `lsst.daf.base.PropertyList`
The metadata detailing the search parameters used for this
dataset.
Definition at line 580 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoader.getMetadataCircle |
( |
|
coord, |
|
|
|
radius, |
|
|
|
filterName, |
|
|
|
photoCalib = None , |
|
|
|
epoch = None |
|
) |
| |
|
static |
Return metadata about the load.
This metadata is used for reloading the catalog (e.g. for
reconstituting a normalized match list.)
Parameters
----------
coord : `lsst.geom.SpherePoint`
ICRS center of the search region.
radius : `lsst.geom.Angle`
Radius of the search region.
filterName : `str` or `None`
Name of the camera filter, or `None` or blank for the default
filter.
photoCalib : `None`
Deprecated, only included for api compatibility.
epoch : `astropy.time.Time` or `None`, optional
Epoch to which to correct proper motion and parallax, or `None` to
not apply such corrections.
Returns
-------
md : `lsst.daf.base.PropertyList`
Definition at line 628 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoader.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, with links to source records and reference object records.
Parameters
----------
matchCat : `lsst.afw.table.BaseCatalog`
Unpersisted packed match list.
``matchCat.table.getMetadata()`` must contain match metadata,
as returned by the astrometry tasks.
sourceCat : `lsst.afw.table.SourceCatalog`
Source catalog. As a side effect, the catalog will be sorted
by ID.
Returns
-------
matchList : `lsst.afw.table.ReferenceMatchVector`
Match list.
Definition at line 554 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoader.loadPixelBox |
( |
|
self, |
|
|
|
bbox, |
|
|
|
wcs, |
|
|
|
filterName = None , |
|
|
|
epoch = None , |
|
|
|
photoCalib = None , |
|
|
|
bboxToSpherePadding = 100 |
|
) |
| |
Load reference objects that are within a pixel-based rectangular
region.
This algorithm works by creating a spherical box whose corners
correspond to the WCS converted corners of the input bounding box
(possibly padded). It then defines a filtering function which looks at
the pixel position of the reference objects and accepts only those that
lie within the specified bounding box.
The spherical box region and filtering function are passed to the
generic loadRegion method which loads and filters the reference objects
from the datastore and returns a single catalog containing the filtered
set of reference objects.
Parameters
----------
bbox : `lsst.geom.Box2I` or `lsst.geom.Box2D`
Box which bounds a region in pixel space.
wcs : `lsst.afw.geom.SkyWcs`
Wcs object defining the pixel to sky (and inverse) transform for
the supplied ``bbox``.
filterName : `str` or `None`, optional
Name of camera filter, or `None` or blank for the default filter.
epoch : `astropy.time.Time` or `None`, optional
Epoch to which to correct proper motion and parallax, or `None`
to not apply such corrections.
photoCalib : `None`
Deprecated and ignored, only included for api compatibility.
bboxToSpherePadding : `int`, optional
Padding to account for translating a set of corners into a
spherical (convex) boundary that is certain to encompase the
enitre area covered by the box.
Returns
-------
referenceCatalog : `lsst.afw.table.SimpleCatalog`
Catalog containing reference objects inside the specified bounding
box (padded by self.config.pixelMargin).
Raises
------
RuntimeError
Raised if no reference catalogs could be found for the specified
region.
TypeError
Raised if the loaded reference catalogs do not have matching
schemas.
Definition at line 323 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoader.loadRegion |
( |
|
self, |
|
|
|
region, |
|
|
|
filtFunc = None , |
|
|
|
filterName = None , |
|
|
|
epoch = None |
|
) |
| |
Load reference objects within a specified region.
This function loads the DataIds used to construct an instance of this
class which intersect or are contained within the specified region. The
reference catalogs which intersect but are not fully contained within
the input region are further filtered by the specified filter function.
This function returns a single source catalog containing all reference
objects inside the specified region.
Parameters
----------
region : `lsst.sphgeom.Region`
This can be any type that is derived from `lsst.sphgeom.Region` and
should define the spatial region for which reference objects are to
be loaded.
filtFunc : callable or `None`, optional
This optional parameter should be a callable object that takes a
reference catalog and its corresponding region as parameters,
filters the catalog by some criteria and returns the filtered
reference catalog. If `None`, an internal filter function is used
which filters according to if a reference object falls within the
input region.
filterName : `str` or `None`, optional
Name of camera filter, or `None` or blank for the default filter.
epoch : `astropy.time.Time` or `None`, optional
Epoch to which to correct proper motion and parallax, or `None` to
not apply such corrections.
Returns
-------
referenceCatalog : `lsst.afw.table.SourceCatalog`
Catalog containing reference objects which intersect the input region,
filtered by the specified filter function.
Raises
------
RuntimeError
Raised if no reference catalogs could be found for the specified
region.
TypeError
Raised if the loaded reference catalogs do not have matching
schemas.
Definition at line 410 of file loadReferenceObjects.py.
def lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoader.loadSkyCircle |
( |
|
self, |
|
|
|
ctrCoord, |
|
|
|
radius, |
|
|
|
filterName = None , |
|
|
|
epoch = None |
|
) |
| |
Load reference objects that lie within a circular region on the sky.
This method constructs a circular region from an input center and
angular radius, loads reference catalogs which are contained in or
intersect the circle, and filters reference catalogs which intersect
down to objects which lie within the defined circle.
Parameters
----------
ctrCoord : `lsst.geom.SpherePoint`
Point defining the center of the circular region.
radius : `lsst.geom.Angle`
Defines the angular radius of the circular region.
filterName : `str` or `None`, optional
Name of camera filter, or `None` or blank for the default filter.
epoch : `astropy.time.Time` or `None`, optional
Epoch to which to correct proper motion and parallax, or `None` to
not apply such corrections.
Returns
-------
referenceCatalog : `lsst.afw.table.SourceCatalog`
Catalog containing reference objects inside the specified search
circle.
Definition at line 523 of file loadReferenceObjects.py.