Clarify dipole orientation convention.

lsst · Jun 3, 2024 · 7d40c75 · 7d40c75
1 parent 3a940c3
commit 7d40c75
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/python/lsst/ip/diffim/dipoleFitTask.py b/python/lsst/ip/diffim/dipoleFitTask.py
@@ -1019,7 +1019,7 @@ def _setupSchema(self, config, name, schema, metadata):
 
         self.orientationKey = schema.addField(
             schema.join(name, "orientation"), type=float, units="rad",
-            doc="Dipole orientation")
+            doc="Dipole orientation.  Convention is CCW from +x on image.")
 
         self.separationKey = schema.addField(
             schema.join(name, "separation"), type=float, units="pixel",