module documentation

Expressions for fiftyone.core.stages.ViewStage definitions.

Copyright 2017-2025, Voxel51, Inc.

Class ObjectId A ViewExpression that refers to an ObjectId of a document.
Class ViewExpression An expression defining a possibly-complex manipulation of a document.
Class ViewField A ViewExpression that refers to a field or embedded field of a document.
Function get_group_slices Extracts the group slices from the given expression, if any.
Function is_frames_expr Determines whether the given expression involves a "frames" field.
Function to_mongo Converts an expression to its MongoDB representation.
Constant VALUE A ViewExpression that refers to the current $$value in a MongoDB reduction expression.
Function _do_apply_memo Undocumented
Function _do_freeze_prefix Undocumented
Function _do_get_group_slices Undocumented
Function _do_recurse Undocumented
Function _do_to_mongo Undocumented
Function _escape_regex_chars Undocumented
def get_group_slices(expr): (source)

Extracts the group slices from the given expression, if any.

Parameters
expra ViewExpression or an already serialized MongoDB expression
Returns
a (possibly-empty) list of group slices
def is_frames_expr(expr): (source)

Determines whether the given expression involves a "frames" field.

Parameters
expra ViewExpression or an already serialized MongoDB expression
Returns
True/False
def to_mongo(expr, prefix=None): (source)

Converts an expression to its MongoDB representation.

Parameters
expra ViewExpression or an already serialized MongoDB expression
prefix:Nonean optional prefix to prepend to all ViewField instances in the expression
Returns
a MongoDB expression

A ViewExpression that refers to the current $$value in a MongoDB reduction expression.

See ViewExpression.reduce for more information.

Value
ViewField('$$value')
def _do_apply_memo(val, old, new): (source)

Undocumented

def _do_freeze_prefix(val, prefix): (source)

Undocumented

def _do_get_group_slices(expr, group_slices): (source)

Undocumented

def _do_recurse(val, fcn): (source)

Undocumented

def _do_to_mongo(val, prefix): (source)

Undocumented

def _escape_regex_chars(str_or_strs): (source)

Undocumented