Skip to content

Commit

Permalink
Fix reference links
Browse files Browse the repository at this point in the history
  • Loading branch information
e10harvey committed Dec 12, 2024
1 parent a8796fe commit 5ecfb13
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 7 deletions.
2 changes: 1 addition & 1 deletion opencsp/common/lib/cv/annotations/HotspotAnnotation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 1 addition & 6 deletions opencsp/common/lib/cv/annotations/PointAnnotations.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 5ecfb13

Please sign in to comment.