NumSourcesMatchedTask

class lsst.faro.base.NumSourcesMatchedTask(config: Config | None = None, *, name: str | None = None, parentTask: Task | None = None, log: logging.Logger | lsst.utils.logging.LsstLogAdapter | None = None)

Bases: NumSourcesTask

Extension of NumSourcesTask to count sources in a matched catalog

Methods Summary

run(metricName, matchedCatalog, **kwargs)

Run NumSourcesTask Parameters ---------- metricName : str The name of the metric to measure. catalog : dict lsst.afw.table Catalog type kwargs Extra keyword arguments used to construct the task. Returns ------- measurement : Struct The measured value of the metric.

Methods Documentation

run(metricName: str, matchedCatalog: SourceCatalog, **kwargs)

Run NumSourcesTask Parameters ———- metricName : str

The name of the metric to measure.

catalogdict

lsst.afw.table Catalog type

kwargs

Extra keyword arguments used to construct the task.

Returns

measurementStruct

The measured value of the metric.