fiftyone.utils.voc.VOCDetectionDatasetExporter

class documentation

class VOCDetectionDatasetExporter(foud.LabeledImageDatasetExporter, foud.ExportPathsMixin): (source)

Constructor: VOCDetectionDatasetExporter(export_dir, data_path, labels_path, export_media, ...)

Exporter that writes VOC detection datasets to disk.

See :ref:`this page <VOCDetectionDataset-export>` for format details.

Parameters
export_dir	the directory to write the export. This has no effect if `data_path` and `labels_path` are absolute paths
data_path	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	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 folder path 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	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	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` and `labels_path` to generate output paths for each exported image and labels file. 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`
include_paths	whether to include the absolute paths to the images in the `<path>` elements of the exported XML
image_format	the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used
extra_attrs	whether to include extra object attributes in the exported labels. Supported values are: `True`: export all extra attributes found `False`: do not export extra attributes a name or list of names of specific attributes to export

Method	`__init__`	Undocumented
Method	`close`	Performs any necessary actions after the last sample has been exported.
Method	`export_sample`	Exports the given sample to the dataset.
Method	`setup`	Performs any necessary setup before exporting the first sample in the dataset.
Instance Variable	`data_path`	Undocumented
Instance Variable	`export_media`	Undocumented
Instance Variable	`extra_attrs`	Undocumented
Instance Variable	`image_format`	Undocumented
Instance Variable	`include_paths`	Undocumented
Instance Variable	`labels_path`	Undocumented
Instance Variable	`rel_dir`	Undocumented
Property	`label_cls`	The `fiftyone.core.labels.Label` class(es) exported by this exporter.
Property	`requires_image_metadata`	Whether this exporter requires `fiftyone.core.metadata.ImageMetadata` instances for each sample being exported.
Instance Variable	`_media_exporter`	Undocumented
Instance Variable	`_writer`	Undocumented

Inherited from DatasetExporter (via LabeledImageDatasetExporter):

Method	`__enter__`	Undocumented
Method	`__exit__`	Undocumented
Method	`log_collection`	Logs any relevant information about the `fiftyone.core.collections.SampleCollection` whose samples will be exported.

Inherited from ExportPathsMixin (via LabeledImageDatasetExporter, DatasetExporter):

Static Method	`_parse_data_path`	Helper function that computes default values for the `data_path` and `export_media` parameters supported by many exporters.
Static Method	`_parse_labels_path`	Helper function that computes default values for the `labels_path` parameter supported by many exporters.

def __init__(self, export_dir=None, data_path=None, labels_path=None, export_media=None, rel_dir=None, include_paths=True, image_format=None, extra_attrs=True): (source) ¶

overrides fiftyone.utils.data.exporters.DatasetExporter.__init__

Undocumented

def close(self, *args): (source) ¶

overrides fiftyone.utils.data.exporters.DatasetExporter.close

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__`

def export_sample(self, image_or_path, detections, metadata=None): (source) ¶

overrides fiftyone.utils.data.exporters.LabeledImageDatasetExporter.export_sample

Exports the given sample to the dataset.

Parameters
image_or_path	an image or the path to the image on disk
detections	Undocumented
metadata:`None`	a `fiftyone.core.metadata.ImageMetadata` instance for the sample. Only required when `requires_image_metadata` is `True`
label	an instance of `label_cls`, or a dictionary mapping field names to `fiftyone.core.labels.Label` instances, or `None` if the sample is unlabeled

def setup(self): (source) ¶

overrides fiftyone.utils.data.exporters.DatasetExporter.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__.

data_path: None = (source) ¶

Undocumented

export_media: None = (source) ¶

Undocumented

extra_attrs: True = (source) ¶

Undocumented

image_format: None = (source) ¶

Undocumented

include_paths: True = (source) ¶

Undocumented

labels_path: None = (source) ¶

Undocumented

rel_dir: None = (source) ¶

Undocumented

@property
label_cls = (source) ¶

overrides fiftyone.utils.data.exporters.LabeledImageDatasetExporter.label_cls

The fiftyone.core.labels.Label class(es) exported by this exporter.

This can be any of the following:

a 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 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 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

@property
requires_image_metadata = (source) ¶

overrides fiftyone.utils.data.exporters.LabeledImageDatasetExporter.requires_image_metadata

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.

_media_exporter = (source) ¶

Undocumented

_writer = (source) ¶

Undocumented