NumberDeblendChildSourcesMetricTask

class lsst.pipe.tasks.metrics.NumberDeblendChildSourcesMetricTask(**kwargs)

Bases: MetricTask

Task that computes the number of science sources created through deblending.

This task only counts final deblending products; i.e., if deblending was run more than once or with multiple iterations, only the final set of deblended sources are counted, and not any intermediate ones. If sky source information is present, sky sources are excluded.

Notes

The task excludes any non-sky sources in the catalog, but it does not require that the catalog include a sky_sources column.

Methods Summary

run(sources)

Count the number of science sources created by deblending.

Methods Documentation

run(sources)

Count the number of science sources created by deblending.

Parameters

sourceslsst.afw.table.SourceCatalog

A science source catalog, which may be empty.

Returns

resultlsst.pipe.base.Struct

A Struct containing the following component:

measurement

the total number of science sources from deblending (lsst.verify.Measurement). If no deblending information is available in sources, this is None.

Raises

MetricComputationError

Raised if sources is missing mandatory keys for source catalogs.