fiftyone.core.stages.SelectGroups

class documentation

class SelectGroups(ViewStage): (source)

Constructor: SelectGroups(group_ids, ordered)

Selects the groups with the given IDs from a grouped collection.

Examples:

import fiftyone as fo
import fiftyone.zoo as foz

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

#
# Select some specific groups by ID
#

group_ids = dataset.take(10).values("group.id")

stage = fo.SelectGroups(group_ids)
view = dataset.add_stage(stage)

assert set(view.values("group.id")) == set(group_ids)

stage = fo.SelectGroups(group_ids, ordered=True)
view = dataset.add_stage(stage)

assert view.values("group.id") == group_ids

Parameters

groups_ids

the groups to select. Can be any of the following:

a group ID
an iterable of group IDs
a fiftyone.core.sample.Sample or fiftyone.core.sample.SampleView
a group dict returned by get_group()
an iterable of fiftyone.core.sample.Sample or fiftyone.core.sample.SampleView instances
an iterable of group dicts returned by get_group()
a fiftyone.core.collections.SampleCollection

ordered whether to sort the groups in the returned view to match the order of the provided IDs

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	`group_ids`	The list of group IDs to select.
Property	`ordered`	Whether to sort the groups in the same order as the IDs.
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	`_group_ids`	Undocumented
Instance Variable	`_ordered`	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_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, group_ids, ordered=False): (source) ¶

Undocumented

def to_mongo(self, sample_collection): (source) ¶

overrides fiftyone.core.stages.ViewStage.to_mongo

Returns the MongoDB aggregation pipeline for the stage.

Only usable if has_view is False.

Parameters
sample_collection	the `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_collection	a `fiftyone.core.collections.SampleCollection`
Raises
`ViewStageError`	if the stage cannot be applied to the collection

@property
group_ids = (source) ¶

The list of group IDs to select.

@property
ordered = (source) ¶

Whether to sort the groups in the same order as the IDs.

@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

_group_ids = (source) ¶

Undocumented

_ordered = (source) ¶

Undocumented