im2deep.exceptions

Custom exceptions for the IM2Deep package.

This module defines package-specific exception classes for clearer error handling and debugging.

Classes

IM2DeepError

Base exception class for all IM2Deep-related errors.

PSMMetadataError

Exception raised when PSM metadata has an invalid type or value.

CalibrationError

Exception raised when calibration-related errors occur.

exception im2deep.exceptions.IM2DeepError

Bases: Exception

Base exception class for all IM2Deep-related errors.

This class is the root for all custom IM2Deep exceptions, allowing users to catch package-specific errors with a single except clause.

args

Positional arguments passed to Exception.

Type:

tuple

Examples

>>> try:
...     predict(invalid_psm_list)
... except IM2DeepError as exc:
...     print(f"IM2Deep error occurred: {exc}")

exception im2deep.exceptions.PSMMetadataError

Bases: IM2DeepError, ValueError

Exception raised when PSM metadata violates IM2Deep expectations.

This is used when metadata is structurally present but contains invalid values for fields that IM2Deep needs to parse, such as non-numeric CCS.

exception im2deep.exceptions.CalibrationError

Bases: IM2DeepError

Exception raised when calibration-related errors occur.

Raised when issues in calibration inputs or procedures prevent successful CCS calibration.

Notes

Typical scenarios include:

• Insufficient overlap between calibration and reference peptides.

• Invalid calibration file format.

• Missing required columns in calibration data.

• Numerical instability during calibration calculation.

Examples

>>> try:
...     predict_and_calibrate(psm_list, psm_list_cal)
... except CalibrationError as exc:
...     print(f"Calibration failed: {exc}")