LoadIndexedReferenceObjectsTask¶

LoadIndexedReferenceObjectsTask loads reference objects from a Hierarchical Triangular Mesh (HTM) indexed catalog ingested by IngestIndexedReferenceTask. For more details about loading reference catalogs, see LoadReferenceObjectsTask.

Python API summary¶

from lsst.meas.algorithms.loadIndexedReferenceObjects import LoadIndexedReferenceObjectsTask

classLoadIndexedReferenceObjectsTask(butler, *args, **kwargs): Load reference objects from an indexed catalog ingested by IngestIndexReferenceTask...

attributeconfig: Access configuration fields and retargetable subtasks.

Retargetable subtasks¶

No subtasks.

Configuration fields¶

anyFilterMapsToThis¶

Default: None
Field type: str Field (optional)

Always use this reference catalog filter, no matter whether or what filter name is supplied to the loader. Effectively a trivial filterMap: map all filter names to this filter. This can be set for purely-astrometric catalogs (e.g. Gaia DR2) where there is only one reasonable choice for every camera filter->refcat mapping, but not for refcats used for photometry, which need a filterMap and/or colorterms/transmission corrections.

defaultFilter¶

Default: ''
Field type: str Field

Default reference catalog filter to use if filter not specified in exposure; if blank then filter must be specified in exposure. Deprecated: defaultFilter is deprecated by RFC-716. Will be removed after v22.

filterMap¶

Default: {}
Field type: DictField
Key type: str
Value type: str

Mapping of camera filter name: reference catalog filter name; each reference filter must exist in the refcat. Note that this does not perform any bandpass corrections: it is just a lookup.

pixelMargin¶

Default: 250
Field type: int RangeField
Range: [0,inf)

Padding to add to 4 all edges of the bounding box (pixels)

ref_dataset_name¶

Default: 'cal_ref_cat'
Field type: str Field

Name of the ingested reference dataset

requireProperMotion¶

Default: False
Field type: bool Field

Require that the fields needed to correct proper motion (epoch, pm_ra and pm_dec) are present?

Navigation