PatchMatchedPreparationTask

Python API summary

from lsst.faro.preparation.MatchedPreparationTasks import PatchMatchedPreparationTask
classPatchMatchedPreparationTask(config, *args, **kwargs)

Base class for all pipeline tasks...

attributeconfig

Access configuration fields and retargetable subtasks.

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

Run task algorithm on in-memory data...

See also

See the PatchMatchedPreparationTask 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.PatchMatchedPreparationConfigConnections

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. Deprecated: Deprecated in favor of the visitSummary connection; will be removed after v26.

doApplyExternalSkyWcs

Default
False
Field type

bool Field

Whether or not to use the external wcs. Deprecated: Deprecated in favor of the visitSummary connection; will be removed after v26.

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.

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. Deprecated: Deprecated in favor of the visitSummary connection; will be removed after v26.

useGlobalExternalSkyWcs

Default
False
Field type

bool Field

Whether or not to use the global external wcs. Deprecated: Deprecated in favor of the visitSummary connection; will be removed after v26.