Docs /Templates/ sinapsis-data-visualization

KeyPointsDrawer

sinapsis-data-visualizationcommunityannotationsdrawerimagevisualization

Python template · sinapsis_data_visualization.templates.key_points_drawer

Overview

A class for drawing keypoints and oriented bounding boxes on images, extending from BBoxDrawer.

This class allows the addition of keypoints as annotations on images, along with oriented bounding boxes. It inherits from the 'BBoxDrawer' class to reuse the functionality for drawing oriented bounding boxes and extends it to handle the drawing of keypoints, which can be visualized with customizable appearance properties.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-data-visualization==1.0.0
uv pip install sinapsis-data-visualization==1.0.0
uv add sinapsis-data-visualization==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
overwrite
bool
Optional
Default: false
text_style
TextStyle
Optional
Default: null
font

Style of font Available options: FONT_HERSHEY_SIMPLEX = 0. FONT_HERSHEY_PLAIN = 1. FONT_HERSHEY_DUPLEX = 2. FONT_HERSHEY_COMPLEX = 3. FONT_HERSHEY_TRIPLEX = 4. FONT_HERSHEY_COMPLEX_SMALL = 5. FONT_HERSHEY_SCRIPT_SIMPLEX = 6. FONT_HERSHEY_SCRIPT_COMPLEX = 7.

int
Optional
Default: 0
thickness

Thickness of font

int
Optional
Default: 2
font_scale

Scale of font

float
Optional
Default: 0.5
draw_confidence

Flag to determine confidence value is drawn. Defaults to True

bool
Optional
Default: true
randomized_color
bool
Optional
Default: true
draw_extra_labels

Flag to determine if extra labels are drawn. Defaults to True text_style (TextStyle) = {font=0, font_scale=0.5, thickness=2}: Dictionary of font properties used to draw label text boxes.

bool
Optional
Default: true
draw_classification_label

Flag to determine if a classification label is drawn on the image. Defaults to False.

bool
Optional
Default: false
text_box_to_border_offset

Weight to control offset of text box to image border.

float
Optional
Default: 0.01
classification_label_position

Position of the text box for the classification label. Defaults to "top_right".

typing.Literal['top_left', 'top_right']
Optional
Default: "top_right"

Configuration example

Example from the Python docstring:

yaml
agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: KeyPointsDrawer
  class_name: KeyPointsDrawer
  template_input: InputTemplate
  attributes:
    overwrite: false
    randomized_color: true
    draw_confidence: true
    draw_extra_labels: true
    text_style:
      font: 0
      font_scale: 0.5
      thickness: 2
    draw_classification_label: false
    classification_label_position: top_right
    text_box_to_border_offset: 0.01
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "KeyPointsDrawer"
    class_name: "KeyPointsDrawer"
    attributes:
      overwrite: false
      text_style:
        font: 0
        thickness: 2
        font_scale: 0.5
      draw_confidence: true
      randomized_color: true
      draw_extra_labels: true
      draw_classification_label: false
      text_box_to_border_offset: 0.01
      classification_label_position: "top_right"

Inheritance

Immediate parent: sinapsis_data_visualization.templates.bbox_drawer.BBoxDrawer

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.