|
def | __init__ (self, butler, args, kwargs) |
|
def | loadSkyCircle (self, ctrCoord, radius, filterName=None, epoch=None) |
|
def | getShards (self, shardIdList) |
|
def | loadPixelBox (self, bbox, wcs, filterName=None, calib=None, epoch=None) |
|
def | getMetadataBox (self, bbox, wcs, filterName=None, calib=None, epoch=None) |
|
def | getMetadataCircle (self, coord, radius, filterName, calib=None, epoch=None) |
|
def | joinMatchListWithCatalog (self, matchCat, sourceCat) |
|
def | applyProperMotions (self, catalog, epoch) |
|
|
def | makeMinimalSchema (filterNameList, addFluxErr=False, addCentroid=True, addIsPhotometric=False, addIsResolved=False, addIsVariable=False, coordErrDim=2, addProperMotion=False, properMotionErrDim=2, addParallax=False, addParallaxErr=True) |
|
Load reference objects from an indexed catalog ingested by
IngestIndexReferenceTask.
Parameters
----------
butler : `lsst.daf.persistence.Butler`
Data butler for reading catalogs
Definition at line 42 of file loadIndexedReferenceObjects.py.
◆ __init__()
def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.__init__ |
( |
|
self, |
|
|
|
butler, |
|
|
|
args, |
|
|
|
kwargs |
|
) |
| |
◆ applyProperMotions()
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.applyProperMotions |
( |
|
self, |
|
|
|
catalog, |
|
|
|
epoch |
|
) |
| |
|
inherited |
Apply proper motion correction to a reference catalog.
Adjust position and position error in the ``catalog``
for proper motion to the specified ``epoch``,
modifying the catalong in place.
Parameters
----------
catalog : `lsst.afw.table.SimpleCatalog`
Catalog of positions, containing:
- Coordinates, retrieved by the table's coordinate key.
- ``coord_raErr`` : Error in Right Ascension (rad).
- ``coord_decErr`` : Error in Declination (rad).
- ``pm_ra`` : Proper motion in Right Ascension (rad/yr,
East positive)
- ``pm_raErr`` : Error in ``pm_ra`` (rad/yr), optional.
- ``pm_dec`` : Proper motion in Declination (rad/yr,
North positive)
- ``pm_decErr`` : Error in ``pm_dec`` (rad/yr), optional.
- ``epoch`` : Mean epoch of object (an astropy.time.Time)
epoch : `astropy.time.Time` (optional)
Epoch to which to correct proper motion and parallax,
or None to not apply such corrections.
Definition at line 731 of file loadReferenceObjects.py.
◆ getMetadataBox()
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.getMetadataBox |
( |
|
self, |
|
|
|
bbox, |
|
|
|
wcs, |
|
|
|
filterName = None , |
|
|
|
calib = None , |
|
|
|
epoch = None |
|
) |
| |
|
inherited |
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`
Pixel bounding box.
wcs : `lsst.afw.geom.SkyWcs`
WCS; used to convert pixel positions to sky coordinates.
filterName : `str`
Name of camera filter, or `None` or `""` for the default
filter.
calib : `lsst.afw.image.Calib` (optional)
Calibration, or `None` if unknown.
epoch : `astropy.time.Time` (optional)
Epoch to which to correct proper motion and parallax,
or None to not apply such corrections.
Returns
-------
metadata : lsst.daf.base.PropertyList
Metadata about the load.
Definition at line 624 of file loadReferenceObjects.py.
◆ getMetadataCircle()
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.getMetadataCircle |
( |
|
self, |
|
|
|
coord, |
|
|
|
radius, |
|
|
|
filterName, |
|
|
|
calib = None , |
|
|
|
epoch = None |
|
) |
| |
|
inherited |
Return metadata about the load.
This metadata is used for reloading the catalog (e.g., for
reconstituting a normalised match list.
Parameters
----------
coord : `lsst.geom.SpherePoint`
ICRS center of the search region.
radius : `lsst.geom.Angle`
Radius of the search region.
filterName : `str`
Name of camera filter, or `None` or `""` for the default
filter.
calib : `lsst.afw.image.Calib` (optional)
Calibration, or `None` if unknown.
epoch : `astropy.time.Time` (optional)
Epoch to which to correct proper motion and parallax,
or None to not apply such corrections.
Returns
-------
metadata : lsst.daf.base.PropertyList
Metadata about the load
Definition at line 653 of file loadReferenceObjects.py.
◆ getShards()
def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.getShards |
( |
|
self, |
|
|
|
shardIdList |
|
) |
| |
Get shards by ID.
Parameters
----------
shardIdList : `list` of `int`
A list of integer shard ids.
Returns
-------
catalogs : `list` of `lsst.afw.table.SimpleCatalog`
A list of reference catalogs, one for each entry in shardIdList.
Definition at line 110 of file loadIndexedReferenceObjects.py.
◆ joinMatchListWithCatalog()
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.joinMatchListWithCatalog |
( |
|
self, |
|
|
|
matchCat, |
|
|
|
sourceCat |
|
) |
| |
|
inherited |
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`
Unperisted 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 689 of file loadReferenceObjects.py.
◆ loadPixelBox()
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.loadPixelBox |
( |
|
self, |
|
|
|
bbox, |
|
|
|
wcs, |
|
|
|
filterName = None , |
|
|
|
calib = None , |
|
|
|
epoch = None |
|
) |
| |
|
inherited |
Load reference objects that overlap a rectangular pixel region.
Parameters
----------
bbox : `lsst.geom.Box2I` or `lsst.geom.Box2D`
Bounding box for pixels.
wcs : `lsst.afw.geom.SkyWcs`
WCS; used to convert pixel positions to sky coordinates
and vice-versa.
filterName : `str`
Name of filter, or `None` or `""` for the default filter.
This is used for flux values in case we have flux limits
(which are not yet implemented).
calib : `lsst.afw.image.Calib` (optional)
Calibration, or `None` if unknown.
epoch : `astropy.time.Time` (optional)
Epoch to which to correct proper motion and parallax,
or None to not apply such corrections.
Returns
-------
results : `lsst.pipe.base.Struct`
A Struct containing the following fields:
refCat : `lsst.afw.catalog.SimpleCatalog`
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.
fluxField : `str`
Name of flux field for specified `filterName`.
Notes
-----
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.
Definition at line 252 of file loadReferenceObjects.py.
◆ loadSkyCircle()
def lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.loadSkyCircle |
( |
|
self, |
|
|
|
ctrCoord, |
|
|
|
radius, |
|
|
|
filterName = None , |
|
|
|
epoch = None |
|
) |
| |
◆ makeMinimalSchema()
def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsTask.makeMinimalSchema |
( |
|
filterNameList, |
|
|
|
addFluxErr = False , |
|
|
|
addCentroid = True , |
|
|
|
addIsPhotometric = False , |
|
|
|
addIsResolved = False , |
|
|
|
addIsVariable = False , |
|
|
|
coordErrDim = 2 , |
|
|
|
addProperMotion = False , |
|
|
|
properMotionErrDim = 2 , |
|
|
|
addParallax = False , |
|
|
|
addParallaxErr = True |
|
) |
| |
|
staticinherited |
Make a standard schema for reference object catalogs.
Parameters
----------
filterNameList : `list` of `str`
List of filter names. Used to create <filterName>_flux fields.
addFluxErr : `bool`
If True then include flux sigma fields.
addIsPhotometric : `bool`
If True then add field "photometric".
addIsResolved : `bool`
If True then add field "resolved".
addIsVariable : `bool`
If True then add field "variable".
coordErrDim : `int`
Number of coord error fields; must be one of 0, 2, 3:
- If 2 or 3: add fields "coord_raErr" and "coord_decErr".
- If 3: also add field "coord_radecErr".
addProperMotion : `bool`
If True add fields "epoch", "pm_ra", "pm_dec" and "pm_flag".
properMotionErrDim : `int`
Number of proper motion error fields; must be one of 0, 2, 3;
ignored if addProperMotion false:
- If 2 or 3: add fields "pm_raErr" and "pm_decErr".
- If 3: also add field "pm_radecErr".
addParallax : `bool`
If True add fields "epoch", "parallax", "parallaxErr"
and "parallax_flag".
addParallaxErr : `bool`
If True add field "parallaxErr"; ignored if addParallax false.
Returns
-------
schema : `lsst.afw.table.Schema`
Schema for reference catalog, an
`lsst.afw.table.SimpleCatalog`.
Notes
-----
Reference catalogs support additional covariances, such as
covariance between RA and proper motion in declination,
that are not supported by this method, but can be added after
calling this method.
Definition at line 435 of file loadReferenceObjects.py.
◆ butler
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.butler |
◆ ConfigClass
◆ indexer
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.indexer |
◆ ref_dataset_name
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask.ref_dataset_name |
The documentation for this class was generated from the following file: