LoadReferenceCatalogTask¶

LoadReferenceCatalogTask is a convenience task that combines the reference object loader adapted for multiple filters; color term application; and reference selection in one task. This task returns a numpy record array with the magnitude information for each of the physical filters requested by the caller.

If appropriate, all proper motion corrections are handled by the reference object loader as configured. Mapping from physical filter to reference filter is handled by the filterMap configured with the reference object loader, as well as the color term library.

The format of the reference catalogs returned by this task will be a numpy record array with the following datatype:

import numpy as np
dtype = [('ra', 'np.float64'),
         ('dec', 'np.float64'),
         ('refMag', 'np.float32', (len(filterList), )),
         ('refMagErr', 'np.float32', (len(filterList), ))]

Reference magnitudes (AB) and errors will be 99 for non-detections for a given reference filter.

Python API summary¶

from lsst.pipe.tasks.loadReferenceCatalog import LoadReferenceCatalogTask

classLoadReferenceCatalogTask(*, dataIds, refCats, name, **kwargs): Load multi-band reference objects from a reference catalog...

attributeconfig: Access configuration fields and retargetable subtasks.

Retargetable subtasks¶

referenceSelector¶

Default: lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask
Field type: ConfigurableField

Selection of reference sources

Configuration fields¶

colorterms¶

Data type: lsst.pipe.tasks.colorterms.ColortermLibrary
Field type: ConfigField

Library of photometric reference catalog name to color term dict.

doApplyColorTerms¶

Default: True
Field type: bool Field

Apply photometric color terms to reference stars? Requires that colorterms be set to a ColorTermLibrary

doReferenceSelection¶

Default: True
Field type: bool Field

Run the reference selector on the reference catalog?

refObjLoader¶

Data type: lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig
Field type: ConfigField

Configuration for the reference object loader.

Navigation