Skip to content

Commit

Permalink
Fixup from rebase
Browse files Browse the repository at this point in the history
  • Loading branch information
e10harvey committed Nov 25, 2024
1 parent 2f40b73 commit ca03e12
Showing 1 changed file with 0 additions and 45 deletions.
45 changes: 0 additions & 45 deletions opencsp/common/lib/cv/spot_analysis/SpotAnalysisImagesStream.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,51 +10,6 @@
import opencsp.common.lib.tool.typing_tools as tt


@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
""" Contains a pattern to be compared or matched with in the PRIMARY image. """
NULL = 3
""" The same as the PRIMARY image, but without a beam on target. Likely this will be used to subtract out the background. """
COMPARISON = 4
""" For multi-image comparison, such as for re-alignment to a previous position, motion characterization, or measuring wind effect. """
BACKGROUND_MASK = 5
""" A boolean image that indicates which pixels should be included in a computation (True to include, False to exclude). """

def __lt__(self, other):
if isinstance(other, self.__class__):
return self.value < other.value
raise NotImplementedError


class SpotAnalysisImagesStream(Iterator[dict[ImageType, CacheableImage]]):
"""
This class combines the image streams for several SpotAnalysisImageTypes into
Expand Down

0 comments on commit ca03e12

Please sign in to comment.