lsst.ip.diffim gaa63f70f4e+5e034ae04a
Loading...
Searching...
No Matches
Classes | Variables
lsst.ip.diffim.metrics Namespace Reference

Classes

class  NumberSciSourcesMetricConnections
 

Variables

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

Variable Documentation

◆ count

int lsst.ip.diffim.metrics.count : `int`
if diaSources is not None and sciSources is not None:
    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)
else:
    self.log.info("Nothing to do: no catalogs found.")
    meas = None
return Struct(measurement=meas)


def _countRealSources(catalog):

Definition at line 188 of file metrics.py.

◆ diaSources

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

Definition at line 146 of file metrics.py.

◆ result

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

Definition at line 82 of file metrics.py.

◆ sciSources

lsst lsst.ip.diffim.metrics.sciSources : `lsst.afw.table.SourceCatalog` or `None`
if sources is not None:
    nSciSources = _countRealSources(sources)
    meas = Measurement(self.config.metricName, nSciSources * u.count)
else:
    self.log.info("Nothing to do: no catalogs found.")
    meas = None
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


@register("fracDiaSourcesToSciSources")
class FractionDiaSourcesToSciSourcesMetricTask(MetricTask):
_DefaultName = "fracDiaSourcesToSciSources"
ConfigClass = FractionDiaSourcesToSciSourcesMetricConfig

def run(self, sciSources, diaSources):

Definition at line 144 of file metrics.py.

◆ sources

lsst lsst.ip.diffim.metrics.sources : `lsst.afw.table.SourceCatalog` or `None`
_DefaultName = "numSciSources"
ConfigClass = NumberSciSourcesMetricConfig

def run(self, sources):

Definition at line 77 of file metrics.py.