fiftyone.core.stages.GeoWithin

class documentation

class GeoWithin(_GeoStage): (source)

Constructor: GeoWithin(boundary, location_field, strict, create_index)

Filters the samples in a collection to only match samples whose geolocation is within a specified boundary.

Examples:

import fiftyone as fo
import fiftyone.zoo as foz

MANHATTAN = [
    [
        [-73.949701, 40.834487],
        [-73.896611, 40.815076],
        [-73.998083, 40.696534],
        [-74.031751, 40.715273],
        [-73.949701, 40.834487],
    ]
]

dataset = foz.load_zoo_dataset("quickstart-geo")

#
# Create a view that only contains samples in Manhattan
#

stage = fo.GeoWithin(MANHATTAN)
view = dataset.add_stage(stage)

Parameters
boundary	a `fiftyone.core.labels.GeoLocation`, `fiftyone.core.labels.GeoLocations`, GeoJSON dict, or list of coordinates that define a `Polygon` or `MultiPolygon` to search within
location_field	the location data of each sample to use. Can be any of the following: The name of a `fiftyone.core.fields.GeoLocation` field whose `point` attribute to use as location data An `embedded.field.name` that directly contains the GeoJSON location data to use `None`, in which case there must be a single `fiftyone.core.fields.GeoLocation` field on the samples, which is used by default
strict	whether a sample's location data must strictly fall within boundary (True) in order to match, or whether any intersection suffices (False)
create_index	whether to create the required spherical index, if necessary

Method	`__init__`	Undocumented
Method	`to_mongo`	Returns the MongoDB aggregation pipeline for the stage.
Property	`boundary`	A GeoJSON dict describing the boundary to match within.
Property	`strict`	Whether matches must be strictly contained in the boundary.
Class Method	`_params`	Returns a list of JSON dicts describing the stage's supported parameters.
Method	`_kwargs`	Returns a list of `[name, value]` lists describing the parameters of this stage instance.
Instance Variable	`_boundary`	Undocumented
Instance Variable	`_strict`	Undocumented

Inherited from _GeoStage:

Method	`validate`	Validates that the stage can be applied to the given collection.
Instance Variable	`_create_index`	Undocumented
Instance Variable	`_location_field`	Undocumented
Instance Variable	`_location_key`	Undocumented

Inherited from ViewStage (via _GeoStage):

Method	`__eq__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`get_edited_fields`	Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
Method	`get_excluded_fields`	Returns a list of fields that have been excluded by the stage, if any.
Method	`get_filtered_fields`	Returns a list of names of fields or embedded fields that contain arrays have been filtered by the stage, if any.
Method	`get_group_expr`	Returns the dynamic group expression for the given stage, if any.
Method	`get_group_media_types`	Returns the group media types outputted by this stage, if any, when applied to the given collection, if and only if they are different from the input collection.
Method	`get_media_type`	Returns the media type outputted by this stage when applied to the given collection, if and only if it is different from the input type.
Method	`get_selected_fields`	Returns a list of fields that have been selected by the stage, if any.
Method	`load_view`	Loads the `fiftyone.core.view.DatasetView` containing the output of the stage.
Property	`flattens_groups`	Whether this stage flattens groups into a non-grouped collection.
Property	`has_view`	Whether this stage's output view should be loaded via `load_view` rather than appending stages to an aggregation pipeline via `to_mongo`.
Property	`outputs_dynamic_groups`	Whether this stage outputs or flattens dynamic groups.
Class Method	`_from_dict`	Creates a `ViewStage` instance from a serialized JSON dict representation of it.
Method	`_needs_frames`	Whether the stage requires frame labels of video samples to be attached.
Method	`_needs_group_slices`	Whether the stage requires group slice(s) to be attached.
Method	`_serialize`	Returns a JSON dict representation of the `ViewStage`.
Instance Variable	`_uuid`	Undocumented

def __init__(self, boundary, location_field=None, strict=True, create_index=True): (source) ¶

overrides fiftyone.core.stages._GeoStage.__init__

Undocumented

def to_mongo(self, _, **__): (source) ¶

overrides fiftyone.core.stages.ViewStage.to_mongo

Returns the MongoDB aggregation pipeline for the stage.

Only usable if has_view is False.

Parameters
_	Undocumented
sample_collection	the `fiftyone.core.collections.SampleCollection` to which the stage is being applied
**__	Undocumented
Returns
a MongoDB aggregation pipeline (list of dicts)

@property
boundary = (source) ¶

A GeoJSON dict describing the boundary to match within.

@property
strict = (source) ¶

Whether matches must be strictly contained in the boundary.

@classmethod
def _params(cls): (source) ¶

overrides fiftyone.core.stages.ViewStage._params

Returns a list of JSON dicts describing the stage's supported parameters.

Returns
a list of JSON dicts

def _kwargs(self): (source) ¶

overrides fiftyone.core.stages.ViewStage._kwargs

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

Returns
a list of `[name, value]` lists

_boundary = (source) ¶

Undocumented

_strict = (source) ¶

Undocumented