lsst.ip.diffim  18.1.0-15-g5db401e+4
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.diffim.metrics.NumberSciSourcesMetricTask Class Reference
Inheritance diagram for lsst.ip.diffim.metrics.NumberSciSourcesMetricTask:

Public Member Functions

def run (self, sources)
 
def getOutputMetricName (cls, config)
 

Static Public Attributes

 ConfigClass = NumberSciSourcesMetricConfig
 

Detailed Description

Task that computes the number of cataloged science sources.

Definition at line 55 of file metrics.py.

Member Function Documentation

◆ getOutputMetricName()

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

Definition at line 87 of file metrics.py.

◆ run()

def lsst.ip.diffim.metrics.NumberSciSourcesMetricTask.run (   self,
  sources 
)
Count the number of science sources.

Parameters
----------
sources : `lsst.afw.table.SourceCatalog` or `None`
    A science source catalog, which may be empty or `None`.

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

    ``measurement``
the total number of science sources (`lsst.verify.Measurement`
or `None`)

Definition at line 61 of file metrics.py.

Member Data Documentation

◆ ConfigClass

lsst.ip.diffim.metrics.NumberSciSourcesMetricTask.ConfigClass = NumberSciSourcesMetricConfig
static

Definition at line 59 of file metrics.py.


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