fiftyone.core.stages.Exclude

class documentation

class Exclude(ViewStage): (source)

Constructor: Exclude(sample_ids)

View In Hierarchy

Excludes the samples with the given IDs from a collection.

Examples:

import fiftyone as fo

dataset = fo.Dataset()
dataset.add_samples(
    [
        fo.Sample(filepath="/path/to/image1.png"),
        fo.Sample(filepath="/path/to/image2.png"),
        fo.Sample(filepath="/path/to/image3.png"),
    ]
)

#
# Exclude the first sample from the dataset
#

sample_id = dataset.first().id
stage = fo.Exclude(sample_id)
view = dataset.add_stage(stage)

#
# Exclude the first and last samples from the dataset
#

sample_ids = [dataset.first().id, dataset.last().id]
stage = fo.Exclude(sample_ids)
view = dataset.add_stage(stage)
Parameters
sample_ids

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

Method __init__ Undocumented
Method to_mongo Returns the MongoDB aggregation pipeline for the stage.
Property sample_ids The list of sample IDs to exclude.
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.
Instance Variable _sample_ids 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.
Method validate Validates that the stage can be applied to the given collection.
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_frames Whether the stage requires frame labels of video samples to be attached.
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, sample_ids): (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)
@property
sample_ids = (source)

The list of sample IDs to exclude.

@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
_sample_ids = (source)

Undocumented