NumberSciSourcesMetricTask

NumberSciSourcesMetricTask computes the number of science sources created when processing data through image differencing (as the ip_diffim.numSciSources metric). It requires source catalogs (a src dataset) as input, and can operate at image-level granularity.

Processing summary

NumberSciSourcesToSciSourcesMetricTask reads source catalogs (src datasets) and adds up the number of primary sources in those catalogs.

Python API summary

from lsst.ip.diffim.metrics import NumberSciSourcesMetricTask
classNumberSciSourcesMetricTask(**kwargs)

Task that computes the number of cataloged non-primary science sources...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(sources)

Count the number of primary science sources...

See also

See the NumberSciSourcesMetricTask 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.NumberSciSourcesMetricConfigConnections

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. Deprecated: This field is deprecated and will be removed after v26.