From 5ecfb13684f4261e52b1bd371f684e9e2b3b1422 Mon Sep 17 00:00:00 2001 From: Evan Harvey Date: Wed, 11 Dec 2024 17:06:20 -0700 Subject: [PATCH] Fix reference links --- opencsp/common/lib/cv/annotations/HotspotAnnotation.py | 2 +- opencsp/common/lib/cv/annotations/PointAnnotations.py | 7 +------ 2 files changed, 2 insertions(+), 7 deletions(-) diff --git a/opencsp/common/lib/cv/annotations/HotspotAnnotation.py b/opencsp/common/lib/cv/annotations/HotspotAnnotation.py index e2a08a97..534ee732 100644 --- a/opencsp/common/lib/cv/annotations/HotspotAnnotation.py +++ b/opencsp/common/lib/cv/annotations/HotspotAnnotation.py @@ -5,7 +5,7 @@ class HotspotAnnotation(PointAnnotations): """ - A class representing a hotspot annotation, likely created from a :py:class:`HotspotImageProcessor` instance. + A class representing a hotspot annotation, likely created from a :py:class:`opencsp.common.lib.cv.spot_analysis.image_processor.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. diff --git a/opencsp/common/lib/cv/annotations/PointAnnotations.py b/opencsp/common/lib/cv/annotations/PointAnnotations.py index 2ad0ba7c..52d2a9f6 100644 --- a/opencsp/common/lib/cv/annotations/PointAnnotations.py +++ b/opencsp/common/lib/cv/annotations/PointAnnotations.py @@ -6,16 +6,11 @@ class PointAnnotations(pf.PointFiducials, AbstractAnnotations): """ A class representing point annotations. - An example of this class is :py:class:`HotspotAnnotation`. + An example of this class is :py:class:`opencsp.common.lib.cv.annotations.HotspotAnnotation.HotspotAnnotation`. This class extends both `PointFiducials` and `AbstractAnnotations` to provide functionality for managing and rendering point annotations, which can be used to mark specific locations in a visual representation. - - Inherits from: - --------------- - pf.PointFiducials : Implements methods from AbstractFiducial for point fiducials, and provides related attributes. - AbstractAnnotations : Provides an abstract base for annotation classes. """ # "ChatGPT 4o" assisted with generating this docstring.