fiftyone.utils.data.parsers.LabeledImageTupleSampleParser

class documentation

class LabeledImageTupleSampleParser(LabeledImageSampleParser): (source)

Known subclasses: fiftyone.utils.data.parsers.ImageClassificationSampleParser, fiftyone.utils.data.parsers.ImageDetectionSampleParser, fiftyone.utils.data.parsers.ImageLabelsSampleParser

View In Hierarchy

Generic sample parser that parses samples that are (image_or_path, label) tuples, where:

  • image_or_path is either an image that can be converted to numpy format via np.asarray() or the path to an image on disk
  • label is a fiftyone.core.labels.Label instance

This implementation provides a _current_image property that caches the image for the current sample, for efficiency in case multiple getters require access to the image (e.g., to normalize coordinates, compute metadata, etc).

See the following subclasses of this parser for implementations that parse labels for common tasks:

Method __init__ Undocumented
Method clear_sample Clears the current sample.
Method get_image Returns the image from the current sample.
Method get_image_path Returns the image path for the current sample.
Method get_label Returns the label for the current sample.
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.
Property label_cls The fiftyone.core.labels.Label class(es) returned by this parser.
Method _get_image Undocumented
Method _parse_image Undocumented
Instance Variable _current_image_cache Undocumented
Property _current_image Undocumented

Inherited from LabeledImageSampleParser:

Method get_image_metadata Returns the image metadata for the current sample.

Inherited from SampleParser (via LabeledImageSampleParser):

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): (source)
overrides fiftyone.utils.data.parsers.SampleParser.__init__
overridden in fiftyone.utils.data.parsers.ImageClassificationSampleParser, fiftyone.utils.data.parsers.ImageDetectionSampleParser, fiftyone.utils.data.parsers.ImageLabelsSampleParser

Undocumented

def clear_sample(self): (source)
overrides fiftyone.utils.data.parsers.SampleParser.clear_sample

Clears the current sample.

Also clears any cached sample information stored by the parser.

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

Returns the image from the current sample.

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

Returns the image path for the current sample.

Returns
the path to the image on disk
def get_label(self): (source)
overrides fiftyone.utils.data.parsers.LabeledImageSampleParser.get_label
overridden in fiftyone.utils.data.parsers.ImageClassificationSampleParser, fiftyone.utils.data.parsers.ImageDetectionSampleParser, fiftyone.utils.data.parsers.ImageLabelsSampleParser

Returns the label for the current sample.

Returns
a fiftyone.core.labels.Label instance, or a dictionary mapping field names to fiftyone.core.labels.Label instances, or None if the sample is unlabeled
@property
has_image_metadata = (source)
overrides fiftyone.utils.data.parsers.LabeledImageSampleParser.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.LabeledImageSampleParser.has_image_path

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

@property
label_cls = (source)
overrides fiftyone.utils.data.parsers.LabeledImageSampleParser.label_cls
overridden in fiftyone.utils.data.parsers.ImageClassificationSampleParser, fiftyone.utils.data.parsers.ImageDetectionSampleParser, fiftyone.utils.data.parsers.ImageLabelsSampleParser

The fiftyone.core.labels.Label class(es) returned by this parser.

This can be any of the following:

  • a fiftyone.core.labels.Label class. In this case, the parser is guaranteed to return labels of this type
  • a list or tuple of fiftyone.core.labels.Label classes. In this case, the parser can produce a single label field of any of these types
  • a dict mapping keys to fiftyone.core.labels.Label classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return
def _get_image(self): (source)
overridden in fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser, fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser

Undocumented

def _parse_image(self, image_or_path): (source)

Undocumented

_current_image_cache = (source)

Undocumented

@property
_current_image = (source)

Undocumented