Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ImageType docstring
Browse files Browse the repository at this point in the history
e10harvey committed Nov 12, 2024
1 parent 0146dab commit 913bafb
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions opencsp/common/lib/cv/spot_analysis/SpotAnalysisImagesStream.py
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 913bafb

Please sign in to comment.