Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-30869: Modernize MetricTask for better Gen 3 workflow #233

Merged
merged 1 commit into from
Sep 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 15 additions & 23 deletions python/lsst/ip/diffim/metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ class NumberSciSourcesMetricTask(MetricTask):
ConfigClass = NumberSciSourcesMetricConfig

def run(self, sources):
"""Count the number of non-primary science sources.
"""Count the number of primary science sources.

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

Returns
-------
Expand All @@ -84,12 +84,8 @@ def run(self, sources):
the total number of non-primary science sources
(`lsst.verify.Measurement` 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
nSciSources = _countRealSources(sources)
meas = Measurement(self.config.metricName, nSciSources * u.count)
return Struct(measurement=meas)


Expand Down Expand Up @@ -138,9 +134,9 @@ def run(self, sciSources, diaSources):

Parameters
----------
sciSources : `lsst.afw.table.SourceCatalog` or `None`
A science source catalog, which may be empty or `None`.
diaSources : `lsst.afw.table.SourceCatalog` or `None`
sciSources : `lsst.afw.table.SourceCatalog`
A science source catalog, which may be empty.
diaSources : `lsst.afw.table.SourceCatalog`
A DIASource catalog for the same unit of processing
as ``sciSources``.

Expand All @@ -152,18 +148,14 @@ def run(self, sciSources, diaSources):
``measurement``
the ratio (`lsst.verify.Measurement` or `None`)
"""
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)
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:
self.log.info("Nothing to do: no catalogs found.")
meas = None
meas = Measurement(metricName, nDiaSources / nSciSources * u.dimensionless_unscaled)
return Struct(measurement=meas)


Expand Down
18 changes: 0 additions & 18 deletions tests/test_metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,6 @@ def testPrimarySources(self):
self.assertEqual(meas.metric_name, Name(metric="ip_diffim.numSciSources"))
assert_quantity_allclose(meas.quantity, 1 * u.count)

def testMissingData(self):
result = self.task.run(None)
lsst.pipe.base.testUtils.assertValidOutput(self.task, result)
meas = result.measurement
self.assertIsNone(meas)


class TestFractionDiaSources(MetricTaskTestCase):

Expand Down Expand Up @@ -157,18 +151,6 @@ def testEmptyCatalogs(self):
with self.assertRaises(MetricComputationError):
self.task.run(sciCatalog, diaCatalog)

def testMissingData(self):
result = self.task.run(None, None)
lsst.pipe.base.testUtils.assertValidOutput(self.task, result)
meas = result.measurement
self.assertIsNone(meas)

def testSemiMissingData(self):
result = self.task.run(sciSources=_makeDummyCatalog(3), diaSources=None)
lsst.pipe.base.testUtils.assertValidOutput(self.task, result)
meas = result.measurement
self.assertIsNone(meas)

def testSkySources(self):
sciCatalog = _makeDummyCatalog(5, skyFlag=True)
diaCatalog = _makeDummyCatalog(3)
Expand Down