KeyPointsDrawer
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 setInstallation
Install the published package using pip or uv.
pip install sinapsis-data-visualization==1.0.0uv pip install sinapsis-data-visualization==1.0.0uv add sinapsis-data-visualization==1.0.0Configuration
Effective fields from the inspector schema, including nested Pydantic model fields.
Optional
Default: null
Optional
Default: false
Optional
Default: null
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.
Optional
Default: 0
Thickness of font
Optional
Default: 2
Scale of font
Optional
Default: 0.5
Flag to determine confidence value is drawn. Defaults to True
Optional
Default: true
Optional
Default: true
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.
Optional
Default: true
Flag to determine if a classification label is drawn on the image. Defaults to False.
Optional
Default: false
Weight to control offset of text box to image border.
Optional
Default: 0.01
Position of the text box for the classification label. Defaults to "top_right".
Optional
Default: "top_right"
Configuration example
Example from the Python docstring:
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.01Show schema-based configuration skeleton
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
sinapsis_data_visualization.templates.bbox_drawer.BBoxDrawerEnvironment variables
Environment definitions belong to their canonical Python modules.
No directly related environment variables listed.