Merge pull request #196 from lsst/tickets/DM-32046

DM-32046: Add a note to HTMIndexDiaPosition plugin
lsst · Oct 12, 2021 · 61eb88f · 61eb88f
2 parents 126824a + 5f3adf0
commit 61eb88f
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/python/lsst/meas/base/diaCalculationPlugins.py b/python/lsst/meas/base/diaCalculationPlugins.py
@@ -147,6 +147,13 @@ class HTMIndexDiaPositionConfig(DiaObjectCalculationPluginConfig):
 @register("ap_HTMIndex")
 class HTMIndexDiaPosition(DiaObjectCalculationPlugin):
     """Compute the mean position of a DiaObject given a set of DiaSources.
+
+    Notes
+    -----
+    This plugin was implemented to satisfy requirements of old APDB interface
+    which required ``pixelId`` column in DiaObject with HTM20 index. APDB
+    interface had migrated to not need that information, but we keep this
+    plugin in case it may be useful for something else.
     """
     ConfigClass = HTMIndexDiaPositionConfig