fiftyone.core.sample.SampleView

class documentation

class SampleView(_SampleMixin, DocumentView): (source)

Known subclasses: fiftyone.core.clips.ClipView, fiftyone.core.video.FrameView, fiftyone.core.patches._PatchView

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

A view into a Sample in a dataset.

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

SampleView instances differ from Sample instances in the following ways:

A sample view may contain only a subset of the fields of its source sample, either by selecting and/or excluding specific fields
A sample 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 sample
Excluded fields of a sample view may not be accessed or modified

Note

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

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

Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`save`	Saves the sample view to the database.
Method	`to_dict`	Serializes the sample view to a JSON dictionary.
Method	`_save`	Undocumented
Instance Variable	`_frames`	Undocumented

Inherited from _SampleMixin:

Method	`__getattr__`	Undocumented
Method	`__getitem__`	Undocumented
Method	`__iter__`	Undocumented
Method	`__setattr__`	Undocumented
Method	`__setitem__`	Undocumented
Method	`add_labels`	Adds the given labels to the sample.
Method	`clear_field`	Undocumented
Method	`compute_metadata`	Populates the `metadata` field of the sample.
Method	`copy`	Returns a deep copy of the sample that has not been added to the database.
Method	`get_field`	Undocumented
Method	`merge`	Merges the fields of the given sample into this sample.
Method	`set_field`	Undocumented
Property	`dataset_id`	Undocumented
Property	`filename`	The basename of the media's filepath.
Property	`media_type`	The media type of the sample.
Method	`_parse_fields_video`	Undocumented
Method	`_secure_media`	Undocumented
Property	`_dataset_id`	Undocumented

Inherited from DocumentView (via _SampleMixin):

Method	`has_field`	Determines whether the document has the given field.
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	`_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 _SampleMixin, DocumentView):

Method	`__contains__`	Undocumented
Method	`__copy__`	Undocumented
Method	`__delattr__`	Undocumented
Method	`__delitem__`	Undocumented
Method	`__dir__`	Undocumented
Method	`__eq__`	Undocumented
Method	`__str__`	Undocumented
Method	`iter_fields`	Returns an iterator over the `(name, value)` pairs of the public fields of the 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.

def __init__(self, doc, view, selected_fields=None, excluded_fields=None, filtered_fields=None): (source) ¶

overrides fiftyone.core.document.DocumentView.__init__

Undocumented

def __repr__(self): (source) ¶

overrides fiftyone.core.document.DocumentView.__repr__

Undocumented

def save(self): (source) ¶

overrides fiftyone.core.document.DocumentView.save

Saves the sample view to the database.

Warning

This will permanently delete any omitted or filtered contents from the source dataset.

def to_dict(self, include_frames=False, include_private=False): (source) ¶

overrides fiftyone.core.sample._SampleMixin.to_dict

Serializes the sample view to a JSON dictionary.

Parameters
include_frames:`False`	whether to include the frame labels for video samples
include_private:`False`	whether to include private fields
Returns
a JSON dict

def _save(self, deferred=False): (source) ¶

overrides fiftyone.core.document.DocumentView._save

overridden in fiftyone.core.clips.ClipView, fiftyone.core.video.FrameView, fiftyone.core.patches._PatchView

Undocumented

_frames = (source) ¶

Undocumented