|
lsst.meas.algorithms g33a09d4741+106f42d13d
|
Classes | |
| class | _FilterCatalog |
| class | LoadReferenceObjectsConfig |
| class | ReferenceObjectLoader |
Functions | |
| getFormatVersionFromRefCat (refCat) | |
| getRefFluxField (schema, filterName) | |
| getRefFluxKeys (schema, filterName) | |
| applyProperMotionsImpl (log, catalog, epoch) | |
| lsst.meas.algorithms.loadReferenceObjects.applyProperMotionsImpl | ( | log, | |
| 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
----------
log : `lsst.log.Log` or `logging.getLogger`
Log object to write to.
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`
Epoch to which to correct proper motion.
Definition at line 833 of file loadReferenceObjects.py.
| lsst.meas.algorithms.loadReferenceObjects.getFormatVersionFromRefCat | ( | refCat | ) |
"Return the format version stored in a reference catalog header.
Parameters
----------
refCat : `lsst.afw.table.SimpleCatalog`
Reference catalog to inspect.
Returns
-------
version : `int`
Format version integer.
Raises
------
ValueError
Raised if the catalog is version 0, has no metadata, or does not
include a "REFCAT_FORMAT_VERSION" key.
Definition at line 41 of file loadReferenceObjects.py.
| lsst.meas.algorithms.loadReferenceObjects.getRefFluxField | ( | schema, | |
| filterName | |||
| ) |
Get the name of a flux field from a schema.
Parameters
----------
schema : `lsst.afw.table.Schema`
Reference catalog schema.
filterName : `str`
Name of camera filter.
Returns
-------
fluxFieldName : `str`
Name of flux field.
Notes
-----
Return the alias of ``anyFilterMapsToThis``, if present
else, return ``*filterName*_camFlux`` if present,
else, return ``*filterName*_flux`` if present (camera filter name
matches reference filter name), else raise an exception.
Raises
------
RuntimeError
Raised if an appropriate field is not found.
Definition at line 758 of file loadReferenceObjects.py.
| lsst.meas.algorithms.loadReferenceObjects.getRefFluxKeys | ( | schema, | |
| filterName | |||
| ) |
Return keys for flux and flux error.
Parameters
----------
schema : `lsst.afw.table.Schema`
Reference catalog schema.
filterName : `str`
Name of camera filter.
Returns
-------
keys : `tuple` of (`lsst.afw.table.Key`, `lsst.afw.table.Key`)
Two keys:
- flux key
- flux error key, if present, else None
Raises
------
RuntimeError
If flux field not found.
Definition at line 800 of file loadReferenceObjects.py.