Renderers

Drawing Render used to makes easy drawings

CirclesRender dataclass

Bases: EllipsesRender

Render for Circle objects

Source code in otary/image/components/drawer/utils/render.py

@dataclass
class CirclesRender(EllipsesRender):
    """Render for Circle objects"""

EllipsesRender dataclass

Bases: GeometryRender

Render for Ellipse objects

Source code in otary/image/components/drawer/utils/render.py

@dataclass
class EllipsesRender(GeometryRender):
    """Render for Ellipse objects"""

    is_filled: bool = False
    is_draw_focis_enabled: bool = False
    is_draw_center_point_enabled: bool = False

GeometryRender dataclass

Bases: Render, ABC

Base class for the rendering of GeometryEntity objects

Source code in otary/image/components/drawer/utils/render.py

@dataclass
class GeometryRender(Render, ABC):
    """Base class for the rendering of GeometryEntity objects"""

LinearSplinesRender dataclass

Bases: SegmentsRender

Render for Linear Splines objects

Source code in otary/image/components/drawer/utils/render.py

@dataclass
class LinearSplinesRender(SegmentsRender):
    """Render for Linear Splines objects"""

    pct_ix_head: float = 0.25

OcrSingleOutputRender dataclass

Bases: Render

Render for OcrSingleOutput objects

Source code in otary/image/components/drawer/utils/render.py

@dataclass
class OcrSingleOutputRender(Render):
    """Render for OcrSingleOutput objects"""

PointsRender dataclass

Bases: GeometryRender

Render for Point objects

Source code in otary/image/components/drawer/utils/render.py

@dataclass
class PointsRender(GeometryRender):
    """Render for Point objects"""

    radius: int = 1

PolygonsRender dataclass

Bases: SegmentsRender

Render for Polygon objects. It inherits from SegmentsRender because Polygons are drawn as a succession of drawn segments.

Source code in otary/image/components/drawer/utils/render.py

@dataclass
class PolygonsRender(SegmentsRender):
    """Render for Polygon objects. It inherits from SegmentsRender because
    Polygons are drawn as a succession of drawn segments."""

    is_filled: bool = False

Render dataclass

Bases: ABC

Render class used to facilitate the rendering of objects when drawing them

Source code in otary/image/components/drawer/utils/render.py

@dataclass(kw_only=True)
class Render(ABC):
    """Render class used to facilitate the rendering of objects when drawing them"""

    thickness: int = DEFAULT_RENDER_THICKNESS
    line_type: int = cv2.LINE_AA
    default_color: tuple[int, int, int] | str = DEFAULT_RENDER_COLOR
    colors: list[tuple[int, int, int] | str] = field(default_factory=list)

    def adjust_colors_length(self, n: int) -> None:
        """Correct the color parameter in case the objects has not the same length

        Args:
            n (int): number of objects to expect
        """
        if len(self.colors) > n:
            self.colors = self.colors[:n]
        elif len(self.colors) < n:
            n_missing = n - len(self.colors)
            self.colors = self.colors + [self.default_color for _ in range(n_missing)]

    @property
    def default_color_processed(self) -> tuple[int, int, int]:
        """DrawingRender default_color property"""
        if isinstance(self.default_color, str):
            default_color = color_str_to_tuple(self.default_color)
            if default_color is None:
                return DEFAULT_RENDER_COLOR
            return default_color

        if is_color_tuple(self.default_color):
            return self.default_color
        return DEFAULT_RENDER_COLOR

    @property
    def colors_processed(self) -> list[tuple[int, int, int]]:
        """DrawingRender colors_processed method"""
        colors_processed: list[tuple[int, int, int]] = []
        for color in self.colors:
            if isinstance(color, str):
                tmp_color = color_str_to_tuple(color)
                if tmp_color is None:
                    colors_processed.append(self.default_color_processed)
                else:
                    colors_processed.append(tmp_color)
            elif is_color_tuple(color):
                colors_processed.append(color)
            else:
                colors_processed.append(self.default_color_processed)
        return colors_processed

colors_processed property

DrawingRender colors_processed method

default_color_processed property

DrawingRender default_color property

adjust_colors_length(n)

Correct the color parameter in case the objects has not the same length

Parameters:

Name	Type	Description	Default
n	int	number of objects to expect	required

Source code in otary/image/components/drawer/utils/render.py

def adjust_colors_length(self, n: int) -> None:
    """Correct the color parameter in case the objects has not the same length

    Args:
        n (int): number of objects to expect
    """
    if len(self.colors) > n:
        self.colors = self.colors[:n]
    elif len(self.colors) < n:
        n_missing = n - len(self.colors)
        self.colors = self.colors + [self.default_color for _ in range(n_missing)]

SegmentsRender dataclass

Bases: GeometryRender

Render for Segment objects

Source code in otary/image/components/drawer/utils/render.py

@dataclass
class SegmentsRender(GeometryRender):
    """Render for Segment objects"""

    as_vectors: bool = False
    tip_length: int = 20