Base class for reference object loaders, to facilitate gen2/gen3 code
sharing.
Definition at line 240 of file loadReferenceObjects.py.
◆ applyProperMotions()
def lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoaderBase.applyProperMotions |
( |
|
self, |
|
|
|
catalog, |
|
|
|
epoch |
|
) |
| |
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 catalog in place.
Parameters
----------
catalog : `lsst.afw.table.SimpleCatalog`
Catalog of positions, containing at least these fields:
- 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`
Epoch to which to correct proper motion.
If None, do not apply PM corrections or raise if
``config.requireProperMotion`` is True.
Raises
------
RuntimeError
Raised if ``config.requireProperMotion`` is set but we cannot
apply the proper motion correction for some reason.
Definition at line 246 of file loadReferenceObjects.py.
◆ ConfigClass
The documentation for this class was generated from the following file: