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 library.
 
    @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
    Occurs when a required dependency is missing, the library is not initialized, or a misconfiguration arises.
 
    @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
    Occurs when a failure happens during processing due to an unhandled internal routine condition.
 
    @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
    Occurs when input parameters do not match expected conditions (e.g., two input images have different sizes).
 
    @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
    Occurs when a requested operation is not implemented or supported (e.g., exporting 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
    Occurs when an operation cannot be performed due to logical constraints (e.g., camera calibration without 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
    Occurs when a provided value falls outside the allowed valid range.
 
    @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
    Occurs when a mathematical computation fails (e.g., division by zero or invalid matrix operations).
 
    @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
    Occurs when an expected target object (e.g., calibration plate or marker) is not detected in the 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
    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
    Occurs when a file operation fails (e.g., missing file, insufficient permissions, or 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
    Occurs when attempting to access an object or value via an uninitialized or null pointer.
 
    @since ids_peak_icv 1.0
    """
 
    def __init__(self, message: str):
        super().__init__(message, peak_icv_status.PEAK_ICV_STATUS_NULL_POINTER)