fiftyone.utils.data.parsers.LabeledVideoSampleParser

class documentation

class LabeledVideoSampleParser(SampleParser): (source)

Known subclasses: fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser, fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser, fiftyone.utils.data.parsers.VideoLabelsSampleParser

View In Hierarchy

Interface for SampleParser instances that parse labeled video samples.

The general recipe for using LabeledVideoSampleParser instances is as follows:

sample_parser = LabeledVideoSampleParser(...)

for sample in samples:
    sample_parser.with_sample(sample)
    video_path = sample_parser.get_video_path()
    label = sample_parser.get_label()
    frames = sample_parser.get_frame_labels()

    if sample_parser.has_video_metadata:
        video_metadata = sample_parser.get_video_metadata()
Method get_frame_labels Returns the frame labels for the current sample.
Method get_label Returns the sample-level labels for the current sample.
Method get_video_metadata Returns the video metadata for the current sample.
Method get_video_path Returns the video path for the current sample.
Property frame_labels_cls The fiftyone.core.labels.Label class(es) returned by this parser within the frame labels that it produces.
Property has_video_metadata Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.
Property label_cls The fiftyone.core.labels.Label class(es) returned by this parser within the sample-level labels that it produces.

Inherited from SampleParser:

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 get_frame_labels(self): (source)
overridden in fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser, fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser, fiftyone.utils.data.parsers.VideoLabelsSampleParser

Returns the frame labels for the current sample.

Returns
a dictionary mapping frame numbers to dictionaries that map label fields to fiftyone.core.labels.Label instances for each video frame, or None if the sample has no frame labels
def get_label(self): (source)
overridden in fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser, fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser, fiftyone.utils.data.parsers.VideoLabelsSampleParser

Returns the sample-level labels 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 has no sample-level labels
def get_video_metadata(self): (source)
overridden in fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser, fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser

Returns the video metadata for the current sample.

Returns
a fiftyone.core.metadata.ImageMetadata instance
def get_video_path(self): (source)
overridden in fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser, fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser, fiftyone.utils.data.parsers.VideoLabelsSampleParser

Returns the video path for the current sample.

Returns
the path to the video on disk
@property
frame_labels_cls = (source)
overridden in fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser, fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser, fiftyone.utils.data.parsers.VideoLabelsSampleParser

The fiftyone.core.labels.Label class(es) returned by this parser within the frame labels that it produces.

This can be any of the following:

  • a fiftyone.core.labels.Label class. In this case, the parser is guaranteed to return frame labels of this type
  • a list or tuple of fiftyone.core.labels.Label classes. In this case, the parser can produce a single frame label field of any of these types
  • a dict mapping keys to fiftyone.core.labels.Label classes. In this case, the parser will return frame label dictionaries with keys and value-types specified by this dictionary. Not all keys need be present in each frame
  • None. In this case, the parser makes no guarantees about the frame labels that it may return
@property
has_video_metadata = (source)
overridden in fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser, fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser, fiftyone.utils.data.parsers.VideoLabelsSampleParser

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

@property
label_cls = (source)
overridden in fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser, fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser, fiftyone.utils.data.parsers.VideoLabelsSampleParser

The fiftyone.core.labels.Label class(es) returned by this parser within the sample-level labels that it produces.

This can be any of the following:

  • a fiftyone.core.labels.Label class. In this case, the parser is guaranteed to return sample-level labels of this type
  • a list or tuple of fiftyone.core.labels.Label classes. In this case, the parser can produce a single sample-level label field of any of these types
  • a dict mapping keys to fiftyone.core.labels.Label classes. In this case, the parser will return sample-level 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 sample-level labels that it may return