Exceptions

spectrakit.exceptions.SpectraKitError

Bases: Exception

Base exception for all SpectraKit errors.

Source code in src/spectrakit/exceptions.py

class SpectraKitError(Exception):
    """Base exception for all SpectraKit errors."""

spectrakit.exceptions.SpectrumShapeError

Bases: SpectraKitError, ValueError

Raised when array shapes are incompatible.

Examples:

>>> raise SpectrumShapeError(
...     "Expected 1D or 2D array, got shape (3, 4, 5)"
... )

Source code in src/spectrakit/exceptions.py

class SpectrumShapeError(SpectraKitError, ValueError):
    """Raised when array shapes are incompatible.

    Examples:
        >>> raise SpectrumShapeError(
        ...     "Expected 1D or 2D array, got shape (3, 4, 5)"
        ... )
    """

spectrakit.exceptions.FileFormatError

Bases: SpectraKitError, ValueError

Raised when a spectral file cannot be parsed.

Examples:

>>> raise FileFormatError("No XYDATA block found in sample.jdx")

Source code in src/spectrakit/exceptions.py

class FileFormatError(SpectraKitError, ValueError):
    """Raised when a spectral file cannot be parsed.

    Examples:
        >>> raise FileFormatError("No XYDATA block found in sample.jdx")
    """

spectrakit.exceptions.DependencyError

Bases: SpectraKitError, ImportError

Raised when an optional dependency is missing.

Examples:

>>> raise DependencyError(
...     "h5py is required for HDF5 files. "
...     "Install with: pip install spectrakit[io]"
... )

Source code in src/spectrakit/exceptions.py

class DependencyError(SpectraKitError, ImportError):
    """Raised when an optional dependency is missing.

    Examples:
        >>> raise DependencyError(
        ...     "h5py is required for HDF5 files. "
        ...     "Install with: pip install spectrakit[io]"
        ... )
    """

spectrakit.exceptions.EmptySpectrumError

Bases: SpectraKitError, ValueError

Raised when input spectrum is empty or has insufficient points.

Examples:

>>> raise EmptySpectrumError("intensities array is empty")

Source code in src/spectrakit/exceptions.py

class EmptySpectrumError(SpectraKitError, ValueError):
    """Raised when input spectrum is empty or has insufficient points.

    Examples:
        >>> raise EmptySpectrumError("intensities array is empty")
    """