Merge branch 'tickets/DM-27032'

lsst · Jun 11, 2021 · 76dc3df · 76dc3df
2 parents 516417f + b1e32db
commit 76dc3df
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/...iffim/tasks/lsst.ip.diffim.metrics.FractionDiaSourcesToSciSourcesMetricTask.rst b/...iffim/tasks/lsst.ip.diffim.metrics.FractionDiaSourcesToSciSourcesMetricTask.rst
@@ -5,7 +5,7 @@ FractionDiaSourcesToSciSourcesMetricTask
 ########################################
 
 ``FractionDiaSourcesToSciSourcesMetricTask`` computes the fraction of science sources that become DIASources when processed through image differencing (as the ``ip_diffim.fracDiaSourcesToSciSources`` metric).
-It requires source catalogs as input, and can operate at image-level or coarser granularity.
+It requires source catalogs as input, and can operate at image-level granularity.
 
 .. _lsst.ip.diffim.metrics.FractionDiaSourcesToSciSourcesMetricTask-summary:
 
@@ -14,6 +14,7 @@ Processing summary
 
 ``FractionDiaSourcesToSciSourcesMetricTask`` reads source catalogs (``src`` and ``deepDiff_diaSrc`` datasets, by default) and counts the number of sources.
 It then computes the ratio of DIASources to science sources for those catalogs.
+Non-primary sources are excluded from computations.
 
 .. _lsst.ip.diffim.metrics.FractionDiaSourcesToSciSourcesMetricTask-api:
 

diff --git a/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.metrics.NumberSciSourcesMetricTask.rst b/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.metrics.NumberSciSourcesMetricTask.rst
@@ -5,14 +5,14 @@ NumberSciSourcesMetricTask
 ##########################
 
 ``NumberSciSourcesMetricTask`` computes the number of science sources created when processing data through image differencing (as the ``ip_diffim.numSciSources`` metric).
-It requires source catalogs (a ``src`` dataset) as input, and can operate at image-level or coarser granularity.
+It requires source catalogs (a ``src`` dataset) as input, and can operate at image-level granularity.
 
 .. _lsst.ip.diffim.metrics.NumberSciSourcesMetricTask-summary:
 
 Processing summary
 ==================
 
-``FractionDiaSourcesToSciSourcesMetricTask`` reads source catalogs (``src`` datasets) and adds up the number of sources in those catalogs.
+``NumberSciSourcesToSciSourcesMetricTask`` reads source catalogs (``src`` datasets) and adds up the number of primary sources in those catalogs.
 
 .. _lsst.ip.diffim.metrics.NumberSciSourcesMetricTask-api:
 

diff --git a/python/lsst/ip/diffim/metrics.py b/python/lsst/ip/diffim/metrics.py
@@ -58,7 +58,7 @@ class NumberSciSourcesMetricConfig(
 
 @register("numSciSources")
 class NumberSciSourcesMetricTask(MetricTask):
-    """Task that computes the number of cataloged non-sky science sources.
+    """Task that computes the number of cataloged non-primary science sources.
 
     Notes
     -----
@@ -70,7 +70,7 @@ class NumberSciSourcesMetricTask(MetricTask):
     ConfigClass = NumberSciSourcesMetricConfig
 
     def run(self, sources):
-        """Count the number of non-sky science sources.
+        """Count the number of non-primary science sources.
 
         Parameters
         ----------
@@ -83,8 +83,8 @@ def run(self, sources):
             A `~lsst.pipe.base.Struct` containing the following component:
 
             ``measurement``
-                the total number of non-sky science sources (`lsst.verify.Measurement`
-                or `None`)
+                the total number of non-primary science sources
+                (`lsst.verify.Measurement` or `None`)
         """
         if sources is not None:
             nSciSources = _countRealSources(sources)
@@ -137,7 +137,7 @@ class FractionDiaSourcesToSciSourcesMetricTask(MetricTask):
     ConfigClass = FractionDiaSourcesToSciSourcesMetricConfig
 
     def run(self, sciSources, diaSources):
-        """Compute the ratio of DIASources to non-sky science sources.
+        """Compute the ratio of DIASources to non-primary science sources.
 
         Parameters
         ----------