FractionDiaSourcesToSciSourcesMetricTask

class lsst.ip.diffim.metrics.FractionDiaSourcesToSciSourcesMetricTask(**kwargs)

Bases: MetricTask

Task that computes the ratio of difference image sources to science sources in an image, visit, etc.

Notes

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

Methods Summary

run(sciSources, diaSources)

Compute the ratio of DIASources to non-primary science sources.

Methods Documentation

run(sciSources, diaSources)

Compute the ratio of DIASources to non-primary science sources.

Parameters

sciSourceslsst.afw.table.SourceCatalog

A science source catalog, which may be empty.

diaSourceslsst.afw.table.SourceCatalog

A DIASource catalog for the same unit of processing as sciSources.

Returns

resultlsst.pipe.base.Struct

A Struct containing the following component:

measurement

the ratio (lsst.verify.Measurement or None)