Source code for mira.core.annotation

import logging
import typing

import cv2
import numpy as np

from . import utils

log = logging.getLogger(__name__)

class Category:
    """Defines a category of an annotation along
    with all associated properties.

        name: The name of the annotation category


    def __init__(self, name: str):
        self._name = name

    def __eq__(self, other):
        return self._name == other._name

    def __str__(self):
        return self._name

    def name(self):
        """The name of the category."""
        return self._name

    def __repr__(self):
        return repr(self._name)

    def convert(self, categories) -> "Category":
        """Convert an annotation to match another annotation config."""
        name = self._name
        if name in categories:
            return categories[name]
        raise ValueError(f"{name} is not in the new annotation configuration.")

class Label:
    """An image-level label."""

    category: Category
    metadata: dict
    score: typing.Optional[float]

    def __init__(self, category: Category, score: float = None, metadata: dict = None):
        self.category = category
        self.score = score
        self.metadata = metadata or {}

    def convert(self, categories) -> "Label":
        """Convert an annotation to match another annotation config."""
        return self.assign(

    def assign(self, **kwargs) -> "Label":
        """Get a new Annotation with only the supplied
        keyword arguments changed."""
        defaults = {
            "category": self.category,
            "score": self.score,
            "metadata": self.metadata,
        kwargs = {**defaults, **kwargs}
        return Label(**kwargs)

    def __repr__(self):
        return f"Label(category={self.category}, score={self.score})"

[docs]class Annotation( Label ): # pylint: disable=too-many-instance-attributes,unbalanced-tuple-unpacking """Defines a single annotation. Args: selection: The selection associated with the annotation category: The category of the annotation score: A score for the annotation metadata: Metadata to store as part of the annotation """ points: np.ndarray x1: int y1: int x2: int y2: int def __init__( self, category: Category, x1: int = None, y1: int = None, x2: int = None, y2: int = None, points: typing.Union[typing.List[typing.Tuple[int, int]], np.ndarray] = None, score: float = None, metadata: dict = None, ): super().__init__(category=category, score=score, metadata=metadata) is_rect = all(v is not None for v in [x1, y1, x2, y2]) is_poly = points is not None if is_rect and is_poly: raise ValueError( "Either all of (x1, y1, x2, y2) or points must be provided (and not both)." ) self.is_rect = is_rect if is_rect: self.x1, self.y1, self.x2, self.y2 = map( lambda v: int(round(v)), [x1, y1, x2, y2] # type: ignore ) self.points = utils.box2pts(self.x1, self.y1, self.x2, self.y2) else: self.points = np.array(points).round().astype("int32") if (self.points[0] != self.points[-1]).any(): # Make sure we close the polygon. self.points = np.concatenate([self.points, self.points[:1]], axis=0) self.x1, self.y1 = self.points.min(axis=0).tolist() self.x2, self.y2 = self.points.max(axis=0).tolist()
[docs] def area(self) -> int: """Compute the area of the selection.""" if self.is_rect: return (self.y2 - self.y1) * (self.x2 - self.x1) return cv2.contourArea(self.points)
[docs] def xywh(self) -> typing.Tuple[int, int, int, int]: """Get the bounding box as x, y, width and height.""" x1, y1, x2, y2 = self.x1y1x2y2() return x1, y1, x2 - x1, y2 - y1
[docs] def x1y1x2y2(self) -> typing.Tuple[int, int, int, int]: """The simple bounding box containing the selection. Returns: The coordinates (x1, y1, x2, y2). The first set always correspond with the top left of the image. The second set always correspond with the bottom right of the image. """ return (self.x1, self.y1, self.x2, self.y2)
[docs] def draw( self, image: np.ndarray, color: typing.Union[ typing.Tuple[int, int, int], typing.Tuple[int, int, int, int] ], opaque: bool = False, thickness: int = 5, ): """Draw selection onto given image. Args: image: The image to draw on. color: The color to use. opaque: Whether the box should be filled. thickness: The thickness of the box (for non-opaque cases only). Returns: The image with the selection drawn """ if opaque: cv2.fillPoly(img=image, pts=[self.points], color=color) else: cv2.polylines( img=image, pts=[self.points], isClosed=True, thickness=thickness, color=color, )
[docs] def extract(self, image, pad=0): """Extract selection from image (i.e., crop the image to the selection). """ x1, y1, x2, y2 = [ v + p for v, p in zip(self.x1y1x2y2(), [-pad, -pad, pad, pad]) ] return image[max(y1, 0) : max(y2, 0), max(x1, 0) : max(0, x2)]
[docs] def crop(self, width, height): """Crop a selection to a given image width and height. Args: width: The width of the image height: The height of the image """ if self.is_rect: crop = self.assign( **{ k: max(0, min(getattr(self, k), d)) for d, k in [ (width, "x1"), (height, "y1"), (width, "x2"), (height, "y2"), ] } ) if crop.area() > 0: return [crop] return [] baseline = self.points.min(axis=0) offseted = (self.points - baseline).round().astype("int32") redrawn = cv2.drawContours( np.zeros(offseted.max(axis=0)[::-1], dtype="uint8"), contours=offseted[np.newaxis], contourIdx=-1, color=255, thickness=-1, ) redrawn = redrawn[-min(baseline[1], 0) :, -min(baseline[0], 0) :] redrawn = redrawn[ : (height - baseline[1].clip(0)).clip(0), : (width - baseline[0].clip(0)).clip(0), ] if redrawn.shape[0] == 0 or redrawn.shape[1] == 0 or (redrawn == 0).all(): return [] return [ self.assign( points=c[:, 0, :] + baseline.clip(0), ) for c in cv2.findContours( redrawn, mode=cv2.RETR_EXTERNAL, method=cv2.CHAIN_APPROX_NONE )[-2] if len(c) > 1 ]
[docs] def resize(self, scale: typing.Union[float, np.ndarray]) -> "Annotation": """Obtain a revised selection with a given uniform scaling. Scale should be provided as either a single float or as an array with scaling factors provided as [sx, sy]""" return ( self.assign( **{ k: int(getattr(self, k) * s) for k, s in zip( [ "x1", "y1", "x2", "y2", ], [scale[0], scale[1], scale[0], scale[1]] if isinstance(scale, np.ndarray) else [scale, scale, scale, scale], ) } ) if self.is_rect else self.assign(points=self.points * scale) )
[docs] def convert(self, categories) -> "Annotation": """Convert an annotation to match another annotation config.""" return self.assign( category=self.category.convert(categories), )
[docs] def assign(self, **kwargs) -> "Annotation": """Get a new Annotation with only the supplied keyword arguments changed.""" defaults = { **( { "x1": self.x1, "y1": self.y1, "x2": self.x2, "y2": self.y2, } if self.is_rect else {"points": self.points} # type: ignore ), "category": self.category, "score": self.score, "metadata": self.metadata, } kwargs = {**defaults, **kwargs} return Annotation(**kwargs)
def __eq__(self, other): return ( (self.points == other.points).all() and self.is_rect == other.is_rect and self.category == other.category and self.metadata == other.metadata ) def __repr__(self): return repr( { "selection": { "x1": self.x1, "y1": self.y1, "x2": self.x2, "y2": self.y2, } if self.is_rect else [{"x": x, "y": y} for x, y in self.points], "category":, "score": self.score, "metadata": self.metadata, } )
[docs]class Categories: """A class defining a list of annotation types for an object detection class. Args: names: The list of class names """ def __init__(self, names: typing.List[str]): names = [s.lower() for s in names] if len(names) != len(set(names)): raise ValueError("All class names must be unique (case-insensitive).") self._types = [Category(name=name) for name in names]
[docs] @classmethod def from_categories( cls, categories: typing.Union["Categories", typing.List[str]] ) -> "Categories": """Convert a list of strings to categories if it is not already.""" if isinstance(categories, cls): return categories return cls(typing.cast(typing.List[str], categories))
[docs] def bboxes_from_group(self, annotations: typing.List[Annotation]): """Obtain an array of shape (N, 5) where the columns are x1, y1, x2, y2, class_index where class_index is determined from the annotation configuration.""" return np.array( [list(a.x1y1x2y2()) + [self.index(a.category)] for a in annotations], ).reshape(-1, 5)
def __getitem__(self, key): if isinstance(key, np.int64): key = int(key) if isinstance(key, int): if key >= len(self): raise ValueError( f"Index {key} is out of bounds (only have {len(self)} entries)." ) return self.types[key] if isinstance(key, str): key = key.lower() val = next((e for e in self._types if == key), None) if val is None: raise ValueError(f"Did not find {key} in configuration") return val raise ValueError(f"Key must be int or str, not {key} of type {str(type(key))}") def __iter__(self): return iter(self._types) def __contains__(self, key): if isinstance(key, str): return any( == key for e in self._types) if isinstance(key, Category): return any(e == key for e in self._types) raise ValueError("Key must be str or Category, not " + str(type(key))) def __eq__(self, other): if not isinstance(other, type(self)): return False if len(other) != len(self): return False return all(o == s for s, o in zip(self, other)) def __len__(self): return len(self._types) def __repr__(self): return repr([ for a in self.types]) @property def types(self): """Get the list of types.""" return self._types
[docs] def index(self, category): """Get the index for a category.""" return next(i for i, cat in enumerate(self) if cat == category)
def labels2onehot( labels: typing.List[Label], categories: Categories, binary: bool, ): """Convert a list of annotations to onehot.""" y = np.zeros(len(categories), dtype="float32") for label in labels: ci = categories.index(label.category) y[ci] = 1 if binary else max((label.score or 1), y[ci]) return y