Update opencsp/common/lib/cv/annotations/HotspotAnnotation.py

Co-authored-by: Ben Bean <[email protected]>
sandialabs · Dec 11, 2024 · 88632a4 · 88632a4
1 parent 3ba64cc
commit 88632a4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/opencsp/common/lib/cv/annotations/HotspotAnnotation.py b/opencsp/common/lib/cv/annotations/HotspotAnnotation.py
@@ -5,7 +5,9 @@
 
 class HotspotAnnotation(PointAnnotations):
     """
-    A class representing a hotspot annotation in a graphical context.
+    A class representing a hotspot annotation, likely created from a :py:class:`HotspotImageProcessor` instance.
+    
+    The hotspot is the overall hottest location in an image, when accounting for the surrounding area. It may be the different from the centroid location or the single hottest pixel location.
 
     This class extends the `PointAnnotations` class to create a specific type of annotation
     that represents a hotspot, which can be rendered with a specific style and point location.