From 88632a43141ce41994b009f9b38ce28719b4d7cd Mon Sep 17 00:00:00 2001 From: Evan Harvey <57234914+e10harvey@users.noreply.github.com> Date: Wed, 11 Dec 2024 16:27:59 -0700 Subject: [PATCH] Update opencsp/common/lib/cv/annotations/HotspotAnnotation.py Co-authored-by: Ben Bean <144833583+bbean23@users.noreply.github.com> --- opencsp/common/lib/cv/annotations/HotspotAnnotation.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/opencsp/common/lib/cv/annotations/HotspotAnnotation.py b/opencsp/common/lib/cv/annotations/HotspotAnnotation.py index 41d8f3109..837f651d4 100644 --- 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.