fiftyone.core.stages.ExcludeFrames

class documentation

class ExcludeFrames(ViewStage): (source)

Constructor: ExcludeFrames(frame_ids, omit_empty)

View In Hierarchy

Excludes the frames with the given IDs from a video collection.

Examples:

import fiftyone as fo
import fiftyone.zoo as foz

dataset = foz.load_zoo_dataset("quickstart-video")

#
# Exclude some specific frames
#

frame_ids = [
    dataset.first().frames.first().id,
    dataset.last().frames.last().id,
]

stage = fo.ExcludeFrames(frame_ids)
view = dataset.add_stage(stage)

print(dataset.count("frames"))
print(view.count("frames"))
Parameters
frame_ids

the frames to exclude. Can be any of the following:

omit_emptywhether to omit samples that have no frames after excluding the specified frames
Method __init__ Undocumented
Method to_mongo Returns the MongoDB aggregation pipeline for the stage.
Method validate Validates that the stage can be applied to the given collection.
Property frame_ids The list of frame IDs to exclude.
Property omit_empty Whether to omit samples that have no frames after filtering.
Class Method _params Returns a list of JSON dicts describing the stage's supported parameters.
Method _kwargs Returns a list of [name, value] lists describing the parameters of this stage instance.
Method _needs_frames Whether the stage requires frame labels of video samples to be attached.
Instance Variable _frame_ids Undocumented
Instance Variable _omit_empty Undocumented

Inherited from ViewStage:

Method __eq__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method get_edited_fields Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
Method get_excluded_fields Returns a list of fields that have been excluded by the stage, if any.
Method get_filtered_fields Returns a list of names of fields or embedded fields that contain arrays have been filtered by the stage, if any.
Method get_group_expr Returns the dynamic group expression for the given stage, if any.
Method get_media_type Returns the media type outputted by this stage when applied to the given collection, if and only if it is different from the input type.
Method get_selected_fields Returns a list of fields that have been selected by the stage, if any.
Method load_view Loads the fiftyone.core.view.DatasetView containing the output of the stage.
Property has_view Whether this stage's output view should be loaded via load_view rather than appending stages to an aggregation pipeline via to_mongo.
Property outputs_dynamic_groups Whether this stage outputs or flattens dynamic groups.
Class Method _from_dict Creates a ViewStage instance from a serialized JSON dict representation of it.
Method _needs_group_slices Whether the stage requires group slice(s) to be attached.
Method _serialize Returns a JSON dict representation of the ViewStage.
Instance Variable _uuid Undocumented
def __init__(self, frame_ids, omit_empty=True): (source)

Undocumented

def to_mongo(self, _): (source)
overrides fiftyone.core.stages.ViewStage.to_mongo

Returns the MongoDB aggregation pipeline for the stage.

Only usable if has_view is False.

Parameters
_Undocumented
sample_collectionthe fiftyone.core.collections.SampleCollection to which the stage is being applied
Returns
a MongoDB aggregation pipeline (list of dicts)
def validate(self, sample_collection): (source)
overrides fiftyone.core.stages.ViewStage.validate

Validates that the stage can be applied to the given collection.

Parameters
sample_collectiona fiftyone.core.collections.SampleCollection
Raises
ViewStageErrorif the stage cannot be applied to the collection
@property
frame_ids = (source)

The list of frame IDs to exclude.

@property
omit_empty = (source)

Whether to omit samples that have no frames after filtering.

@classmethod
def _params(cls): (source)
overrides fiftyone.core.stages.ViewStage._params

Returns a list of JSON dicts describing the stage's supported parameters.

Returns
a list of JSON dicts
def _kwargs(self): (source)
overrides fiftyone.core.stages.ViewStage._kwargs

Returns a list of [name, value] lists describing the parameters of this stage instance.

Returns
a list of [name, value] lists
def _needs_frames(self, _): (source)
overrides fiftyone.core.stages.ViewStage._needs_frames

Whether the stage requires frame labels of video samples to be attached.

Parameters
_Undocumented
sample_collectionthe fiftyone.core.collections.SampleCollection to which the stage is being applied
Returns
True/False
_frame_ids = (source)

Undocumented

_omit_empty = (source)

Undocumented