|
lsst.meas.algorithms g511c235543+401ba1f5a0
|
Classes | |
| class | _FilterCatalog |
| class | LoadReferenceObjectsConfig |
| class | LoadReferenceObjectsTask |
| class | ReferenceObjectLoader |
| class | ReferenceObjectLoaderBase |
Functions | |
| def | isOldFluxField (name, units) |
| def | hasNanojanskyFluxUnits (schema) |
| def | getFormatVersionFromRefCat (refCat) |
| def | convertToNanojansky (catalog, log, doConvert=True) |
| def | getRefFluxField (schema, filterName) |
| def | getRefFluxKeys (schema, filterName) |
| def | applyProperMotionsImpl (log, catalog, epoch) |
| def 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 999 of file loadReferenceObjects.py.
| def lsst.meas.algorithms.loadReferenceObjects.convertToNanojansky | ( | catalog, | |
| log, | |||
doConvert = True |
|||
| ) |
Convert fluxes in a catalog from jansky to nanojansky.
Parameters
----------
catalog : `lsst.afw.table.SimpleCatalog`
The catalog to convert.
log : `lsst.log.Log` or `logging.Logger`
Log to send messages to.
doConvert : `bool`, optional
Return a converted catalog, or just identify the fields that need to be converted?
This supports the "write=False" mode of `bin/convert_to_nJy.py`.
Returns
-------
catalog : `lsst.afw.table.SimpleCatalog` or None
The converted catalog, or None if ``doConvert`` is False.
Notes
-----
Support for old units in reference catalogs will be removed after the
release of late calendar year 2019.
Use `meas_algorithms/bin/convert_to_nJy.py` to update your reference catalog.
Definition at line 97 of file loadReferenceObjects.py.
| def 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 verison integer. Returns `0` if the catalog has no metadata
or the metadata does not include a "REFCAT_FORMAT_VERSION" key.
Definition at line 66 of file loadReferenceObjects.py.
| def 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 859 of file loadReferenceObjects.py.
| def 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 901 of file loadReferenceObjects.py.
| def lsst.meas.algorithms.loadReferenceObjects.hasNanojanskyFluxUnits | ( | schema | ) |
Return True if the units of all flux and fluxErr are correct (nJy).
Definition at line 57 of file loadReferenceObjects.py.
| def lsst.meas.algorithms.loadReferenceObjects.isOldFluxField | ( | name, | |
| units | |||
| ) |
Return True if this name/units combination corresponds to an "old-style" reference catalog flux field.
Definition at line 45 of file loadReferenceObjects.py.