fiftyone.utils.data.exporters.ImageDirectoryExporter

class documentation

class ImageDirectoryExporter(UnlabeledImageDatasetExporter): (source)

Constructor: ImageDirectoryExporter(export_dir, export_media, rel_dir, image_format)

Exporter that writes a directory of images to disk.

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

The filenames of input image paths will be maintained in the export directory, unless a name conflict would occur, in which case an index of the form "-%d" % count is appended to the base filename.

Parameters
export_dir	the directory to write the export
export_media	defines how to export the raw media contained in the dataset. The supported values are: `True` (default): copy all media files into the export directory `"move"`: move media files into the export directory `"symlink"`: create symlinks to each media file in the export directory
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 `export_dir` 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`
image_format	the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used

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	`export_media`	Undocumented
Instance Variable	`image_format`	Undocumented
Instance Variable	`rel_dir`	Undocumented
Property	`requires_image_metadata`	Whether this exporter requires `fiftyone.core.metadata.ImageMetadata` instances for each sample being exported.
Instance Variable	`_media_exporter`	Undocumented

Inherited from DatasetExporter (via UnlabeledImageDatasetExporter):

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

def __init__(self, export_dir, export_media=None, rel_dir=None, image_format=None): (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, metadata=None): (source) ¶

overrides fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.export_sample

Exports the given sample to the dataset.

Parameters
image_or_path	an image or the path to the image on disk
metadata:`None`	a `fiftyone.core.metadata.ImageMetadata` instance for the sample. Only required when `requires_image_metadata` is `True`

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

export_media: None = (source) ¶

Undocumented

image_format: None = (source) ¶

Undocumented

rel_dir: None = (source) ¶

Undocumented

@property
requires_image_metadata = (source) ¶

overrides fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.requires_image_metadata

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

_media_exporter = (source) ¶

Undocumented