Source code for phenotypic.sdk_.constants_
"""PhenoTypic Constants
This module contains constant values and enumerations used throughout the PhenoTypic library.
Constants are organized by module and functionality.
Note: Class names are defined in ALL_CAPS to avoid namespace conflicts with actual classes
in the codebase (e.g., GRID_DEP vs an actual Grid class). When importing, use the format::
from phenotypic.sdk_.constants_ import IMAGE_MODE, IMAGE_TYPES
See also
--------
:mod:`phenotypic.sdk_._io_constants`
CLI artifact filenames, directory names, JSON contract keys, environment
variable names, and path helpers shared between the CLI and GUI.
:mod:`phenotypic.sdk_.typing_`
Literal type aliases for closed value sets used at public boundaries.
"""
import phenotypic
from enum import Enum
from packaging.version import Version
from pathlib import Path
from phenotypic.schema import Entry, MeasurementInfo
[docs]
class ConstantLabels(MeasurementInfo):
"""Base class for constant labels in phenotypic. This class is to distinguish
between ConstantLabels and MeasurementInfo usages."""
# Image format constants
[docs]
class IMAGE_MODE(Enum):
"""Constants for supported image formats."""
NONE = None
GRAYSCALE = "GRAYSCALE"
GRAYSCALE_SINGLE_CHANNEL = "Grayscale (single channel)"
HSV = "HSV"
RGB_OR_BGR = "RGB/BGR (ambiguous)"
RGBA_OR_BGRA = "RGBA/BGRA (ambiguous)"
RGB = "RGB"
LINEAR_RGB = "LINEAR RGB"
RGBA = "RGBA"
BGR = "BGR"
BGRA = "BGRA"
SUPPORTED_FORMATS = (RGB, RGBA, GRAYSCALE, BGR, BGRA)
MATRIX_FORMATS = (GRAYSCALE, GRAYSCALE_SINGLE_CHANNEL)
AMBIGUOUS_FORMATS = (RGB_OR_BGR, RGBA_OR_BGRA)
[docs]
def is_matrix(self):
return self in {IMAGE_MODE.GRAYSCALE, IMAGE_MODE.GRAYSCALE_SINGLE_CHANNEL}
[docs]
def is_array(self):
return self in {
IMAGE_MODE.RGB,
IMAGE_MODE.RGBA,
IMAGE_MODE.BGR,
IMAGE_MODE.BGRA,
IMAGE_MODE.LINEAR_RGB,
}
[docs]
def is_ambiguous(self):
return self in {IMAGE_MODE.RGB_OR_BGR, IMAGE_MODE.RGBA_OR_BGRA}
[docs]
def is_none(self):
return self is IMAGE_MODE.NONE
CHANNELS_DEFAULT = 3
DEFAULT_SCHEMA = RGB
[docs]
class GAMMA_ENCODINGS(ConstantLabels):
"""Constants for gamma encoding profiles used in color space conversions."""
[docs]
@classmethod
def category(cls) -> str:
return "GammaEncoding"
SRGB = Entry("sRGB", "Standard sRGB gamma correction for display")
LINEAR = Entry("Linear", "Linear RGB with no gamma correction")
[docs]
class IO:
RAW_FILE_EXTENSIONS = (
".cr2", ".CR2",
".cr3", ".CR3",
".nef", ".NEF",
".arw", ".ARW",
".dng", ".DNG",
)
PNG_FILE_EXTENSIONS = (".png", ".PNG")
JPEG_FILE_EXTENSIONS = (".jpeg", ".JPEG", ".jpg")
TIFF_EXTENSIONS = (".tif", ".tiff")
ACCEPTED_FILE_EXTENSIONS = (
PNG_FILE_EXTENSIONS
+ JPEG_FILE_EXTENSIONS
+ TIFF_EXTENSIONS
+ RAW_FILE_EXTENSIONS
)
# Key used for PhenoTypic metadata container in image files
PHENOTYPIC_METADATA_KEY = "phenotypic"
if Version(phenotypic.__version__) < Version("0.7.1"):
SINGLE_IMAGE_HDF5_PARENT_GROUP = Path("phenotypic/")
else:
SINGLE_IMAGE_HDF5_PARENT_GROUP = "/phenotypic/images/"
IMAGE_SET_HDF5_PARENT_GROUP = "/phenotypic/image_sets/"
IMAGE_MEASUREMENT_IMAGE_SUBGROUP_KEY = "measurements"
IMAGE_STATUS_SUBGROUP_KEY = "status"
# Feature extraction constants
# TODO: Fix this constant access pattern
[docs]
class IMAGE_TYPES(Enum):
"""The string labels for different types of images generated when accessing subimages of a parent image."""
BASE = "Image"
CROP = "Crop"
OBJECT = "Object"
GRID = "GridImage"
GRID_SECTION = "GridSection"
def __str__(self):
return self.value
[docs]
class PIPE_STATUS(MeasurementInfo):
"""Constants for image set status."""
[docs]
@classmethod
def category(cls) -> str:
return "Status"
PROCESSED = Entry("Processed", "Whether the image has been processed successfully.")
MEASURED = Entry("Measured", "Whether the image has been measured successfully.")
