fiftyone.utils.data.parsers.SampleParser

class documentation

class SampleParser(object): (source)

Known subclasses: fiftyone.utils.data.parsers.LabeledImageSampleParser, fiftyone.utils.data.parsers.LabeledVideoSampleParser, fiftyone.utils.data.parsers.UnlabeledImageSampleParser, fiftyone.utils.data.parsers.UnlabeledMediaSampleParser, fiftyone.utils.data.parsers.UnlabeledVideoSampleParser

View In Hierarchy

Base interface for sample parsers.

SampleParser instances are used to parse samples emitted by dataset iterators when ingesting them into fiftyone.core.dataset.Dataset instances.

The general recipe for using SampleParser instances is as follows:

sample_parser = SampleParser(...)

for sample in samples:
    sample_parser.with_sample(sample)
    field = sample_parser.get_<field>()

where field is a subclass specific field to parse from the sample.

Method	`__init__`	Undocumented
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): (source) ¶

overridden in fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser, fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser, fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser, fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser, fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser, fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser, fiftyone.utils.data.parsers.LabeledImageTupleSampleParser, fiftyone.utils.data.parsers.VideoLabelsSampleParser, fiftyone.utils.dicom.DICOMSampleParser, fiftyone.utils.tf.TFRecordSampleParser

Undocumented

def clear_sample(self): (source) ¶

overridden in fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser, fiftyone.utils.data.parsers.LabeledImageTupleSampleParser, fiftyone.utils.data.parsers.VideoLabelsSampleParser, fiftyone.utils.dicom.DICOMSampleParser, fiftyone.utils.tf.TFRecordSampleParser

Clears the current sample.

Also clears any cached sample information stored by the parser.

def with_sample(self, sample): (source) ¶

overridden in fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser

Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample.

Guaranteed to call clear_sample before setting the current sample.

Parameters
sample	a sample

@property
current_sample = (source) ¶

The current sample.

Raises
`ValueError`	if there is no current sample

_current_sample = (source) ¶

Undocumented