fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser

class documentation

class FiftyOneLabeledVideoSampleParser(ExtractClipsMixin, LabeledVideoSampleParser): (source)

Constructor: FiftyOneLabeledVideoSampleParser(label_field, frame_labels_field, label_fcn, frame_labels_fcn, ...)

Parser for fiftyone.core.sample.Sample instances that contain labeled videos.

This class also supports fiftyone.core.clips.ClipView instances.

Parameters
label_field	the name of a label field to parse, or a dictionary mapping label field names to output keys to use in the returned sample-level labels dictionary
frame_labels_field	the name of a frame label field to parse, or a dictionary mapping field names to output keys describing the frame label fields to export
label_fcn	an optional function or dictionary mapping label field names to functions (must match `label_field`) to apply to each sample label before returning it
frame_labels_fcn	an optional function or dictionary mapping frame label field names to functions (must match `frame_labels_field`) to apply to each frame label before returning it
compute_metadata	whether to compute `fiftyone.core.metadata.VideoMetadata` instances on-the-fly if `get_video_metadata` is called and no metadata is available
write_clips	whether to write clips when `get_video_path` is called
clip_dir	a directory to write clips. Only applicable when parsing `fiftyone.core.clips.ClipView` instances
video_format	the video format to use when writing video clips to disk. By default, `fiftyone.config.default_video_ext` is used

Method	`__init__`	Undocumented
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.
Instance Variable	`frame_fcn_dict`	Undocumented
Instance Variable	`frame_labels_dict`	Undocumented
Instance Variable	`label_fcn`	Undocumented
Instance Variable	`label_field`	Undocumented
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.
Static Method	`_parse_frame_args`	Undocumented

Inherited from ExtractClipsMixin:

Method	`_get_clip_metadata`	Undocumented
Method	`_get_clip_path`	Undocumented
Instance Variable	`_curr_clip_path`	Undocumented

Inherited from SampleParser (via ExtractClipsMixin, LabeledVideoSampleParser):

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, label_field=None, frame_labels_field=None, label_fcn=None, frame_labels_fcn=None, compute_metadata=False, write_clips=True, clip_dir=None, video_format=None): (source) ¶

overrides fiftyone.utils.data.parsers.ExtractClipsMixin.__init__

Undocumented

def get_frame_labels(self): (source) ¶

overrides fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_frame_labels

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) ¶

overrides fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_label

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) ¶

overrides fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_video_metadata

Returns the video metadata for the current sample.

Returns
a `fiftyone.core.metadata.ImageMetadata` instance

def get_video_path(self): (source) ¶

overrides fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_video_path

Returns the video path for the current sample.

Returns
the path to the video on disk

frame_fcn_dict = (source) ¶

Undocumented

frame_labels_dict = (source) ¶

Undocumented

label_fcn: None = (source) ¶

Undocumented

label_field: None = (source) ¶

Undocumented

@property
frame_labels_cls = (source) ¶

overrides fiftyone.utils.data.parsers.LabeledVideoSampleParser.frame_labels_cls

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) ¶

overrides fiftyone.utils.data.parsers.LabeledVideoSampleParser.has_video_metadata

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

@property
label_cls = (source) ¶

overrides fiftyone.utils.data.parsers.LabeledVideoSampleParser.label_cls

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

@staticmethod
def _parse_frame_args(frame_labels_field, frame_labels_fcn): (source) ¶

Undocumented