exceptions.py

Go to the documentation of this file.

import ids_peak_common.exceptions
from ids_peak_icv.backend.datatypes import peak_icv_status
 
 
class ICVException(ids_peak_common.exceptions.CommonException):
    """!
    @brief
    Base class for all exceptions thrown by the IDS peak ICV library.
 
    @param message: Exception message.
    @param status: peak_icv_status associated with the exception.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str, status: peak_icv_status):
        super().__init__(message)
        self.status = status
 
 
class InvalidConfigurationException(ICVException):
    """!
    @brief
    Thrown when the library configuration is invalid.
 
    This can occur if a required dependency is missing, the library is not initialized,
    or other misconfiguration issues arise.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str, status: peak_icv_status):
        super().__init__(message, status)
 
 
class InternalErrorException(
    ICVException,
    ids_peak_common.exceptions.InternalErrorException
):
    """!
    @brief
    Thrown on unexpected internal system errors.
 
    Occurs when a failure happens during processing due to an unhandled condition
    in the routine.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_INTERNAL_ERROR)
 
 
class MismatchException(ICVException):
    """!
    @brief
    Thrown when input parameters do not match the expected conditions.
 
    For example, this occurs when two input images have different sizes but identical sizes are required.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_MISMATCH)
 
 
class NotSupportedException(
    ICVException,
    ids_peak_common.exceptions.NotSupportedException
):
    """!
    @brief
    Thrown when a requested operation is not implemented or supported.
 
    This occurs, for example, when trying to export to an unsupported file format.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_NOT_SUPPORTED)
 
 
class NotPossibleException(ICVException):
    """!
    @brief
    Thrown when an operation cannot be performed due to logical constraints.
 
    For example, this occurs when attempting camera calibration without any input images.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_NOT_POSSIBLE)
 
 
class OutOfRangeException(
    ICVException,
    ids_peak_common.exceptions.OutOfRangeException
):
    """!
    @brief
    Thrown when a value is outside the allowed range.
 
    This occurs, for example, when setting opacity to 101 although the valid range is 0–100.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_OUT_OF_RANGE)
 
 
class MathErrorException(ICVException):
    """!
    @brief
    Thrown when a mathematical computation fails.
 
    This occurs, for example, in cases such as division by zero or invalid operations in matrix computations.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_MATH_ERROR)
 
 
class TargetNotFoundException(ICVException):
    """!
    @brief
    Thrown when an expected target object is not detected in the input image.
 
    This occurs, for example, when a calibration plate or marker is missing or not detected in an input image.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_TARGET_NOT_FOUND)
 
 
class CorruptedException(ICVException):
    """!
    @brief
    Thrown when input data or a file is malformed, unreadable, or otherwise corrupted.
 
    This occurs when reading from a file or stream that is incomplete, damaged, or in an unexpected format.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_CORRUPTED)
 
 
class IOException(
    ICVException,
    ids_peak_common.exceptions.IOException
):
    """!
    @brief
    Thrown when a file input/output operation fails.
 
    This can occur due to reasons such as a missing file, insufficient permissions, or an inaccessible directory.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_IO_ERROR)
 
 
class NullPointerException(ICVException):
    """!
    @brief
    Thrown when attempting to access an object or value that has not been initialized.
 
    Indicates usage of a null pointer.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_NULL_POINTER)