fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser

class documentation

class FiftyOneUnlabeledImageSampleParser(UnlabeledImageSampleParser): (source)

Constructor: FiftyOneUnlabeledImageSampleParser(compute_metadata)

View In Hierarchy

Parser for fiftyone.core.sample.Sample instances that contain images.

Parameters
compute_metadatawhether to compute fiftyone.core.metadata.ImageMetadata instances on-the-fly if get_image_metadata is called and no metadata is available
Method __init__ Undocumented
Method get_image Returns the image from the current sample.
Method get_image_metadata Returns the image metadata for the current sample.
Method get_image_path Returns the image path for the current sample.
Instance Variable compute_metadata Undocumented
Property has_image_metadata Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
Property has_image_path Whether this parser produces paths to images on disk for samples that it parses.

Inherited from SampleParser (via UnlabeledImageSampleParser):

Method clear_sample Clears the current sample.
Method with_sample Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample.
Property current_sample The current sample.
Instance Variable _current_sample Undocumented
def __init__(self, compute_metadata=False): (source)
overrides fiftyone.utils.data.parsers.SampleParser.__init__

Undocumented

def get_image(self): (source)
overrides fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image

Returns the image from the current sample.

Returns
a numpy image
def get_image_metadata(self): (source)
overrides fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image_metadata

Returns the image metadata for the current sample.

Returns
a fiftyone.core.metadata.ImageMetadata instance
def get_image_path(self): (source)
overrides fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image_path

Returns the image path for the current sample.

Returns
the path to the image on disk
compute_metadata: False = (source)

Undocumented

@property
has_image_metadata = (source)
overrides fiftyone.utils.data.parsers.UnlabeledImageSampleParser.has_image_metadata

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.

@property
has_image_path = (source)
overrides fiftyone.utils.data.parsers.UnlabeledImageSampleParser.has_image_path

Whether this parser produces paths to images on disk for samples that it parses.