Source code for rastervision.core.data.label.labels
"""Defines the abstract Labels class."""
from typing import TYPE_CHECKING, Any, Iterable, List
from abc import ABC, abstractmethod
if TYPE_CHECKING:
from typing import Self
from shapely.geometry import Polygon
from rastervision.core.box import Box
[docs]class Labels(ABC):
"""A source-agnostic, in-memory representation of labels in a scene.
This class can represent labels obtained via a ``LabelSource``, a
``LabelStore``, or directly from model predictions.
"""
[docs] @abstractmethod
def __add__(self, other: 'Self'):
"""Add labels to these labels.
Returns a concatenation of this and the other labels.
"""
[docs] @abstractmethod
def filter_by_aoi(self, aoi_polygons: List['Polygon']) -> 'Self':
"""Return a copy of these labels filtered by given AOI polygons.
Args:
aoi_polygons: List of AOI polygons to filter by, in pixel
coordinates.
"""
@abstractmethod
def __eq__(self, other: 'Labels'):
pass
[docs] @classmethod
@abstractmethod
def make_empty(cls) -> 'Self':
"""Instantiate an empty instance of this class.
Returns:
Labels: An object of the Label subclass on which this method is
called.
"""
[docs] @classmethod
def from_predictions(cls, windows: Iterable['Box'],
predictions: Iterable[Any]) -> 'Self':
"""Instantiate from windows and their corresponding predictions.
This makes no assumptions about the type or format of the predictions.
Subclasses should implement the __setitem__ method to correctly handle
the predictions.
Args:
windows (Iterable[Box]): Boxes in pixel coords, specifying chips
in the raster.
predictions (Iterable[Any]): The model predictions for each chip
specified by the windows.
Returns:
Labels: An object of the Label subclass on which this method is
called.
"""
labels = cls.make_empty()
# If predictions is tqdm-wrapped, it needs to be the first arg to zip()
# or the progress bar won't terminate with the correct count.
for prediction, window in zip(predictions, windows):
labels[window] = prediction
return labels