lsst.ip.diffim.metrics Namespace Reference

Classes
class	NumberSciSourcesMetricConnections

Variables
	sources : `lsst.afw.table.SourceCatalog`
	result : `lsst.pipe.base.Struct`
	sciSources : `lsst.afw.table.SourceCatalog`
	diaSources : `lsst.afw.table.SourceCatalog`
	count : `int`

Variable Documentation

count

lsst.ip.diffim.metrics.count : `int`

nSciSources = _countRealSources(sciSources)
nDiaSources = _countRealSources(diaSources)
metricName = self.config.metricName
if nSciSources <= 0:
    raise MetricComputationError(
        "No science sources found; ratio of DIASources to science sources ill-defined.")
else:
    meas = Measurement(metricName, nDiaSources / nSciSources * u.dimensionless_unscaled)
return Struct(measurement=meas)


def _countRealSources(catalog):

Definition at line 177 of file metrics.py.

diaSources

lsst.ip.diffim.metrics.diaSources : `lsst.afw.table.SourceCatalog`

Definition at line 139 of file metrics.py.

result

lsst.ip.diffim.metrics.result : `lsst.pipe.base.Struct`

Definition at line 80 of file metrics.py.

sciSources

lsst.ip.diffim.metrics.sciSources : `lsst.afw.table.SourceCatalog`

nSciSources = _countRealSources(sources)
meas = Measurement(self.config.metricName, nSciSources * u.count)
return Struct(measurement=meas)


class FractionDiaSourcesToSciSourcesMetricConnections(
MetricTask.ConfigClass.ConnectionsClass,
dimensions={"instrument", "visit", "detector"},
defaultTemplates={"coaddName": "deep",
                  "fakesType": "",
                  "package": "ip_diffim",
                  "metric": "fracDiaSourcesToSciSources"}):
sciSources = connectionTypes.Input(
doc="The catalog of science sources.",
name="src",
storageClass="SourceCatalog",
dimensions={"instrument", "visit", "detector"},
)
diaSources = connectionTypes.Input(
doc="The catalog of DIASources.",
name="{fakesType}{coaddName}Diff_diaSrc",
storageClass="SourceCatalog",
dimensions={"instrument", "visit", "detector"},
)


class FractionDiaSourcesToSciSourcesMetricConfig(
MetricTask.ConfigClass,
pipelineConnections=FractionDiaSourcesToSciSourcesMetricConnections):
pass


class FractionDiaSourcesToSciSourcesMetricTask(MetricTask):

_DefaultName = "fracDiaSourcesToSciSources"
ConfigClass = FractionDiaSourcesToSciSourcesMetricConfig

def run(self, sciSources, diaSources):

Definition at line 137 of file metrics.py.

sources

lsst.ip.diffim.metrics.sources : `lsst.afw.table.SourceCatalog`

_DefaultName = "numSciSources"
ConfigClass = NumberSciSourcesMetricConfig

def run(self, sources):

Definition at line 75 of file metrics.py.