NumberDeblendedSourcesMetricTask

NumberDeblendedSourcesMetricTask computes the number of science sources deblended when processing data through single-frame processing (as the pipe_tasks.numDeblendedSciSources metric). It requires source catalogs (by default, a src dataset) as input, and operates at image-level granularity.

Processing summary

NumberDeblendedSourcesMetricTask reads source catalogs (src datasets, by default) and adds up the number of deblended top-level sources in those catalogs. Sky sources, and sources that are themselves the result of deblending, are not counted.

Python API summary

from lsst.pipe.tasks.metrics import NumberDeblendedSourcesMetricTask
classNumberDeblendedSourcesMetricTask(**kwargs)

Task that computes the number of science sources that have been deblended...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(sources)

Count the number of deblended science sources...

See also

See the NumberDeblendedSourcesMetricTask API reference for complete details.

Butler datasets

Input datasets

sources

The catalog type for science sources (default: src).

Retargetable subtasks

No subtasks.

Configuration fields

connections

Data type

lsst.pipe.base.config.NumberDeblendedSourcesMetricConfigConnections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

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.