coretex.coretex.annotation.image.coretex_format.CoretexImageAnnotation Class Reference

Inheritance diagram for coretex.coretex.annotation.image.coretex_format.CoretexImageAnnotation:

Public Member Functions
Self	create (cls, str name, float width, float height, List[CoretexSegmentationInstance] instances)
np.ndarray	extractSegmentationMask (self, ImageDatasetClasses classes)
Public Member Functions inherited from coretex.codable.codable.Codable
Dict[str, Any]	encode (self)
None	onDecode (self)
Self	decode (cls, Dict[str, Any] encodedObject)

Detailed Description

    Image Annotation class

    Properties
    ----------
    name : str
        name of annotation class
    width : float
        width of annotation
    height : float
        height of annotation
    instances : List[CoretexSegmentationInstance]
        list of SegmentationInstance objects

Definition at line 232 of file coretex_format.py.

Member Function Documentation

create()

Self coretex.coretex.annotation.image.coretex_format.CoretexImageAnnotation.create	(		cls,
		str	name,
		float	width,
		float	height,
		List[CoretexSegmentationInstance]	instances
	)

    Creates CoretexImageAnnotation object with provided parameters

    Parameters
    ----------
    name : str
name of annotation class
    width : float
width of annotation
    height : float
height of annotation
    instances : List[CoretexSegmentationInstance]
list of SegmentationInstance objects

    Returns
    -------
    The created CoretexImageAnnotation object

Definition at line 262 of file coretex_format.py.

    def create(
        cls,
        name: str,
        width: float,
        height: float,
        instances: List[CoretexSegmentationInstance]
    ) -> Self:
        """
            Creates CoretexImageAnnotation object with provided parameters
 
            Parameters
            ----------
            name : str
                name of annotation class
            width : float
                width of annotation
            height : float
                height of annotation
            instances : List[CoretexSegmentationInstance]
                list of SegmentationInstance objects
 
            Returns
            -------
            The created CoretexImageAnnotation object
        """
 
        obj = cls()
 
        obj.name = name
        obj.width = width
        obj.height = height
        obj.instances = instances
 
        return obj
 

extractSegmentationMask()

np.ndarray coretex.coretex.annotation.image.coretex_format.CoretexImageAnnotation.extractSegmentationMask	(		self,
		ImageDatasetClasses	classes
	)

    Generates segmentation mask of provided ImageDatasetClasses object

    Parameters
    ----------
    classes : ImageDatasetClasses
list of dataset classes

    Returns
    -------
    np.ndarray -> segmentation mask represented as np.ndarray

Definition at line 297 of file coretex_format.py.

    def extractSegmentationMask(self, classes: ImageDatasetClasses) -> np.ndarray:
        """
            Generates segmentation mask of provided ImageDatasetClasses object
 
            Parameters
            ----------
            classes : ImageDatasetClasses
                list of dataset classes
 
            Returns
            -------
            np.ndarray -> segmentation mask represented as np.ndarray
        """
 
        image = Image.new("L", (self.width, self.height))
 
        for instance in self.instances:
            labelId = classes.labelIdForClassId(instance.classId)
            if labelId is None:
                continue
 
            for segmentation in instance.segmentations:
                if len(segmentation) == 0:
                    raise ValueError(f">> [Coretex] Empty segmentation")
 
                draw = ImageDraw.Draw(image)
                draw.polygon(toPoly(segmentation), fill = labelId + 1)
 
        return np.asarray(image)

---

The documentation for this class was generated from the following file:

• src/coretex/coretex/annotation/image/coretex_format.py