phenotypic.tools_.exceptions_

PhenoTypic Exceptions

This module contains all exceptions used throughout the PhenoTypic library. Exceptions are organized by module and functionality.

Exceptions

ArrayKeyValueShapeMismatchError()	Exception raised when the shape of the other_image doesn't match the key's section.
DataIntegrityError(component, operation[, ...])	Exception raised when data integrity is compromised.
EmptyImageError()	Exception raised when no image data is loaded.
GrayscaleOutOfRangeError(value)	Exception raised when grayscale is out of range.
GridImageInputError()	Exception raised when a non-GriddedImage object is provided as arr.
IllegalAssignmentError(attr)	Exception raised when trying to directly assign a new object to a protected attribute.
IllegalElementAssignmentError(component_name)	Exception raised when trying to change rgb/gray elements directly.
ImageOperationError	Base exception for image operation errors.
ImmutableComponentError	Base exception for immutable component errors.
InputShapeMismatchError(param_name)	Exception raised when arr shape doesn't match the image gray.
InterfaceError()	Exception raised when an abc_ method is called when it's not supposed to be.
InvalidHsvSchemaError(imformat)	Exception raised when trying to convert to HSV from a non-RGB imformat.
InvalidMapValueError(value_type)	Exception raised when trying to set object map with invalid other_image type.
InvalidMaskScalarValueError()	Exception raised when trying to set mask with invalid scalar other_image.
InvalidMaskValueError(value_type)	Exception raised when trying to set mask with invalid other_image type.
InvalidShapeError(component)	Exception raised when a shape mismatch occurs.
MetadataKeySpacesError()	Exception raised when metadata key contains spaces.
MetadataKeyValueError(type_received)	Exception raised when metadata key is not a string.
MetadataValueNonScalarError(type_value)	Exception raised when metadata other_image is not scalar.
NoArrayError()	Exception raised when no array is found.
NoComponentError(component)	Exception raised when a required object is missing.
NoImageDataError()	Exception raised when no image data is loaded.
NoObjectsError([image_name])	Exception raised when no objects are found in an image.
NoOutputError()	Exception raised when no output was returned in an operation.
ObjectNotFoundError(label)	Exception raised when an object with a specified label is not found.
OperationFailedError(operation, image_name, ...)	Exception raised when an operation fails.
OperationIntegrityError(opname, component[, ...])	Exception raised when an operation attempts to change a component it shouldn't.
OutputValueError(expected_type)	Exception raised when output is not of the expected type.
PhenoTypicError	Base exception class for all PhenoTypic errors.
UUIDReassignmentError()	Exception raised when trying to change the UUID metadata.
UnknownError([message])	Exception raised when an unknown error occurs.
UnsupportedFileTypeError(suffix)	Exception raised when trying to read an unsupported file type.
UnsupportedImageFormat(imformat)	Represents an error when an unsupported imformat format is detected.
UuidAssignmentError()	Exception raised when trying to change the UUID of an image.

exception phenotypic.tools_.exceptions_.ArrayKeyValueShapeMismatchError

Bases: ValueError

Exception raised when the shape of the other_image doesn’t match the key’s section.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.DataIntegrityError(component, operation, image_name=None)

Bases: AttributeError

Exception raised when data integrity is compromised.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.EmptyImageError

Bases: AttributeError

Exception raised when no image data is loaded.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.GrayscaleOutOfRangeError(value)

Bases: PhenoTypicError

Exception raised when grayscale is out of range.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.GridImageInputError

Bases: ValueError

Exception raised when a non-GriddedImage object is provided as arr.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.IllegalAssignmentError(attr)

Bases: ValueError

Exception raised when trying to directly assign a new object to a protected attribute.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.IllegalElementAssignmentError(component_name)

Bases: ImmutableComponentError

Exception raised when trying to change rgb/gray elements directly.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.ImageOperationError

Bases: PhenoTypicError

Base exception for image operation errors.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.ImmutableComponentError

Bases: AttributeError

Base exception for immutable component errors.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.InputShapeMismatchError(param_name)

Bases: ValueError

Exception raised when arr shape doesn’t match the image gray.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.InterfaceError

Bases: NotImplementedError, PhenoTypicError

Exception raised when an abc_ method is called when it’s not supposed to be.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.InvalidHsvSchemaError(imformat)

Bases: AttributeError

Exception raised when trying to convert to HSV from a non-RGB imformat.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.InvalidMapValueError(value_type)

Bases: ValueError

Exception raised when trying to set object map with invalid other_image type.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.InvalidMaskScalarValueError

Bases: ValueError

Exception raised when trying to set mask with invalid scalar other_image.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.InvalidMaskValueError(value_type)

Bases: ValueError

Exception raised when trying to set mask with invalid other_image type.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.InvalidShapeError(component)

Bases: ValueError

Exception raised when a shape mismatch occurs.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.MetadataKeySpacesError

Bases: TypeError

Exception raised when metadata key contains spaces.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.MetadataKeyValueError(type_received)

Bases: ValueError

Exception raised when metadata key is not a string.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.MetadataValueNonScalarError(type_value)

Bases: TypeError

Exception raised when metadata other_image is not scalar.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.NoArrayError

Bases: AttributeError

Exception raised when no array is found.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.NoComponentError(component)

Bases: AttributeError

Exception raised when a required object is missing.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.NoImageDataError

Bases: AttributeError

Exception raised when no image data is loaded.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.NoObjectsError(image_name=None)

Bases: AttributeError

Exception raised when no objects are found in an image.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.NoOutputError

Bases: PhenoTypicError

Exception raised when no output was returned in an operation.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.ObjectNotFoundError(label)

Bases: AttributeError

Exception raised when an object with a specified label is not found.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.OperationFailedError(operation, image_name, err_type, message)

Bases: ImageOperationError

Exception raised when an operation fails.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.OperationIntegrityError(opname: str, component: str, image_name=None)

Bases: AttributeError

Exception raised when an operation attempts to change a component it shouldn’t.

Parameters:

• opname (str)

• component (str)

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.OutputValueError(expected_type)

Bases: PhenoTypicError

Exception raised when output is not of the expected type.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.PhenoTypicError

Bases: Exception

Base exception class for all PhenoTypic errors.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.UUIDReassignmentError

Bases: AttributeError

Exception raised when trying to change the UUID metadata.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object

exception phenotypic.tools_.exceptions_.UnknownError(message='An unknown error occurred.')

Bases: PhenoTypicError

Exception raised when an unknown error occurs.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.UnsupportedFileTypeError(suffix)

Bases: ValueError

Exception raised when trying to read an unsupported file type.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.UnsupportedImageFormat(imformat)

Bases: ValueError

Represents an error when an unsupported imformat format is detected.

This error is raised when a specified imformat format is not supported by the application or library that utilizes this exception class.

Parameters:

schema (str) – The imformat format that triggered this exception.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception phenotypic.tools_.exceptions_.UuidAssignmentError

Bases: AttributeError

Exception raised when trying to change the UUID of an image.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

name

attribute name

obj

object