coretex.coretex.annotation.image.classes_format.ImageDatasetClass Class Reference

Inheritance diagram for coretex.coretex.annotation.image.classes_format.ImageDatasetClass:

Public Member Functions
ImageDatasetClasses	generate (cls, Set[str] labels)
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 Dataset class metadata

    Properties
    ----------
    classIds : List[UUID]
        list of all uuids connected to this class
    label : str
        name of the class
    color : str
        color of the class

Definition at line 29 of file classes_format.py.

Member Function Documentation

generate()

ImageDatasetClasses coretex.coretex.annotation.image.classes_format.ImageDatasetClass.generate	(		cls,
		Set[str]	labels
	)

    Generates list of Coretex classes based on provided
    labels (class names)

    Parameters
    ----------
    labels : Set[str]
list of labels (class names)

    Returns
    -------
    ImageDatasetClasses -> list of ImageDatasetClass (Coretex class metadata) objects

    Example
    -------
    >>> from coretex import ImageDatasetClass
    \b
    >>> labels = {"car", "bicycle"}
    >>> imgDatasetClasses = ImageDatasetClass.generate(labels)
    >>> print(classes)
    [
ImageDatasetClass(
    classIds = [UUID("81add001-1c9c-4949-8b73-3599f1d0de9d")],
    name = "car",
    color = "#bcb86b"
),
ImageDatasetClass(
    classIds = [UUID("d710019b-f28f-40ab-aa65-e13df949beff")],
    name = "bicycle",
    color = "#cbc66b"
)
    ]

Definition at line 69 of file classes_format.py.

    def generate(cls, labels: Set[str]) -> ImageDatasetClasses:
        """
            Generates list of Coretex classes based on provided
            labels (class names)
 
            Parameters
            ----------
            labels : Set[str]
                list of labels (class names)
 
            Returns
            -------
            ImageDatasetClasses -> list of ImageDatasetClass (Coretex class metadata) objects
 
            Example
            -------
            >>> from coretex import ImageDatasetClass
            \b
            >>> labels = {"car", "bicycle"}
            >>> imgDatasetClasses = ImageDatasetClass.generate(labels)
            >>> print(classes)
            [
                ImageDatasetClass(
                    classIds = [UUID("81add001-1c9c-4949-8b73-3599f1d0de9d")],
                    name = "car",
                    color = "#bcb86b"
                ),
                ImageDatasetClass(
                    classIds = [UUID("d710019b-f28f-40ab-aa65-e13df949beff")],
                    name = "bicycle",
                    color = "#cbc66b"
                )
            ]
        """
 
        colors: Set[str] = set()
 
        while len(colors) != len(labels):
            color = f'#{"%06x" % random.randint(0, 0xFFFFFF)}'
            colors.add(color)
 
        return ImageDatasetClasses(
            [cls(label, color) for label, color in zip(labels, colors)]
        )
 
 

---

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

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