Filter by Geometry

Filter by geometry tool small icon The Filter by Geometry tool filters features by a spatial relationship with another dataset. Features for which the spatial relationship evaluates as true are retained.

Examples

  • A real-time analytic uses the Filter by Geometry tool to retain only the incoming records from a feed where the feature geometry intersects a polygon dataset of port areas.
  • A big data analytic uses the Filter by Geometry tool to retain only features where the feature geometry enters a polygon dataset representing service areas.

Usage notes

  • The tool can compare the spatial relationship of features to point, line, or polygon features.
  • The tool evaluates a user-defined spatial relationship between the target features and a specified join dataset.
  • If a Spatial Relationship of enter or exit is selected, then checking First observation can trigger enter or First observation can trigger exit indicates that the first target feature received satisfies the filter condition if it is inside any join feature in the case of enter or outside all join features in the case of exit, despite having no prior target feature to which to compare the current target feature's location. The default is false (unchecked).
  • If the Spatial Relationship parameter is set to enter or exit in a real-time analytic, the tool will operate in a stateful manner which enables it to compare sequential observations to one another to detect a change in state, for example, is a current condition different from that of the previous observation. With other spatial relationships in real-time analytics, the tool does not need to compare any observations with previous ones so it can run in a stateless manner which is less resource intensive.
  • The Time Window parameter in a real-time analytic should be set to at least as long as the longest anticipated interval between observations for any given track. Observations older than this duration will be purged from memory in order to manage resources.

Parameters

ParameterDescriptionData Type

Input Layer

Specifies the layer which will be filtered.

Features

Join Layer

Specifies the layer to process a spatial relationship against.

Features

Spatial Relationship

Specifies the criteria used to spatially filter the target features. Spatial relationships include:

  • disjoint
  • enter
  • equals
  • exit
  • intersects
  • near geodesic
  • near planar
  • touches
  • within

String

Time Window

When operating in a stateful manner, this parameter specifies the longest anticipated period of time between observations for each track.

String

Output layer

The Filter by Geometry tool does not alter incoming features, so the output layer will contain the same fields and attribute values as the incoming features.