fiftyone.core.aggregations.Aggregation

class documentation

class Aggregation(object): (source)

Known subclasses: fiftyone.core.aggregations.Bounds, fiftyone.core.aggregations.Count, fiftyone.core.aggregations.CountValues, fiftyone.core.aggregations.Distinct, fiftyone.core.aggregations.FacetAggregations, fiftyone.core.aggregations.HistogramValues, fiftyone.core.aggregations.ListSchema, fiftyone.core.aggregations.Max, fiftyone.core.aggregations.Mean, fiftyone.core.aggregations.Min, fiftyone.core.aggregations.Quantiles, fiftyone.core.aggregations.Schema, fiftyone.core.aggregations.Std, fiftyone.core.aggregations.Sum, fiftyone.core.aggregations.Values

Constructor: Aggregation(field_or_expr, expr, safe)

View In Hierarchy

Abstract base class for all aggregations.

Aggregation instances represent an aggregation or reduction of a fiftyone.core.collections.SampleCollection instance.

Parameters
field_or_expra field name, embedded.field.name, fiftyone.core.expressions.ViewExpression, or MongoDB expression defining the field or expression to aggregate
expra fiftyone.core.expressions.ViewExpression or MongoDB expression to apply to field_or_expr (which must be a field) before aggregating
safewhether to ignore nan/inf values when dealing with floating point values
Method __eq__ Undocumented
Method __init__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method default_result Returns the default result for this aggregation.
Method parse_result Parses the output of to_mongo.
Method to_mongo Returns the MongoDB aggregation pipeline for this aggregation.
Property expr The expression being computed, if any.
Property field_name The name of the field being computed on, if any.
Property safe Whether nan/inf values will be ignored when dealing with floating point values.
Class Method _from_dict Creates an Aggregation instance from a serialized JSON dict representation of it.
Method _kwargs Returns a list of [name, value] lists describing the parameters of this aggregation instance.
Method _needs_frames Whether the aggregation requires frame labels of video samples to be attached.
Method _needs_group_slices Whether the aggregation requires group slice(s) to be attached.
Method _serialize Returns a JSON dict representation of the Aggregation.
Instance Variable _expr Undocumented
Instance Variable _field_name Undocumented
Instance Variable _safe Undocumented
Instance Variable _uuid Undocumented
Property _has_big_result Whether the aggregation's result is returned across multiple documents.
Property _is_big_batchable Whether the aggregation has big results and its pipeline is defined by a single $project stage and thus can be combined with other such aggregations.
def __eq__(self, other): (source)

Undocumented

def __init__(self, field_or_expr, expr=None, safe=False): (source)
overridden in fiftyone.core.aggregations.Bounds, fiftyone.core.aggregations.Count, fiftyone.core.aggregations.CountValues, fiftyone.core.aggregations.Distinct, fiftyone.core.aggregations.FacetAggregations, fiftyone.core.aggregations.HistogramValues, fiftyone.core.aggregations.ListSchema, fiftyone.core.aggregations.Quantiles, fiftyone.core.aggregations.Schema, fiftyone.core.aggregations.Std, fiftyone.core.aggregations.Values

Undocumented

def __repr__(self): (source)

Undocumented

def __str__(self): (source)

Undocumented

def default_result(self): (source)
overridden in fiftyone.core.aggregations.Bounds, fiftyone.core.aggregations.Count, fiftyone.core.aggregations.CountValues, fiftyone.core.aggregations.Distinct, fiftyone.core.aggregations.FacetAggregations, fiftyone.core.aggregations.HistogramValues, fiftyone.core.aggregations.ListSchema, fiftyone.core.aggregations.Max, fiftyone.core.aggregations.Mean, fiftyone.core.aggregations.Min, fiftyone.core.aggregations.Quantiles, fiftyone.core.aggregations.Schema, fiftyone.core.aggregations.Std, fiftyone.core.aggregations.Sum, fiftyone.core.aggregations.Values

Returns the default result for this aggregation.

Default results are used when aggregations are applied to empty collections.

Returns
the aggregation result
def parse_result(self, d): (source)
overridden in fiftyone.core.aggregations.Bounds, fiftyone.core.aggregations.Count, fiftyone.core.aggregations.CountValues, fiftyone.core.aggregations.Distinct, fiftyone.core.aggregations.FacetAggregations, fiftyone.core.aggregations.HistogramValues, fiftyone.core.aggregations.ListSchema, fiftyone.core.aggregations.Max, fiftyone.core.aggregations.Mean, fiftyone.core.aggregations.Min, fiftyone.core.aggregations.Quantiles, fiftyone.core.aggregations.Schema, fiftyone.core.aggregations.Std, fiftyone.core.aggregations.Sum, fiftyone.core.aggregations.Values

Parses the output of to_mongo.

Parameters
dthe result dict, or, when _is_big_batchable is True, the iterable of result dicts
Returns
the aggregation result
def to_mongo(self, sample_collection, context=None): (source)
overridden in fiftyone.core.aggregations.Bounds, fiftyone.core.aggregations.Count, fiftyone.core.aggregations.CountValues, fiftyone.core.aggregations.Distinct, fiftyone.core.aggregations.FacetAggregations, fiftyone.core.aggregations.HistogramValues, fiftyone.core.aggregations.ListSchema, fiftyone.core.aggregations.Max, fiftyone.core.aggregations.Mean, fiftyone.core.aggregations.Min, fiftyone.core.aggregations.Quantiles, fiftyone.core.aggregations.Schema, fiftyone.core.aggregations.Std, fiftyone.core.aggregations.Sum, fiftyone.core.aggregations.Values

Returns the MongoDB aggregation pipeline for this aggregation.

Parameters
sample_collectionthe fiftyone.core.collections.SampleCollection to which the aggregation is being applied
context:Nonea path context from which to resolve
Returns
a MongoDB aggregation pipeline (list of dicts)
@property
expr = (source)
overridden in fiftyone.core.aggregations.Bounds, fiftyone.core.aggregations.Count, fiftyone.core.aggregations.CountValues, fiftyone.core.aggregations.Distinct, fiftyone.core.aggregations.HistogramValues, fiftyone.core.aggregations.ListSchema, fiftyone.core.aggregations.Max, fiftyone.core.aggregations.Mean, fiftyone.core.aggregations.Min, fiftyone.core.aggregations.Quantiles, fiftyone.core.aggregations.Schema, fiftyone.core.aggregations.Std, fiftyone.core.aggregations.Sum, fiftyone.core.aggregations.Values

The expression being computed, if any.

@property
field_name = (source)

The name of the field being computed on, if any.

@property
safe = (source)
overridden in fiftyone.core.aggregations.Bounds, fiftyone.core.aggregations.Count, fiftyone.core.aggregations.CountValues, fiftyone.core.aggregations.Distinct, fiftyone.core.aggregations.Max, fiftyone.core.aggregations.Mean, fiftyone.core.aggregations.Min, fiftyone.core.aggregations.Quantiles, fiftyone.core.aggregations.Std, fiftyone.core.aggregations.Sum

Whether nan/inf values will be ignored when dealing with floating point values.

@classmethod
def _from_dict(cls, d): (source)

Creates an Aggregation instance from a serialized JSON dict representation of it.

Parameters
da JSON dict
Returns
an Aggregation
def _kwargs(self): (source)
overridden in fiftyone.core.aggregations.Bounds, fiftyone.core.aggregations.Count, fiftyone.core.aggregations.CountValues, fiftyone.core.aggregations.FacetAggregations, fiftyone.core.aggregations.HistogramValues, fiftyone.core.aggregations.ListSchema, fiftyone.core.aggregations.Quantiles, fiftyone.core.aggregations.Schema, fiftyone.core.aggregations.Std, fiftyone.core.aggregations.Values

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

Returns
a list of [name, value] lists
def _needs_frames(self, sample_collection): (source)

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

Parameters
sample_collectionthe fiftyone.core.collections.SampleCollection to which the aggregation is being applied
Returns
True/False
def _needs_group_slices(self, sample_collection): (source)

Whether the aggregation requires group slice(s) to be attached.

Parameters
sample_collectionthe fiftyone.core.collections.SampleCollection to which the aggregation is being applied
Returns
None, or a list of group slices
def _serialize(self, include_uuid=True): (source)
overridden in fiftyone.core.aggregations.FacetAggregations

Returns a JSON dict representation of the Aggregation.

Parameters
include_uuid:Truewhether to include the aggregation's UUID in the JSON representation
Returns
a JSON dict
_expr = (source)

Undocumented

_field_name = (source)

Undocumented

_safe = (source)

Undocumented

_uuid = (source)
overridden in fiftyone.core.aggregations.FacetAggregations

Undocumented

@property
_has_big_result = (source)
overridden in fiftyone.core.aggregations.Values

Whether the aggregation's result is returned across multiple documents.

This property affects the data passed to to_mongo at runtime.

@property
_is_big_batchable = (source)
overridden in fiftyone.core.aggregations.Values

Whether the aggregation has big results and its pipeline is defined by a single $project stage and thus can be combined with other such aggregations.

Aggregation classes for which _is_big_batchable may be True must accept an optional big_field parameter in their to_mongo method that specifies the field name to use in its $project stage.