Inheritance diagram for lsst.ip.diffim.metrics.FractionDiaSourcesToSciSourcesMetricTask:

Public Member Functions
def	run (self, sciSources, diaSources)

def	getOutputMetricName (cls, config)

Static Public Attributes
	ConfigClass = FractionDiaSourcesToSciSourcesMetricConfig

Detailed Description

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

Definition at line 108 of file metrics.py.

Member Function Documentation

◆ getOutputMetricName()

def lsst.ip.diffim.metrics.FractionDiaSourcesToSciSourcesMetricTask.getOutputMetricName	(	cls,
		config
	)

Definition at line 160 of file metrics.py.

◆ run()

def lsst.ip.diffim.metrics.FractionDiaSourcesToSciSourcesMetricTask.run	(	self,
		sciSources,
		diaSources
	)

Compute the ratio of DIASources to science sources.

Parameters
----------
sciSources : iterable of `lsst.afw.table.SourceCatalog`
    A collection of science source catalogs, one for each unit of
    processing to be incorporated into this metric. Its elements may
    be `None` to represent missing data.
diaSources : iterable of `lsst.afw.table.SourceCatalog`
    A collection of difference imaging catalogs similar to
    ``sciSources``.

Returns
-------
result : `lsst.pipe.base.Struct`
    A `~lsst.pipe.base.Struct` containing the following component:

    ``measurement``
the ratio (`lsst.verify.Measurement` or `None`)

Definition at line 115 of file metrics.py.

Member Data Documentation

◆ ConfigClass

lsst.ip.diffim.metrics.FractionDiaSourcesToSciSourcesMetricTask.ConfigClass = FractionDiaSourcesToSciSourcesMetricConfig

static

Definition at line 113 of file metrics.py.

The documentation for this class was generated from the following file:

python/lsst/ip/diffim/metrics.py