# fiftyone.utils.cvat
Utilities for working with datasets in
[CVAT format](https://github.com/opencv/cvat).
Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)
**Functions:**
| [`import_annotations`](#fiftyone.utils.cvat.import_annotations)(sample_collection[, ...]) | Imports annotations from the specified CVAT project or task(s) into the given sample collection. |
|---------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| [`load_cvat_image_annotations`](#fiftyone.utils.cvat.load_cvat_image_annotations)(xml_path) | Loads the CVAT image annotations from the given XML file. |
| [`load_cvat_video_annotations`](#fiftyone.utils.cvat.load_cvat_video_annotations)(xml_path) | Loads the CVAT video annotations from the given XML file. |
**Classes:**
| [`CVATImageDatasetImporter`](#fiftyone.utils.cvat.CVATImageDatasetImporter)([dataset_dir, ...]) | Importer for CVAT image datasets stored on disk. |
|---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| [`CVATVideoDatasetImporter`](#fiftyone.utils.cvat.CVATVideoDatasetImporter)([dataset_dir, ...]) | Importer for CVAT video datasets stored on disk. |
| [`CVATImageDatasetExporter`](#fiftyone.utils.cvat.CVATImageDatasetExporter)([export_dir, ...]) | Exporter that writes CVAT image datasets to disk. |
| [`CVATVideoDatasetExporter`](#fiftyone.utils.cvat.CVATVideoDatasetExporter)([export_dir, ...]) | Exporter that writes CVAT video datasets to disk. |
| [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels)([labels]) | Description of the labels in a CVAT image annotation task. |
| [`CVATImage`](#fiftyone.utils.cvat.CVATImage)(id, name, width, height[, tags, ...]) | An annotated image in CVAT image format. |
| [`HasCVATBinaryMask`](#fiftyone.utils.cvat.HasCVATBinaryMask)() | Mixin for CVAT annotations that store RLE format instance masks. |
| [`HasCVATPoints`](#fiftyone.utils.cvat.HasCVATPoints)(points) | Mixin for CVAT annotations that store a list of `(x, y)` pixel coordinates. |
| [`CVATImageAnno`](#fiftyone.utils.cvat.CVATImageAnno)([occluded, attributes]) | Mixin for annotations in CVAT image format. |
| [`CVATImageTag`](#fiftyone.utils.cvat.CVATImageTag)(label[, attributes]) | A tag in CVAT image format. |
| [`CVATImageBox`](#fiftyone.utils.cvat.CVATImageBox)(label, xtl, ytl, xbr, ybr[, ...]) | An object bounding box in CVAT image format. |
| [`CVATImagePolygon`](#fiftyone.utils.cvat.CVATImagePolygon)(label, points[, occluded, ...]) | A polygon in CVAT image format. |
| [`CVATImagePolyline`](#fiftyone.utils.cvat.CVATImagePolyline)(label, points[, occluded, ...]) | A polyline in CVAT image format. |
| [`CVATImagePoints`](#fiftyone.utils.cvat.CVATImagePoints)(label, points[, occluded, ...]) | A set of keypoints in CVAT image format. |
| [`CVATTrack`](#fiftyone.utils.cvat.CVATTrack)(id, label, width, height[, boxes, ...]) | An annotation track in CVAT video format. |
| [`CVATVideoAnno`](#fiftyone.utils.cvat.CVATVideoAnno)([outside, occluded, keyframe, ...]) | Mixin for annotations in CVAT video format. |
| [`CVATVideoBox`](#fiftyone.utils.cvat.CVATVideoBox)(frame, label, xtl, ytl, xbr, ybr) | An object bounding box in CVAT video format. |
| [`CVATVideoPolygon`](#fiftyone.utils.cvat.CVATVideoPolygon)(frame, label, points[, ...]) | A polygon in CVAT video format. |
| [`CVATVideoPolyline`](#fiftyone.utils.cvat.CVATVideoPolyline)(frame, label, points[, ...]) | A polyline in CVAT video format. |
| [`CVATVideoPoints`](#fiftyone.utils.cvat.CVATVideoPoints)(frame, label, points[, ...]) | A set of keypoints in CVAT video format. |
| [`CVATAttribute`](#fiftyone.utils.cvat.CVATAttribute)(name, value) | An attribute in CVAT image format. |
| [`CVATImageAnnotationWriter`](#fiftyone.utils.cvat.CVATImageAnnotationWriter)() | Class for writing annotations in CVAT image format. |
| [`CVATVideoAnnotationWriter`](#fiftyone.utils.cvat.CVATVideoAnnotationWriter)() | Class for writing annotations in CVAT video format. |
| [`CVATBackendConfig`](#fiftyone.utils.cvat.CVATBackendConfig)(name, label_schema[, ...]) | Class for configuring [`CVATBackend`](#fiftyone.utils.cvat.CVATBackend) instances. |
| [`CVATBackend`](#fiftyone.utils.cvat.CVATBackend)(\*args, \*\*kwargs) | Class for interacting with the CVAT annotation backend. |
| [`CVATAnnotationResults`](#fiftyone.utils.cvat.CVATAnnotationResults)(samples, config, ...) | Class that stores all relevant information needed to monitor the progress of an annotation run sent to CVAT and download the results. |
| [`CVATAnnotationAPI`](#fiftyone.utils.cvat.CVATAnnotationAPI)(name, url[, username, ...]) | A class to facilitate connection to and management of tasks in CVAT. |
| [`CVATLabel`](#fiftyone.utils.cvat.CVATLabel)(label_dict, class_map, ...[, ...]) | A label returned by the CVAT API. |
| [`CVATShape`](#fiftyone.utils.cvat.CVATShape)(label_dict, class_map, ...[, ...]) | A shape returned by the CVAT API. |
| [`CVATTag`](#fiftyone.utils.cvat.CVATTag)(label_dict, class_map, attr_id_map, ...) | A tag returned by the CVAT API. |
### fiftyone.utils.cvat.import_annotations(sample_collection, project_name=None, project_id=None, task_ids=None, data_path=None, label_types=None, insert_new=True, download_media=False, num_workers=None, occluded_attr=None, group_id_attr=None, backend='cvat', \*\*kwargs)
Imports annotations from the specified CVAT project or task(s) into the
given sample collection.
Provide one of `project_name`, `project_id`, or `task_ids` to perform
an import.
This method can be configured in any of the following three ways:
1. Pass the `data_path` argument to define a mapping between media
filenames in CVAT and local filepaths to the same media.
2. Pass the `download_media=True` option to download both the
annotations and the media files themselves, which are stored in a
directory you specify via the `data_path` argument.
3. Don’t provide `data_path` or `download_media=True`, in which case
it is assumed that the CVAT filenames correspond to the base filenames
of existing sample filepaths in the provided `sample_collection`.
* **Parameters:**
* **sample_collection** – a
[`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **project_name** (*None*) – the name of a CVAT project to import
* **project_id** (*None*) – the ID of a CVAT project to import
* **task_ids** (*None*) – a CVAT task ID or iterable of CVAT task IDs to import
* **data_path** (*None*) –
a parameter that defines the correspondence between
the filenames in CVAT and the filepaths of `sample_collection`.
Can be any of the following:
- a directory on disk where the media files reside. In this case,
the filenames must match those in CVAT
- a dict mapping CVAT filenames to absolute filepaths to the
corresponding media on disk
- the path to a JSON manifest on disk containing a mapping
between CVAT filenames and absolute filepaths to the media on
disk
By default, only annotations whose filename matches an existing
filepath in `sample_collection` will be imported
* **label_types** (*None*) –
an optional parameter specifying the label types to
import. Can be any of the following:
- `None` (default): all label types will be stored in fields of
the same name on `sample_collection`
- a list of label types to load. In this case, the labels will be
stored in fields of the same names in `sample_collection`
- a dict mapping label types to field names of
`sample_collection` in which to store the labels
- `"prompt"`: present an interactive prompt to decide/discard
field names in which to store each label type
* **insert_new** (*True*) – whether to create new samples for any media for
which annotations are found in CVAT but which do not exist in
`sample_collection`
* **download_media** (*False*) – whether to download the images or videos found
in CVAT to the directory or filepaths in `data_path` if not
already present
* **num_workers** (*None*) – a suggested number of threads to use when
downloading media
* **occluded_attr** (*None*) – an optional attribute name in which to store the
occlusion information for all spatial labels
* **group_id_attr** (*None*) – an optional attribute name in which to store the
group id for labels
* **backend** ( *"cvat"*) – the name of the CVAT backend to use
* **\*\*kwargs** – CVAT authentication credentials to pass to
[`CVATBackendConfig`](#fiftyone.utils.cvat.CVATBackendConfig)
### *class* fiftyone.utils.cvat.CVATImageDatasetImporter(dataset_dir=None, data_path=None, labels_path=None, include_all_data=False, shuffle=False, seed=None, max_samples=None)
Bases: [`LabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter), [`ImportPathsMixin`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImportPathsMixin)
Importer for CVAT image datasets stored on disk.
See [this page](../user_guide/import_datasets.md#cvatimagedataset-import) for format details.
* **Parameters:**
* **dataset_dir** (*None*) – the dataset directory. If omitted, `data_path`
and/or `labels_path` must be provided
* **data_path** (*None*) –
an optional parameter that enables explicit control
over the location of the media. Can be any of the following:
- a folder name like `"data"` or `"data/"` specifying a
subfolder of `dataset_dir` where the media files reside
- an absolute directory path where the media files reside. In
this case, the `dataset_dir` has no effect on the location of
the data
- a filename like `"data.json"` specifying the filename of the
JSON data manifest file in `dataset_dir`
- an absolute filepath specifying the location of the JSON data
manifest. In this case, `dataset_dir` has no effect on the
location of the data
- a dict mapping filenames to absolute filepaths
If None, this parameter will default to whichever of `data/` or
`data.json` exists in the dataset directory
* **labels_path** (*None*) –
an optional parameter that enables explicit control
over the location of the labels. Can be any of the following:
- a filename like `"labels.xml"` specifying the location of the
labels in `dataset_dir`
- an absolute filepath to the labels. In this case,
`dataset_dir` has no effect on the location of the labels
If None, the parameter will default to `labels.xml`
* **include_all_data** (*False*) – whether to generate samples for all images in
the data directory (True) rather than only creating samples for
images with label entries (False)
* **shuffle** (*False*) – whether to randomly shuffle the order in which the
samples are imported
* **seed** (*None*) – a random seed to use when shuffling
* **max_samples** (*None*) – a maximum number of samples to import. By default,
all samples are imported
**Attributes:**
| [`has_dataset_info`](#fiftyone.utils.cvat.CVATImageDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. |
|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`has_image_metadata`](#fiftyone.utils.cvat.CVATImageDatasetImporter.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. |
| [`label_cls`](#fiftyone.utils.cvat.CVATImageDatasetImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. |
**Methods:**
| [`setup`](#fiftyone.utils.cvat.CVATImageDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. |
|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
| [`get_dataset_info`](#fiftyone.utils.cvat.CVATImageDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. |
| [`close`](#fiftyone.utils.cvat.CVATImageDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. |
| [`get_media_sources`](#fiftyone.utils.cvat.CVATImageDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. |
#### *property* has_dataset_info
Whether this importer produces a dataset info dictionary.
#### *property* has_image_metadata
Whether this importer produces
[`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image.
#### *property* label_cls
The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this
importer.
This can be any of the following:
- a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the
importer is guaranteed to return labels of this type
- a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In
this case, the importer can produce a single label field of any of
these types
- a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes.
In this case, the importer will return label dictionaries with keys
and value-types specified by this dictionary. Not all keys need be
present in the imported labels
- `None`. In this case, the importer makes no guarantees about the
labels that it may return
#### setup()
Performs any necessary setup before importing the first sample in
the dataset.
This method is called when the importer’s context manager interface is
entered, `DatasetImporter.__enter__()`.
#### get_dataset_info()
Returns the dataset info for the dataset.
By convention, this method should be called after all samples in the
dataset have been imported.
* **Returns:**
a dict of dataset info
#### close(\*args)
Performs any necessary actions after the last sample has been
imported.
This method is called when the importer’s context manager interface is
exited, `DatasetImporter.__exit__()`.
* **Parameters:**
**\*args** – the arguments to `DatasetImporter.__exit__()`
#### get_media_sources()
Returns the media-source entries the importing dataset records
before any sample is added, or None.
Only importers of media-reference-backed samples provide these; see
[`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter).
### *class* fiftyone.utils.cvat.CVATVideoDatasetImporter(dataset_dir=None, data_path=None, labels_path=None, include_all_data=False, shuffle=False, seed=None, max_samples=None)
Bases: [`LabeledVideoDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter), [`ImportPathsMixin`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImportPathsMixin)
Importer for CVAT video datasets stored on disk.
See [this page](../user_guide/import_datasets.md#cvatvideodataset-import) for format details.
* **Parameters:**
* **dataset_dir** (*None*) – the dataset directory. If omitted, `data_path`
and/or `labels_path` must be provided
* **data_path** (*None*) –
an optional parameter that enables explicit control
over the location of the media. Can be any of the following:
- a folder name like `"data"` or `"data/"` specifying a
subfolder of `dataset_dir` where the media files reside
- an absolute directory path where the media files reside. In
this case, the `dataset_dir` has no effect on the location of
the data
- a filename like `"data.json"` specifying the filename of the
JSON data manifest file in `dataset_dir`
- an absolute filepath specifying the location of the JSON data
manifest. In this case, `dataset_dir` has no effect on the
location of the data
- a dict mapping filenames to absolute filepaths
If None, this parameter will default to whichever of `data/` or
`data.json` exists in the dataset directory
* **labels_path** (*None*) –
an optional parameter that enables explicit control
over the location of the labels. Can be any of the following:
- a folder name like `"labels"` or `"labels/"` specifying the
location of the labels in `dataset_dir`
- an absolute folder path to the labels. In this case,
`dataset_dir` has no effect on the location of the labels
If None, the parameter will default to `labels/`
* **include_all_data** (*False*) – whether to generate samples for all videos in
the data directory (True) rather than only creating samples for
videos with label entries (False)
* **shuffle** (*False*) – whether to randomly shuffle the order in which the
samples are imported
* **seed** (*None*) – a random seed to use when shuffling
* **max_samples** (*None*) – a maximum number of samples to import. By default,
all samples are imported
**Attributes:**
| [`has_dataset_info`](#fiftyone.utils.cvat.CVATVideoDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. |
|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`has_video_metadata`](#fiftyone.utils.cvat.CVATVideoDatasetImporter.has_video_metadata) | Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. |
| [`label_cls`](#fiftyone.utils.cvat.CVATVideoDatasetImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the sample-level labels that it produces. |
| [`frame_labels_cls`](#fiftyone.utils.cvat.CVATVideoDatasetImporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the frame labels that it produces. |
**Methods:**
| [`setup`](#fiftyone.utils.cvat.CVATVideoDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. |
|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
| [`get_dataset_info`](#fiftyone.utils.cvat.CVATVideoDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. |
| [`close`](#fiftyone.utils.cvat.CVATVideoDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. |
| [`get_media_sources`](#fiftyone.utils.cvat.CVATVideoDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. |
#### *property* has_dataset_info
Whether this importer produces a dataset info dictionary.
#### *property* has_video_metadata
Whether this importer produces
[`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video.
#### *property* label_cls
The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this
importer within the sample-level labels that it produces.
This can be any of the following:
- a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the
importer is guaranteed to return sample-level labels of this type
- a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In
this case, the importer can produce a single sample-level label
field of any of these types
- a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes.
In this case, the importer will return sample-level label
dictionaries with keys and value-types specified by this
dictionary. Not all keys need be present in the imported labels
- `None`. In this case, the importer makes no guarantees about the
sample-level labels that it may return
#### *property* frame_labels_cls
The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this
importer within the frame labels that it produces.
This can be any of the following:
- a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the
importer is guaranteed to return frame labels of this type
- a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In
this case, the importer can produce a single frame label field of
any of these types
- a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes.
In this case, the importer will return frame label dictionaries
with keys and value-types specified by this dictionary. Not all
keys need be present in each frame
- `None`. In this case, the importer makes no guarantees about the
frame labels that it may return
#### setup()
Performs any necessary setup before importing the first sample in
the dataset.
This method is called when the importer’s context manager interface is
entered, `DatasetImporter.__enter__()`.
#### get_dataset_info()
Returns the dataset info for the dataset.
By convention, this method should be called after all samples in the
dataset have been imported.
* **Returns:**
a dict of dataset info
#### close(\*args)
Performs any necessary actions after the last sample has been
imported.
This method is called when the importer’s context manager interface is
exited, `DatasetImporter.__exit__()`.
* **Parameters:**
**\*args** – the arguments to `DatasetImporter.__exit__()`
#### get_media_sources()
Returns the media-source entries the importing dataset records
before any sample is added, or None.
Only importers of media-reference-backed samples provide these; see
[`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter).
### *class* fiftyone.utils.cvat.CVATImageDatasetExporter(export_dir=None, data_path=None, labels_path=None, export_media=None, rel_dir=None, abs_paths=False, image_format=None)
Bases: [`LabeledImageDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter), [`ExportPathsMixin`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ExportPathsMixin)
Exporter that writes CVAT image datasets to disk.
See [this page](../user_guide/export_datasets.md#cvatimagedataset-export) for format details.
* **Parameters:**
* **export_dir** (*None*) – the directory to write the export. This has no
effect if `data_path` and `labels_path` are absolute paths
* **data_path** (*None*) –
an optional parameter that enables explicit control
over the location of the exported media. Can be any of the
following:
- a folder name like `"data"` or `"data/"` specifying a
subfolder of `export_dir` in which to export the media
- an absolute directory path in which to export the media. In
this case, the `export_dir` has no effect on the location of
the data
- a JSON filename like `"data.json"` specifying the filename of
the manifest file in `export_dir` generated when
`export_media` is `"manifest"`
- an absolute filepath specifying the location to write the JSON
manifest file when `export_media` is `"manifest"`. In this
case, `export_dir` has no effect on the location of the data
If None, the default value of this parameter will be chosen based
on the value of the `export_media` parameter
* **labels_path** (*None*) –
an optional parameter that enables explicit control
over the location of the exported labels. Can be any of the
following:
- a filename like `"labels.xml"` specifying the location in
`export_dir` in which to export the labels
- an absolute filepath to which to export the labels. In this
case, the `export_dir` has no effect on the location of the
labels
If None, the labels will be exported into `export_dir` using the
default filename
* **export_media** (*None*) –
controls how to export the raw media. The
supported values are:
- `True`: copy all media files into the output directory
- `False`: don’t export media
- `"move"`: move all media files into the output directory
- `"symlink"`: create symlinks to the media files in the output
directory
- `"manifest"`: create a `data.json` in the output directory
that maps UUIDs used in the labels files to the filepaths of
the source media, rather than exporting the actual media
If None, the default value of this parameter will be chosen based
on the value of the `data_path` parameter
* **rel_dir** (*None*) – an optional relative directory to strip from each input
filepath to generate a unique identifier for each image. When
exporting media, this identifier is joined with `data_path` to
generate an output path for each exported image. This argument
allows for populating nested subdirectories that match the shape of
the input paths. The path is converted to an absolute path (if
necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path)
* **abs_paths** (*False*) – whether to store absolute paths to the images in the
exported labels
* **image_format** (*None*) – the image format to use when writing in-memory
images to disk. By default, `fiftyone.config.default_image_ext`
is used
**Attributes:**
| [`requires_image_metadata`](#fiftyone.utils.cvat.CVATImageDatasetExporter.requires_image_metadata) | Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. |
|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`label_cls`](#fiftyone.utils.cvat.CVATImageDatasetExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. |
**Methods:**
| [`setup`](#fiftyone.utils.cvat.CVATImageDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. |
|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`log_collection`](#fiftyone.utils.cvat.CVATImageDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. |
| [`export_sample`](#fiftyone.utils.cvat.CVATImageDatasetExporter.export_sample)(image_or_path, labels[, metadata]) | Exports the given sample to the dataset. |
| [`close`](#fiftyone.utils.cvat.CVATImageDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. |
#### *property* requires_image_metadata
Whether this exporter requires
[`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample
being exported.
#### *property* label_cls
The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this
exporter.
This can be any of the following:
- a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the
exporter directly exports labels of this type
- a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In
this case, the exporter can export a single label field of any of
these types
- a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes.
In this case, the exporter can handle label dictionaries with
value-types specified by this dictionary. Not all keys need be
present in the exported label dicts
- `None`. In this case, the exporter makes no guarantees about the
labels that it can export
#### setup()
Performs any necessary setup before exporting the first sample in
the dataset.
This method is called when the exporter’s context manager interface is
entered, `DatasetExporter.__enter__()`.
#### log_collection(sample_collection)
Logs any relevant information about the
[`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will
be exported.
Subclasses can optionally implement this method if their export format
can record information such as the
[`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the
collection being exported.
By convention, this method must be optional; i.e., if it is not called
before the first call to [`export_sample()`](#fiftyone.utils.cvat.CVATImageDatasetExporter.export_sample), then the exporter must
make do without any information about the
[`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be
available, for example, if the samples being exported are not stored in
a collection).
* **Parameters:**
**sample_collection** – the
[`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose
samples will be exported
#### export_sample(image_or_path, labels, metadata=None)
Exports the given sample to the dataset.
* **Parameters:**
* **image_or_path** – an image or the path to the image on disk
* **label** – an instance of [`label_cls()`](#fiftyone.utils.cvat.CVATImageDatasetExporter.label_cls), or a dictionary mapping
field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances,
or `None` if the sample is unlabeled
* **metadata** (*None*) – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata)
instance for the sample. Only required when
[`requires_image_metadata()`](#fiftyone.utils.cvat.CVATImageDatasetExporter.requires_image_metadata) is `True`
#### close(\*args)
Performs any necessary actions after the last sample has been
exported.
This method is called when the exporter’s context manager interface is
exited, `DatasetExporter.__exit__()`.
* **Parameters:**
**\*args** – the arguments to `DatasetExporter.__exit__()`
### *class* fiftyone.utils.cvat.CVATVideoDatasetExporter(export_dir=None, data_path=None, labels_path=None, export_media=None, rel_dir=None)
Bases: [`LabeledVideoDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter), [`ExportPathsMixin`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ExportPathsMixin)
Exporter that writes CVAT video datasets to disk.
See [this page](../user_guide/export_datasets.md#cvatvideodataset-export) for format details.
* **Parameters:**
* **export_dir** (*None*) – the directory to write the export. This has no
effect if `data_path` and `labels_path` are absolute paths
* **data_path** (*None*) –
an optional parameter that enables explicit control
over the location of the exported media. Can be any of the
following:
- a folder name like `"data"` or `"data/"` specifying a
subfolder of `export_dir` in which to export the media
- an absolute directory path in which to export the media. In
this case, the `export_dir` has no effect on the location of
the data
- a JSON filename like `"data.json"` specifying the filename of
the manifest file in `export_dir` generated when
`export_media` is `"manifest"`
- an absolute filepath specifying the location to write the JSON
manifest file when `export_media` is `"manifest"`. In this
case, `export_dir` has no effect on the location of the data
If None, the default value of this parameter will be chosen based
on the value of the `export_media` parameter
* **labels_path** (*None*) –
an optional parameter that enables explicit control
over the location of the exported labels. Can be any of the
following:
- a folder name like `"labels"` or `"labels/"` specifying the
location in `export_dir` in which to export the labels
- an absolute filepath to which to export the labels. In this
case, the `export_dir` has no effect on the location of the
labels
If None, the labels will be exported into `export_dir` using the
default folder name
* **export_media** (*None*) –
controls how to export the raw media. The
supported values are:
- `True`: copy all media files into the output directory
- `False`: don’t export media
- `"move"`: move all media files into the output directory
- `"symlink"`: create symlinks to the media files in the output
directory
- `"manifest"`: create a `data.json` in the output directory
that maps UUIDs used in the labels files to the filepaths of
the source media, rather than exporting the actual media
If None, the default value of this parameter will be chosen based
on the value of the `data_path` parameter
* **rel_dir** (*None*) – an optional relative directory to strip from each input
filepath to generate a unique identifier for each video. When
exporting media, this identifier is joined with `data_path` to
generate an output path for each exported video. This argument
allows for populating nested subdirectories that match the shape of
the input paths. The path is converted to an absolute path (if
necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path)
**Attributes:**
| [`requires_video_metadata`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.requires_video_metadata) | Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. |
|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`label_cls`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported at the sample-level. |
| [`frame_labels_cls`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported by this exporter at the frame-level. |
**Methods:**
| [`setup`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. |
|--------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`log_collection`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. |
| [`export_sample`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.export_sample)(video_path, \_, frames[, metadata]) | Exports the given sample to the dataset. |
| [`close`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. |
#### *property* requires_video_metadata
Whether this exporter requires
[`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample
being exported.
#### *property* label_cls
The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be
exported at the sample-level.
This can be any of the following:
- a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the
exporter directly exports sample-level labels of this type
- a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In
this case, the exporter can export a single sample-level label
field of any of these types
- a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes.
In this case, the exporter can export multiple label fields with
value-types specified by this dictionary. Not all keys need be
present in the exported sample-level labels
- `None`. In this case, the exporter makes no guarantees about the
sample-level labels that it can export
#### *property* frame_labels_cls
The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be
exported by this exporter at the frame-level.
This can be any of the following:
- a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the
exporter directly exports frame labels of this type
- a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In
this case, the exporter can export a single frame label field of
any of these types
- a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes.
In this case, the exporter can export multiple frame label fields
with value-types specified by this dictionary. Not all keys need be
present in the exported frame labels
- `None`. In this case, the exporter makes no guarantees about the
frame labels that it can export
#### setup()
Performs any necessary setup before exporting the first sample in
the dataset.
This method is called when the exporter’s context manager interface is
entered, `DatasetExporter.__enter__()`.
#### log_collection(sample_collection)
Logs any relevant information about the
[`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will
be exported.
Subclasses can optionally implement this method if their export format
can record information such as the
[`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the
collection being exported.
By convention, this method must be optional; i.e., if it is not called
before the first call to [`export_sample()`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.export_sample), then the exporter must
make do without any information about the
[`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be
available, for example, if the samples being exported are not stored in
a collection).
* **Parameters:**
**sample_collection** – the
[`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose
samples will be exported
#### export_sample(video_path, \_, frames, metadata=None)
Exports the given sample to the dataset.
* **Parameters:**
* **video_path** – the path to a video on disk
* **label** – an instance of [`label_cls()`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.label_cls), or a dictionary mapping
field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances,
or `None` if the sample has no sample-level labels
* **frames** – a dictionary mapping frame numbers to dictionaries that map
field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances,
or `None` if the sample has no frame-level labels
* **metadata** (*None*) – a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata)
instance for the sample. Only required when
[`requires_video_metadata()`](#fiftyone.utils.cvat.CVATVideoDatasetExporter.requires_video_metadata) is `True`
#### close(\*args)
Performs any necessary actions after the last sample has been
exported.
This method is called when the exporter’s context manager interface is
exited, `DatasetExporter.__exit__()`.
* **Parameters:**
**\*args** – the arguments to `DatasetExporter.__exit__()`
### *class* fiftyone.utils.cvat.CVATTaskLabels(labels=None)
Bases: `object`
Description of the labels in a CVAT image annotation task.
* **Parameters:**
**labels** (*None*) –
a list of label dicts in the following format:
```default
[
{
"name": "car",
"attributes": [
{
"name": "type"
"categories": ["coupe", "sedan", "truck"]
},
...
}
},
...
]
```
**Methods:**
| [`merge_task_labels`](#fiftyone.utils.cvat.CVATTaskLabels.merge_task_labels)(task_labels) | Merges the given [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) into this instance. |
|---------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| [`to_schema`](#fiftyone.utils.cvat.CVATTaskLabels.to_schema)() | Returns an `eta.core.image.ImageLabelsSchema` representation of the task labels. |
| [`from_cvat_images`](#fiftyone.utils.cvat.CVATTaskLabels.from_cvat_images)(cvat_images) | Creates a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) instance that describes the active schema of the given annotations. |
| [`from_cvat_tracks`](#fiftyone.utils.cvat.CVATTaskLabels.from_cvat_tracks)(cvat_tracks) | Creates a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) instance that describes the active schema of the given annotations. |
| [`from_labels_dict`](#fiftyone.utils.cvat.CVATTaskLabels.from_labels_dict)(d) | Creates a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) instance from the `` tag of a CVAT annotation XML file. |
| [`from_schema`](#fiftyone.utils.cvat.CVATTaskLabels.from_schema)(schema) | Creates a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) instance from an `eta.core.image.ImageLabelsSchema`. |
#### merge_task_labels(task_labels)
Merges the given [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) into this instance.
* **Parameters:**
**task_labels** – a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels)
#### to_schema()
Returns an `eta.core.image.ImageLabelsSchema` representation of
the task labels.
Note that CVAT’s task labels schema does not distinguish between boxes,
polylines, and keypoints, so the returned schema stores all annotations
under the `"objects"` field.
* **Returns:**
an `eta.core.image.ImageLabelsSchema`
#### *classmethod* from_cvat_images(cvat_images)
Creates a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) instance that describes the active
schema of the given annotations.
* **Parameters:**
**cvat_images** – a list of [`CVATImage`](#fiftyone.utils.cvat.CVATImage) instances
* **Returns:**
a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels)
#### *classmethod* from_cvat_tracks(cvat_tracks)
Creates a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) instance that describes the active
schema of the given annotations.
* **Parameters:**
**cvat_tracks** – a list of [`CVATTrack`](#fiftyone.utils.cvat.CVATTrack) instances
* **Returns:**
a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels)
#### *classmethod* from_labels_dict(d)
Creates a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) instance from the ``
tag of a CVAT annotation XML file.
* **Parameters:**
**d** – a dict representation of a `` tag
* **Returns:**
a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels)
#### *classmethod* from_schema(schema)
Creates a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels) instance from an
`eta.core.image.ImageLabelsSchema`.
* **Parameters:**
**schema** – an `eta.core.image.ImageLabelsSchema`
* **Returns:**
a [`CVATTaskLabels`](#fiftyone.utils.cvat.CVATTaskLabels)
### *class* fiftyone.utils.cvat.CVATImage(id, name, width, height, tags=None, boxes=None, polygons=None, polylines=None, points=None, subset=None)
Bases: `object`
An annotated image in CVAT image format.
* **Parameters:**
* **id** – the ID of the image
* **name** – the filename of the image
* **width** – the width of the image, in pixels
* **height** – the height of the image, in pixels
* **tags** (*None*) – a list of [`CVATImageTag`](#fiftyone.utils.cvat.CVATImageTag) instances
* **boxes** (*None*) – a list of [`CVATImageBox`](#fiftyone.utils.cvat.CVATImageBox) instances
* **polygons** (*None*) – a list of [`CVATImagePolygon`](#fiftyone.utils.cvat.CVATImagePolygon) instances
* **polylines** (*None*) – a list of [`CVATImagePolyline`](#fiftyone.utils.cvat.CVATImagePolyline) instances
* **points** (*None*) – a list of [`CVATImagePoints`](#fiftyone.utils.cvat.CVATImagePoints) instances
* **subset** (*None*) – the project subset of the image, if any
**Attributes:**
| [`has_tags`](#fiftyone.utils.cvat.CVATImage.has_tags) | Whether this image has tags. |
|-----------------------------------------------------------------|-----------------------------------------------|
| [`has_boxes`](#fiftyone.utils.cvat.CVATImage.has_boxes) | Whether this image has 2D boxes. |
| [`has_polylines`](#fiftyone.utils.cvat.CVATImage.has_polylines) | Whether this image has polygons or polylines. |
| [`has_points`](#fiftyone.utils.cvat.CVATImage.has_points) | Whether this image has keypoints. |
**Methods:**
| [`iter_annos`](#fiftyone.utils.cvat.CVATImage.iter_annos)() | Returns an iterator over the annotations in the image. |
|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| [`get_image_metadata`](#fiftyone.utils.cvat.CVATImage.get_image_metadata)() | Returns a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for the annotations. |
| [`to_labels`](#fiftyone.utils.cvat.CVATImage.to_labels)() | Returns [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) representations of the annotations. |
| [`from_labels`](#fiftyone.utils.cvat.CVATImage.from_labels)(labels, metadata) | Creates a [`CVATImage`](#fiftyone.utils.cvat.CVATImage) from a dictionary of labels. |
| [`from_image_dict`](#fiftyone.utils.cvat.CVATImage.from_image_dict)(d) | Creates a [`CVATImage`](#fiftyone.utils.cvat.CVATImage) from an `` tag of a CVAT image annotations XML file. |
#### *property* has_tags
Whether this image has tags.
#### *property* has_boxes
Whether this image has 2D boxes.
#### *property* has_polylines
Whether this image has polygons or polylines.
#### *property* has_points
Whether this image has keypoints.
#### iter_annos()
Returns an iterator over the annotations in the image.
* **Returns:**
an iterator that emits [`CVATImageAnno`](#fiftyone.utils.cvat.CVATImageAnno) instances
#### get_image_metadata()
Returns a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for
the annotations.
* **Returns:**
a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata)
#### to_labels()
Returns [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) representations of the
annotations.
* **Returns:**
a dict mapping field keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label)
instances
#### *classmethod* from_labels(labels, metadata)
Creates a [`CVATImage`](#fiftyone.utils.cvat.CVATImage) from a dictionary of labels.
* **Parameters:**
* **labels** – a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label)
instances
* **metadata** – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) for the
image
* **Returns:**
a [`CVATImage`](#fiftyone.utils.cvat.CVATImage)
#### *classmethod* from_image_dict(d)
Creates a [`CVATImage`](#fiftyone.utils.cvat.CVATImage) from an `` tag of a CVAT image
annotations XML file.
* **Parameters:**
**d** – a dict representation of an `` tag
* **Returns:**
a [`CVATImage`](#fiftyone.utils.cvat.CVATImage)
### *class* fiftyone.utils.cvat.HasCVATBinaryMask
Bases: `object`
Mixin for CVAT annotations that store RLE format instance masks.
### *class* fiftyone.utils.cvat.HasCVATPoints(points)
Bases: `object`
Mixin for CVAT annotations that store a list of `(x, y)` pixel
coordinates.
#### points
a list of `(x, y)` pixel coordinates defining points
**Attributes:**
| [`points_str`](#fiftyone.utils.cvat.HasCVATPoints.points_str) | |
|-----------------------------------------------------------------|----|
#### *property* points_str
### *class* fiftyone.utils.cvat.CVATImageAnno(occluded=None, attributes=None)
Bases: `object`
Mixin for annotations in CVAT image format.
* **Parameters:**
* **occluded** (*None*) – whether the object is occluded
* **attributes** (*None*) – a list of [`CVATAttribute`](#fiftyone.utils.cvat.CVATAttribute) instances
### *class* fiftyone.utils.cvat.CVATImageTag(label, attributes=None)
Bases: [`CVATImageAnno`](#fiftyone.utils.cvat.CVATImageAnno)
A tag in CVAT image format.
* **Parameters:**
* **label** – the tag string
* **attributes** (*None*) – a list of [`CVATAttribute`](#fiftyone.utils.cvat.CVATAttribute) instances
**Methods:**
| [`to_classification`](#fiftyone.utils.cvat.CVATImageTag.to_classification)() | Returns a [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) representation of the tag. |
|------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`from_classification`](#fiftyone.utils.cvat.CVATImageTag.from_classification)(classification) | Creates a [`CVATImageTag`](#fiftyone.utils.cvat.CVATImageTag) from a [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification). |
| [`from_tag_dict`](#fiftyone.utils.cvat.CVATImageTag.from_tag_dict)(d) | Creates a [`CVATImageTag`](#fiftyone.utils.cvat.CVATImageTag) from a `` tag of a CVAT image annotation XML file. |
#### to_classification()
Returns a [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification)
representation of the tag.
* **Returns:**
a [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification)
#### *classmethod* from_classification(classification)
Creates a [`CVATImageTag`](#fiftyone.utils.cvat.CVATImageTag) from a
[`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification).
* **Parameters:**
**classification** – a [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification)
* **Returns:**
a [`CVATImageTag`](#fiftyone.utils.cvat.CVATImageTag)
#### *classmethod* from_tag_dict(d)
Creates a [`CVATImageTag`](#fiftyone.utils.cvat.CVATImageTag) from a `` tag of a
CVAT image annotation XML file.
* **Parameters:**
**d** – a dict representation of a `` tag
* **Returns:**
a [`CVATImageTag`](#fiftyone.utils.cvat.CVATImageTag)
### *class* fiftyone.utils.cvat.CVATImageBox(label, xtl, ytl, xbr, ybr, occluded=None, attributes=None)
Bases: [`CVATImageAnno`](#fiftyone.utils.cvat.CVATImageAnno)
An object bounding box in CVAT image format.
* **Parameters:**
* **label** – the object label string
* **xtl** – the top-left x-coordinate of the box, in pixels
* **ytl** – the top-left y-coordinate of the box, in pixels
* **xbr** – the bottom-right x-coordinate of the box, in pixels
* **ybr** – the bottom-right y-coordinate of the box, in pixels
* **occluded** (*None*) – whether the object is occluded
* **attributes** (*None*) – a list of [`CVATAttribute`](#fiftyone.utils.cvat.CVATAttribute) instances
**Methods:**
| [`to_detection`](#fiftyone.utils.cvat.CVATImageBox.to_detection)(frame_size) | Returns a [`fiftyone.core.labels.Detection`](fiftyone.core.labels.md#fiftyone.core.labels.Detection) representation of the box. |
|-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`from_detection`](#fiftyone.utils.cvat.CVATImageBox.from_detection)(detection, metadata) | Creates a [`CVATImageBox`](#fiftyone.utils.cvat.CVATImageBox) from a [`fiftyone.core.labels.Detection`](fiftyone.core.labels.md#fiftyone.core.labels.Detection). |
| [`from_box_dict`](#fiftyone.utils.cvat.CVATImageBox.from_box_dict)(d) | Creates a [`CVATImageBox`](#fiftyone.utils.cvat.CVATImageBox) from a `` tag of a CVAT image annotation XML file. |
#### to_detection(frame_size)
Returns a [`fiftyone.core.labels.Detection`](fiftyone.core.labels.md#fiftyone.core.labels.Detection) representation of
the box.
* **Parameters:**
**frame_size** – the `(width, height)` of the image
* **Returns:**
a [`fiftyone.core.labels.Detection`](fiftyone.core.labels.md#fiftyone.core.labels.Detection)
#### *classmethod* from_detection(detection, metadata)
Creates a [`CVATImageBox`](#fiftyone.utils.cvat.CVATImageBox) from a
[`fiftyone.core.labels.Detection`](fiftyone.core.labels.md#fiftyone.core.labels.Detection).
* **Parameters:**
* **detection** – a [`fiftyone.core.labels.Detection`](fiftyone.core.labels.md#fiftyone.core.labels.Detection)
* **metadata** – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) for the
image
* **Returns:**
a [`CVATImageBox`](#fiftyone.utils.cvat.CVATImageBox)
#### *classmethod* from_box_dict(d)
Creates a [`CVATImageBox`](#fiftyone.utils.cvat.CVATImageBox) from a `` tag of a CVAT image
annotation XML file.
* **Parameters:**
**d** – a dict representation of a `` tag
* **Returns:**
a [`CVATImageBox`](#fiftyone.utils.cvat.CVATImageBox)
### *class* fiftyone.utils.cvat.CVATImagePolygon(label, points, occluded=None, attributes=None)
Bases: [`CVATImageAnno`](#fiftyone.utils.cvat.CVATImageAnno), [`HasCVATPoints`](#fiftyone.utils.cvat.HasCVATPoints)
A polygon in CVAT image format.
* **Parameters:**
* **label** – the polygon label string
* **points** – a list of `(x, y)` pixel coordinates defining the vertices of
the polygon
* **occluded** (*None*) – whether the polygon is occluded
* **attributes** (*None*) – a list of [`CVATAttribute`](#fiftyone.utils.cvat.CVATAttribute) instances
**Methods:**
| [`to_polyline`](#fiftyone.utils.cvat.CVATImagePolygon.to_polyline)(frame_size) | Returns a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline) representation of the polygon. |
|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`from_polyline`](#fiftyone.utils.cvat.CVATImagePolygon.from_polyline)(polyline, metadata) | Creates a [`CVATImagePolygon`](#fiftyone.utils.cvat.CVATImagePolygon) from a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline). |
| [`from_polygon_dict`](#fiftyone.utils.cvat.CVATImagePolygon.from_polygon_dict)(d) | Creates a [`CVATImagePolygon`](#fiftyone.utils.cvat.CVATImagePolygon) from a `` tag of a CVAT image annotation XML file. |
**Attributes:**
| [`points_str`](#fiftyone.utils.cvat.CVATImagePolygon.points_str) | |
|--------------------------------------------------------------------|----|
#### to_polyline(frame_size)
Returns a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline) representation of
the polygon.
* **Parameters:**
**frame_size** – the `(width, height)` of the image
* **Returns:**
a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline)
#### *classmethod* from_polyline(polyline, metadata)
Creates a [`CVATImagePolygon`](#fiftyone.utils.cvat.CVATImagePolygon) from a
[`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline).
If the [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline) is composed of multiple
shapes, one [`CVATImagePolygon`](#fiftyone.utils.cvat.CVATImagePolygon) per shape will be generated.
* **Parameters:**
* **polyline** – a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline)
* **metadata** – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) for the
image
* **Returns:**
a list of [`CVATImagePolygon`](#fiftyone.utils.cvat.CVATImagePolygon) instances
#### *classmethod* from_polygon_dict(d)
Creates a [`CVATImagePolygon`](#fiftyone.utils.cvat.CVATImagePolygon) from a `` tag of a
CVAT image annotation XML file.
* **Parameters:**
**d** – a dict representation of a `` tag
* **Returns:**
a [`CVATImagePolygon`](#fiftyone.utils.cvat.CVATImagePolygon)
#### *property* points_str
### *class* fiftyone.utils.cvat.CVATImagePolyline(label, points, occluded=None, attributes=None)
Bases: [`CVATImageAnno`](#fiftyone.utils.cvat.CVATImageAnno), [`HasCVATPoints`](#fiftyone.utils.cvat.HasCVATPoints)
A polyline in CVAT image format.
* **Parameters:**
* **label** – the polyline label string
* **points** – a list of `(x, y)` pixel coordinates defining the vertices of
the polyline
* **occluded** (*None*) – whether the polyline is occluded
* **attributes** (*None*) – a list of [`CVATAttribute`](#fiftyone.utils.cvat.CVATAttribute) instances
**Methods:**
| [`to_polyline`](#fiftyone.utils.cvat.CVATImagePolyline.to_polyline)(frame_size) | Returns a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline) representation of the polyline. |
|---------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`from_polyline`](#fiftyone.utils.cvat.CVATImagePolyline.from_polyline)(polyline, metadata) | Creates a [`CVATImagePolyline`](#fiftyone.utils.cvat.CVATImagePolyline) from a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline). |
| [`from_polyline_dict`](#fiftyone.utils.cvat.CVATImagePolyline.from_polyline_dict)(d) | Creates a [`CVATImagePolyline`](#fiftyone.utils.cvat.CVATImagePolyline) from a `` tag of a CVAT image annotation XML file. |
**Attributes:**
| [`points_str`](#fiftyone.utils.cvat.CVATImagePolyline.points_str) | |
|---------------------------------------------------------------------|----|
#### to_polyline(frame_size)
Returns a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline) representation of
the polyline.
* **Parameters:**
**frame_size** – the `(width, height)` of the image
* **Returns:**
a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline)
#### *classmethod* from_polyline(polyline, metadata)
Creates a [`CVATImagePolyline`](#fiftyone.utils.cvat.CVATImagePolyline) from a
[`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline).
If the [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline) is composed of multiple
shapes, one [`CVATImagePolyline`](#fiftyone.utils.cvat.CVATImagePolyline) per shape will be generated.
* **Parameters:**
* **polyline** – a [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline)
* **metadata** – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) for the
image
* **Returns:**
a list of [`CVATImagePolyline`](#fiftyone.utils.cvat.CVATImagePolyline) instances
#### *classmethod* from_polyline_dict(d)
Creates a [`CVATImagePolyline`](#fiftyone.utils.cvat.CVATImagePolyline) from a `` tag of a
CVAT image annotation XML file.
* **Parameters:**
**d** – a dict representation of a `` tag
* **Returns:**
a [`CVATImagePolyline`](#fiftyone.utils.cvat.CVATImagePolyline)
#### *property* points_str
### *class* fiftyone.utils.cvat.CVATImagePoints(label, points, occluded=None, attributes=None)
Bases: [`CVATImageAnno`](#fiftyone.utils.cvat.CVATImageAnno), [`HasCVATPoints`](#fiftyone.utils.cvat.HasCVATPoints)
A set of keypoints in CVAT image format.
* **Parameters:**
* **label** – the keypoints label string
* **points** – a list of `(x, y)` pixel coordinates defining the vertices of
the keypoints
* **occluded** (*None*) – whether the keypoints are occluded
* **attributes** (*None*) – a list of [`CVATAttribute`](#fiftyone.utils.cvat.CVATAttribute) instances
**Methods:**
| [`to_keypoint`](#fiftyone.utils.cvat.CVATImagePoints.to_keypoint)(frame_size) | Returns a [`fiftyone.core.labels.Keypoint`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoint) representation of the points. |
|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`from_keypoint`](#fiftyone.utils.cvat.CVATImagePoints.from_keypoint)(keypoint, metadata) | Creates a [`CVATImagePoints`](#fiftyone.utils.cvat.CVATImagePoints) from a [`fiftyone.core.labels.Keypoint`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoint). |
| [`from_points_dict`](#fiftyone.utils.cvat.CVATImagePoints.from_points_dict)(d) | Creates a [`CVATImagePoints`](#fiftyone.utils.cvat.CVATImagePoints) from a `` tag of a CVAT image annotation XML file. |
**Attributes:**
| [`points_str`](#fiftyone.utils.cvat.CVATImagePoints.points_str) | |
|-------------------------------------------------------------------|----|
#### to_keypoint(frame_size)
Returns a [`fiftyone.core.labels.Keypoint`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoint) representation of
the points.
* **Parameters:**
**frame_size** – the `(width, height)` of the image
* **Returns:**
a [`fiftyone.core.labels.Keypoint`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoint)
#### *classmethod* from_keypoint(keypoint, metadata)
Creates a [`CVATImagePoints`](#fiftyone.utils.cvat.CVATImagePoints) from a
[`fiftyone.core.labels.Keypoint`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoint).
* **Parameters:**
* **keypoint** – a [`fiftyone.core.labels.Keypoint`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoint)
* **metadata** – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) for the
image
* **Returns:**
a [`CVATImagePoints`](#fiftyone.utils.cvat.CVATImagePoints)
#### *classmethod* from_points_dict(d)
Creates a [`CVATImagePoints`](#fiftyone.utils.cvat.CVATImagePoints) from a `` tag of a
CVAT image annotation XML file.
* **Parameters:**
**d** – a dict representation of a `` tag
* **Returns:**
a [`CVATImagePoints`](#fiftyone.utils.cvat.CVATImagePoints)
#### *property* points_str
### *class* fiftyone.utils.cvat.CVATTrack(id, label, width, height, boxes=None, polygons=None, polylines=None, points=None)
Bases: `object`
An annotation track in CVAT video format.
* **Parameters:**
* **id** – the ID of the track
* **label** – the label for the track
* **width** – the width of the video frames, in pixels
* **height** – the height of the video frames, in pixels
* **boxes** (*None*) – a dict mapping frame numbers to [`CVATVideoBox`](#fiftyone.utils.cvat.CVATVideoBox)
instances
* **polygons** (*None*) – a dict mapping frame numbers to
[`CVATVideoPolygon`](#fiftyone.utils.cvat.CVATVideoPolygon) instances
* **polylines** (*None*) – a dict mapping frame numbers to
[`CVATVideoPolyline`](#fiftyone.utils.cvat.CVATVideoPolyline) instances
* **points** (*None*) – a dict mapping frame numbers to [`CVATVideoPoints`](#fiftyone.utils.cvat.CVATVideoPoints)
instances
**Attributes:**
| [`has_boxes`](#fiftyone.utils.cvat.CVATTrack.has_boxes) | Whether this track has 2D boxes. |
|-----------------------------------------------------------------|-----------------------------------------------|
| [`has_polylines`](#fiftyone.utils.cvat.CVATTrack.has_polylines) | Whether this track has polygons or polylines. |
| [`has_points`](#fiftyone.utils.cvat.CVATTrack.has_points) | Whether this track has keypoints. |
**Methods:**
| [`iter_annos`](#fiftyone.utils.cvat.CVATTrack.iter_annos)() | Returns an iterator over the annotations in the track. |
|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| [`to_labels`](#fiftyone.utils.cvat.CVATTrack.to_labels)() | Returns [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) representations of the annotations. |
| [`from_labels`](#fiftyone.utils.cvat.CVATTrack.from_labels)(id, labels, frame_size) | Creates a [`CVATTrack`](#fiftyone.utils.cvat.CVATTrack) from a dictionary of labels. |
| [`from_track_dict`](#fiftyone.utils.cvat.CVATTrack.from_track_dict)(d, frame_size) | Creates a [`CVATTrack`](#fiftyone.utils.cvat.CVATTrack) from a `