fiftyone.server.view

module documentation

(source)

FiftyOne Server view.

Class	`ExtendedViewForm`	Undocumented
Function	`extend_view`	Adds the given extended stages to the view.
Function	`get_extended_view`	Create an extended view with the provided filters.
Function	`get_view`	Gets the view defined by the given request parameters.
Function	`handle_group_filter`	Handle a group filter for App view requests.
Async Function	`load_view`	Undocumented
Function	`_add_frame_label_tags`	Undocumented
Function	`_add_frame_labels_tags`	Undocumented
Function	`_add_label_tags`	Undocumented
Function	`_add_labels_tags`	Undocumented
Function	`_add_labels_tags_counts`	Undocumented
Function	`_apply_none`	Undocumented
Function	`_apply_others`	Undocumented
Function	`_count_list_items`	Undocumented
Function	`_is_datetime`	Undocumented
Function	`_is_label_type`	Undocumented
Function	`_is_support`	Undocumented
Function	`_iter_paths`	Undocumented
Function	`_make_field_filter_stages`	Undocumented
Function	`_make_keypoint_list_filter`	Undocumented
Function	`_make_label_filter_stages`	Undocumented
Function	`_make_match_stage`	Undocumented
Function	`_make_query`	Undocumented
Function	`_make_range_query`	Undocumented
Function	`_make_scalar_expression`	Undocumented
Function	`_match_label_tags`	Undocumented
Function	`_project_pagination_paths`	Undocumented
Constant	`_LABEL_TAGS`	Undocumented
Constant	`_NONFINITES`	Undocumented

def extend_view(view, extended_stages): (source) ¶

Adds the given extended stages to the view.

Parameters
view	a `fiftyone.core.collections.SampleCollection`
extended_stages	an extended stages dict
Returns
a `fiftyone.core.view.DatasetView`

def get_extended_view(view, filters=None, extended_stages=None, pagination_data=False, media_types=None): (source) ¶

Create an extended view with the provided filters.

Parameters
view	a `fiftyone.core.collections.SampleCollection`
filters	an optional `dict` of App defined filters
extended_stages:`None`	extended view stages
pagination_data:`False`	filters label data
media_types:`None`	the media types to consider
Returns
a `fiftyone.core.view.DatasetView`

def get_view(dataset, view_name=None, stages=None, filters=None, pagination_data=False, extended_stages=None, sample_filter=None, reload=True, awaitable=False): (source) ¶

Gets the view defined by the given request parameters.

Parameters
dataset	the dataset name or `fiftyone.core.dataset.Dataset` instance
view_name:`None`	the name of a saved view to load
stages:`None`	an optional list of serialized `fiftyone.core.stages.ViewStage` instances
filters:`None`	an optional `dict` of App defined filters
pagination_data:`False`	whether process samples as pagination data - excludes all `fiftyone.core.fields.DictField` values - filters label fields
extended_stages:`None`	extended view stages
sample_filter:`None`	an optional `fiftyone.server.filters.SampleFilter`
reload:`True`	whether to reload the dataset
awaitable:`False`	whether to return an awaitable coroutine
Returns
a `fiftyone.core.view.DatasetView`

def handle_group_filter(dataset: fod.Dataset, view: foc.SampleCollection, filter: GroupElementFilter) -> fov.DatasetView: (source) ¶

Handle a group filter for App view requests.

Parameters
dataset:`fod.Dataset`	the `fiftyone.core.dataset.Dataset`
view:`foc.SampleCollection`	the base `fiftyone.core.collections.SampleCollection`
filter:`GroupElementFilter`	the `fiftyone.server.aggregations.GroupElementFilter`
Returns
`fov.DatasetView`	a `fiftyone.core.view.DatasetView` with a group or slice selection

async def load_view(dataset_name: str, serialized_view: BSONArray, form: ExtendedViewForm, view_name: str | None = None) -> foc.SampleCollection: (source) ¶

Undocumented

def _add_frame_label_tags(path, field, view): (source) ¶

Undocumented

def _add_frame_labels_tags(path, field, view): (source) ¶

Undocumented

def _add_label_tags(path, field, view): (source) ¶

Undocumented

def _add_labels_tags(path, field, view): (source) ¶

Undocumented

def _add_labels_tags_counts(view): (source) ¶

Undocumented

def _apply_none(expr, f, none): (source) ¶

Undocumented

def _apply_others(expr, f, args, is_label): (source) ¶

Undocumented

def _count_list_items(path, view): (source) ¶

Undocumented

def _is_datetime(field): (source) ¶

Undocumented

def _is_label_type(field): (source) ¶

Undocumented

def _is_support(field): (source) ¶

Undocumented

def _iter_paths(view, filters, label_types=None): (source) ¶

Undocumented

def _make_field_filter_stages(view, filters): (source) ¶

Undocumented

def _make_keypoint_list_filter(args, view, path, field): (source) ¶

Undocumented

def _make_label_filter_stages(view, filters): (source) ¶

Undocumented

def _make_match_stage(view, filters): (source) ¶

Undocumented

def _make_query(path: str, field: fof.Field, args): (source) ¶

Undocumented

def _make_range_query(path: str, field: fof.Field, args): (source) ¶

Undocumented

def _make_scalar_expression(f, args, field, list_field=None, is_label=False): (source) ¶

Undocumented

def _match_label_tags(view: foc.SampleCollection, label_tags): (source) ¶

Undocumented

def _project_pagination_paths(view: foc.SampleCollection, media_types: tuple[str] | None = None): (source) ¶

Undocumented

_LABEL_TAGS: str = (source) ¶

Undocumented

Value

'_label_tags'

_NONFINITES = (source) ¶

Undocumented

Value

{'inf': float('inf'), 'nan': float('nan'), 'ninf': float('-inf'), 'none': None}