fiftyone.operators.constants

FiftyOne operator constants.

Copyright 2017-2026, Voxel51, Inc.

voxel51.com

Classes:

ViewTarget()

Choices for target view that an operator should operate on

Functions:

scope_view_target(target, media_type)	Returns the view target value that scopes target of a grouped dataset to every group slice of media_type.
split_view_target(value)	Splits a view target value into its ViewTarget and the group slice media type it is scoped to.

class fiftyone.operators.constants.ViewTarget

Bases: object

Choices for target view that an operator should operate on

See fiftyone.operators.types.ViewTargetProperty() for details.

Attributes:

BASE_VIEW	Base view from which a generated view was created
CURRENT_VIEW	Current view in the app
DATASET	Entire dataset
DATASET_VIEW	Empty dataset view, i.e., ctx.dataset.view().
SELECTED_LABELS	Selected labels in the app view, if any.
SELECTED_SAMPLES	Selected samples in the app view, if any.
CUSTOM_VIEW_TARGET	Custom view target specified by the caller.

Methods:

values()

Returns all ViewTarget values.

BASE_VIEW = 'BASE_VIEW'

Base view from which a generated view was created

If the current view is a generated view such as fiftyone.core.clips.ClipsView, fiftyone.core.video.FramesView, or fiftyone.core.patches.PatchesView), base view is the semantic equivalent of “entire dataset” for these views. The base view is the view from which the generated view was created. For example, dataset.limit(51).to_frames("ground_truth").limit(10) has a base view of dataset.limit(51).to_frames("ground_truth")

CURRENT_VIEW = 'CURRENT_VIEW'

Current view in the app

DATASET = 'DATASET'

Entire dataset

DATASET_VIEW = 'DATASET_VIEW'

Empty dataset view, i.e., ctx.dataset.view().

Note: unlikely to be useful in the typical case.

SELECTED_LABELS = 'SELECTED_LABELS'

Selected labels in the app view, if any.

SELECTED_SAMPLES = 'SELECTED_SAMPLES'

Selected samples in the app view, if any.

CUSTOM_VIEW_TARGET = 'CUSTOM_VIEW_TARGET'

Custom view target specified by the caller.

When using this option, specify ‘custom_view_target’ in the operator parameters with a list of JSON-serialized view stages to apply.

classmethod values()

Returns all ViewTarget values.

fiftyone.operators.constants.scope_view_target(target, media_type)

Returns the view target value that scopes target of a grouped dataset to every group slice of media_type.

Parameters:

• target – a ViewTarget value

• media_type – a group slice media type

Returns:

a view target value

fiftyone.operators.constants.split_view_target(value)

Splits a view target value into its ViewTarget and the group slice media type it is scoped to.

Parameters:

value – a view target value, as returned by scope_view_target() or a ViewTarget value

Returns:

a (target, media_type) tuple, where media_type is None if the value is not scoped