Kinetica C# API  Version 6.1.0.0
kinetica.FilterBySeriesRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

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.

  • 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:


A set of string constants for the parameter options.

Definition at line 77 of file FilterBySeries.cs.

Member Data Documentation

◆ EUCLIDEAN

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

Definition at line 107 of file FilterBySeries.cs.

◆ GREAT_CIRCLE

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

Definition at line 108 of file FilterBySeries.cs.

◆ SPATIAL_DISTANCE_METRIC

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:

Definition at line 106 of file FilterBySeries.cs.

◆ SPATIAL_RADIUS

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 84 of file FilterBySeries.cs.

◆ TIME_RADIUS

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 90 of file FilterBySeries.cs.


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