kinetica.FilterBySeriesRequest.Options Struct Reference

Optional parameters. More...

Public Attributes
const string	COLLECTION_NAME = "collection_name"
	Name of a collection which is to contain the newly created view. More...
const string	SPATIAL_RADIUS = "spatial_radius"
	A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. More...
const string	TIME_RADIUS = "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. More...
const string	SPATIAL_DISTANCE_METRIC = "spatial_distance_metric"
	A string representing the coordinate system to use for the spatial search criteria. More...
const string	EUCLIDEAN = "euclidean"
const string	GREAT_CIRCLE = "great_circle"

Detailed Description

Optional parameters.

• 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.
• 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.
• SPATIAL_DISTANCE_METRIC: 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'. Supported values:
  • EUCLIDEAN
  • GREAT_CIRCLE

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 85 of file FilterBySeries.cs.

Member Data Documentation

const string kinetica.FilterBySeriesRequest.Options.COLLECTION_NAME = "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.

Definition at line 92 of file FilterBySeries.cs.

const string kinetica.FilterBySeriesRequest.Options.EUCLIDEAN = "euclidean"

Definition at line 121 of file FilterBySeries.cs.

const string kinetica.FilterBySeriesRequest.Options.GREAT_CIRCLE = "great_circle"

Definition at line 122 of file FilterBySeries.cs.

const string kinetica.FilterBySeriesRequest.Options.SPATIAL_DISTANCE_METRIC = "spatial_distance_metric"

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'. Supported values:

• EUCLIDEAN
• GREAT_CIRCLE

Definition at line 120 of file FilterBySeries.cs.

const string kinetica.FilterBySeriesRequest.Options.SPATIAL_RADIUS = "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.

Definition at line 98 of file FilterBySeries.cs.

const string kinetica.FilterBySeriesRequest.Options.TIME_RADIUS = "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.

Definition at line 104 of file FilterBySeries.cs.

---

The documentation for this struct was generated from the following file:

• Kinetica/Protocol/FilterBySeries.cs