fiftyone.core.frame.FrameView

class documentation

class FrameView(DocumentView): (source)

Constructor: FrameView(doc, view, selected_fields, excluded_fields, filtered_fields)

A view into a Frame in a video dataset.

Like Frame instances, the fields of a FrameView instance can be modified, new fields can be created, and any changes can be saved to the database.

FrameView instances differ from Frame instances in the following ways:

A frame view may contain only a subset of the fields of its source frame, either by selecting and/or excluding specific fields
A frame view may contain array fields or embedded array fields that have been filtered, thus containing only a subset of the array elements from the source frame
Excluded fields of a frame view may not be accessed or modified

Note

FrameView.save will not delete any excluded fields or filtered array elements from the source frame.

Frame views should never be created manually; they are generated when accessing the frames in a fiftyone.core.view.DatasetView.

Parameters
doc	a `fiftyone.core.odm.frame.DatasetFrameDocument`
view	the `fiftyone.core.view.DatasetView` that the frame belongs to
selected_fields	a set of field names that this frame view is restricted to, if any
excluded_fields	a set of field names that are excluded from this frame view, if any
filtered_fields	a set of field names of list fields that are filtered in this frame view, if any

Property	`dataset_id`	Undocumented
Property	`sample_id`	Undocumented
Property	`_dataset_id`	Undocumented
Property	`_sample_id`	Undocumented

Inherited from DocumentView:

Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`clear_field`	Clears the value of a field of the document.
Method	`copy`	Returns a deep copy of the document that has not been added to the database.
Method	`get_field`	Gets the value of a field of the document.
Method	`has_field`	Determines whether the document has the given field.
Method	`save`	Saves the document view to the database.
Method	`set_field`	Sets the value of a field of the document.
Method	`to_dict`	Serializes the document to a JSON dictionary.
Method	`to_mongo_dict`	Serializes the document to a BSON dictionary equivalent to the representation that would be stored in the database.
Property	`excluded_field_names`	The set of field names that are excluded on this document view, or `None` if no fields are explicitly excluded.
Property	`field_names`	An ordered tuple of field names of this document view.
Property	`filtered_field_names`	The set of field names or `embedded.field.names` that have been filtered on this document view, or `None` if no fields are filtered.
Property	`selected_field_names`	The set of field names that are selected on this document view, or `None` if no fields are explicitly selected.
Method	`_get_field_names`	Returns an ordered tuple of field names of this document.
Method	`_reload_parents`	Undocumented
Method	`_save`	Undocumented
Method	`_to_db_fields`	Undocumented
Instance Variable	`_excluded_fields`	Undocumented
Instance Variable	`_filtered_fields`	Undocumented
Instance Variable	`_selected_fields`	Undocumented
Instance Variable	`_view`	Undocumented
Property	`_collection`	The `fiftyone.core.collections.SampleCollection` from which this document was taken, or `None` if it is not in a dataset.

Inherited from _Document (via DocumentView):

Method	`__contains__`	Undocumented
Method	`__copy__`	Undocumented
Method	`__delattr__`	Undocumented
Method	`__delitem__`	Undocumented
Method	`__dir__`	Undocumented
Method	`__eq__`	Undocumented
Method	`__getattr__`	Undocumented
Method	`__getitem__`	Undocumented
Method	`__setattr__`	Undocumented
Method	`__setitem__`	Undocumented
Method	`__str__`	Undocumented
Method	`iter_fields`	Returns an iterator over the `(name, value)` pairs of the public fields of the document.
Method	`merge`	Merges the fields of the document into this document.
Method	`to_json`	Serializes the document to a JSON string.
Method	`update_fields`	Sets the dictionary of fields on the document.
Property	`dataset`	The dataset to which this document belongs, or `None` if it has not been added to a dataset.
Property	`in_dataset`	Whether the document has been added to a dataset.
Method	`_iter_label_fields`	Undocumented
Method	`_parse_fields`	Undocumented
Instance Variable	`_dataset`	Undocumented
Instance Variable	`_doc`	Undocumented
Property	`_id`	The ObjectId of the document, or `None` if it has not been added to the database.
Property	`_in_db`	Whether the document has been inserted into the database.

@property
dataset_id = (source) ¶

Undocumented

@property
sample_id = (source) ¶

Undocumented

@property
_dataset_id = (source) ¶

Undocumented

@property
_sample_id = (source) ¶

Undocumented