MatchedBaseTask

Python API summary

from lsst.faro.base.MatchedCatalogBase import MatchedBaseTask
classMatchedBaseTask(config: lsst.faro.base.MatchedCatalogBase.MatchedBaseConfig, *args, **kwargs)

Base class for all pipeline tasks...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(sourceCatalogs, photoCalibs, astromCalibs, dataIds, wcs, box, doApplyExternalSkyWcs=False, doApplyExternalPhotoCalib=False)

Run task algorithm on in-memory data...

See also

See the MatchedBaseTask API reference for complete details.

Retargetable subtasks

No subtasks.

Configuration fields

brightMagCut

Default
10.0
Field type
float Field
Bright limit of catalog entries to include.

connections

Data type
lsst.pipe.base.config.Connections
Field type
ConfigField
Configurations describing the connections of the PipelineTask to datatypes

doApplyExternalPhotoCalib

Default
False
Field type
bool Field
Whether or not to use the external photoCalib.

doApplyExternalSkyWcs

Default
False
Field type
bool Field
Whether or not to use the external wcs.

faintMagCut

Default
30.0
Field type
float Field
Faint limit of catalog entries to include.

match_radius

Default
1
Field type
float Field
Match radius in arcseconds.

saveLogOutput

Default
True
Field type
bool Field
Flag to enable/disable saving of log output for a task, enabled by default.

saveMetadata

Default
True
Field type
bool Field
Flag to enable/disable metadata saving for a task, enabled by default.

selectExtended

Default
False
Field type
bool Field
Whether to select extended sources

snrMax

Default
inf
Field type
float Field
Maximum SNR for a source to be included.

snrMin

Default
200
Field type
float Field
Minimum SNR for a source to be included.

useGlobalExternalPhotoCalib

Default
False
Field type
bool Field
Whether or not to use the global external photoCalib.

useGlobalExternalSkyWcs

Default
False
Field type
bool Field
Whether or not to use the global external wcs.