URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/filter/byseries

Filters objects matching all points of the given track (works only on track type data). It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.

Input Parameter Description

Name Type Description
table_name string Name of the table on which the filter by track operation will be performed. Must be a currently existing table with a track present.
view_name string If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
track_id string The ID of the track which will act as the filtering points. Must be an existing track within the given table.
target_track_ids array of strings Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
options map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
collection_name Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
spatial_radius A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. The value is interpreted in meters. Required parameter. The minimum allowed value is 0.
time_radius A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points. The value is interpreted in seconds. Required parameter. The minimum allowed value is 0.

A string representing the coordinate system to use for the spatial search criteria. Acceptable values are 'euclidean' and 'great_circle'. Optional parameter; default is 'euclidean'. The supported values are:

  • euclidean
  • great_circle

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'filter_by_series_request' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /filter/byseries endpoint:

Name Type Description
count long The number of records passing the series filter.
info map of string to strings Additional information.

Empty string in case of an error.