fiftyone.utils.cvat.CVATImage

class documentation

class CVATImage(object): (source)

Constructor: CVATImage(id, name, width, height, ...)

View In Hierarchy

An annotated image in CVAT image format.

Parameters
idthe ID of the image
namethe filename of the image
widththe width of the image, in pixels
heightthe height of the image, in pixels
tagsa list of CVATImageTag instances
boxesa list of CVATImageBox instances
polygonsa list of CVATImagePolygon instances
polylinesa list of CVATImagePolyline instances
pointsa list of CVATImagePoints instances
subsetthe project subset of the image, if any
Class Method from_image_dict Creates a CVATImage from an <image> tag of a CVAT image annotations XML file.
Class Method from_labels Creates a CVATImage from a dictionary of labels.
Method __init__ Undocumented
Method get_image_metadata Returns a fiftyone.core.metadata.ImageMetadata instance for the annotations.
Method iter_annos Returns an iterator over the annotations in the image.
Method to_labels Returns fiftyone.core.labels.Label representations of the annotations.
Instance Variable boxes Undocumented
Instance Variable height Undocumented
Instance Variable id Undocumented
Instance Variable name Undocumented
Instance Variable points Undocumented
Instance Variable polygons Undocumented
Instance Variable polylines Undocumented
Instance Variable subset Undocumented
Instance Variable tags Undocumented
Instance Variable width Undocumented
Property has_boxes Whether this image has 2D boxes.
Property has_points Whether this image has keypoints.
Property has_polylines Whether this image has polygons or polylines.
Property has_tags Whether this image has tags.
@classmethod
def from_image_dict(cls, d): (source)

Creates a CVATImage from an <image> tag of a CVAT image annotations XML file.

Parameters
da dict representation of an <image> tag
Returns
a CVATImage
@classmethod
def from_labels(cls, labels, metadata): (source)

Creates a CVATImage from a dictionary of labels.

Parameters
labelsa dict mapping keys to fiftyone.core.labels.Label instances
metadataa fiftyone.core.metadata.ImageMetadata for the image
Returns
a CVATImage
def __init__(self, id, name, width, height, tags=None, boxes=None, polygons=None, polylines=None, points=None, subset=None): (source)

Undocumented

def get_image_metadata(self): (source)

Returns a fiftyone.core.metadata.ImageMetadata instance for the annotations.

Returns
a fiftyone.core.metadata.ImageMetadata
def iter_annos(self): (source)

Returns an iterator over the annotations in the image.

Returns
an iterator that emits CVATImageAnno instances
def to_labels(self): (source)

Returns fiftyone.core.labels.Label representations of the annotations.

Returns
a dict mapping field keys to fiftyone.core.labels.Label instances
boxes: None = (source)

Undocumented

height = (source)

Undocumented

id = (source)

Undocumented

name = (source)

Undocumented

points: None = (source)

Undocumented

polygons: None = (source)

Undocumented

polylines: None = (source)

Undocumented

subset: None = (source)

Undocumented

tags: None = (source)

Undocumented

width = (source)

Undocumented

@property
has_boxes = (source)

Whether this image has 2D boxes.

@property
has_points = (source)

Whether this image has keypoints.

@property
has_polylines = (source)

Whether this image has polygons or polylines.

@property
has_tags = (source)

Whether this image has tags.