Annotations

class hsi.annotations.AnnotationFile

A file containing multiple annotations and their property definitions.

annotations

List of annotations in the file.

property_desc

Definitions of properties used by the annotations.

class hsi.annotations.Annotation

A single annotation on an image.

An annotation consists of a title, a unique identifier, a geometric descriptor, and a set of properties.

color

descriptor

The geometric shape and position of the annotation.

image_path

properties

Additional properties associated with the annotation.

title

The title or name of the annotation.

uuid

A unique identifier for the annotation.

class hsi.annotations.PropertyValue

Possible values for an annotation property.

class Float(_0)

class String(_0)

class hsi.annotations.Descriptor

Geometric descriptor of an annotation.

class Ellipse(cx, cy, a, b, angle, max_dist)

a

angle

b

cx

cy

max_dist

class Polygon(points, width, height, x, y)

height

points

width

x

y

class Rect(x, y, width, height)

height

width

x

y

mask()

Returns a binary mask as a numpy array.

The mask is a 2D boolean array where True indicates a pixel inside the annotation.

height

The height of the bounding box.

width

The width of the bounding box.

x

The x-coordinate of the top-left corner of the bounding box.

y

The y-coordinate of the top-left corner of the bounding box.

class hsi.annotations.Property

Description of a property type.

class FloatValue

class Label(labels, colors)

colors

labels