From 913bafb7a0a237b7624698918ec407aa824b4365 Mon Sep 17 00:00:00 2001 From: Evan Harvey Date: Tue, 12 Nov 2024 11:42:48 -0700 Subject: [PATCH] Add ImageType docstring --- .../spot_analysis/SpotAnalysisImagesStream.py | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/opencsp/common/lib/cv/spot_analysis/SpotAnalysisImagesStream.py b/opencsp/common/lib/cv/spot_analysis/SpotAnalysisImagesStream.py index ac7f3b2e7..dda5e7998 100644 --- a/opencsp/common/lib/cv/spot_analysis/SpotAnalysisImagesStream.py +++ b/opencsp/common/lib/cv/spot_analysis/SpotAnalysisImagesStream.py @@ -11,6 +11,32 @@ @functools.total_ordering class ImageType(Enum): + """ + Enumeration for different types of images used in analysis. + + This enumeration defines various image types that can be utilized in + image processing and analysis workflows. Each type serves a specific + purpose in the context of image comparison, background subtraction, + and other analytical tasks. + + Attributes + ---------- + PRIMARY : int + The image we are trying to analyze. + REFERENCE : int + Contains a pattern to be compared or matched with in the PRIMARY image. + NULL : int + The same as the PRIMARY image, but without a beam on target. + Likely used to subtract out the background. + COMPARISON : int + For multi-image comparison, such as for re-alignment to a previous + position, motion characterization, or measuring wind effect. + BACKGROUND_MASK : int + A boolean image that indicates which pixels should be included in + a computation (True to include, False to exclude). + """ + + # "ChatGPT 4o" assisted with generating this docstring. PRIMARY = 1 """ The image we are trying to analyze. """ REFERENCE = 2