> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.FilterBySeriesRequest > kinetica.FilterBySeriesRequest — Kinetica C# API

A set of parameters for Kinetica.filterBySeries. More...

Inheritance diagram for kinetica.FilterBySeriesRequest:
Collaboration diagram for kinetica.FilterBySeriesRequest:

Classes
struct   Options
  A set of string constants for the parameter FilterBySeriesRequest.options. More...
 

Public Member Functions
  FilterBySeriesRequest ()
  Constructs a FilterBySeriesRequest object with default parameters.
 
  FilterBySeriesRequest (string table\_name, string view\_name, string track\_id, IList\< string > target\_track\_ids, IDictionary\< string, string > options=null)
  Constructs a FilterBySeriesRequest object with the specified parameters.
 
  FilterBySeriesRequest ()
  Constructs a FilterBySeriesRequest object with default parameters.
 
  FilterBySeriesRequest (string table\_name, string view\_name, string track\_id, IList\< string > target\_track\_ids, IDictionary\< string, string > options=null)
  Constructs a FilterBySeriesRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  table\_name \[get, set]
  Name of the table on which the filter by track operation will be performed, in \[schema\_name.
 
string  view\_name = "" \[get, set]
  If provided, then this will be the name of the view containing the results, in \[schema\_name.
 
string  track\_id \[get, set]
  The ID of the track which will act as the filtering points.
 
IList\< string >  target\_track\_ids = new List\() \[get, set]
  Up to one track ID to intersect with the "filter" track.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.filterBySeries.

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.

Definition at line 27 of file FilterBySeries.cs.

Constructor & Destructor Documentation

◆ FilterBySeriesRequest() \[1/4]

kinetica.FilterBySeriesRequest.FilterBySeriesRequest ( )
inline

Constructs a FilterBySeriesRequest object with default parameters.

Definition at line 242 of file FilterBySeries.cs.

◆ FilterBySeriesRequest() \[2/4]

kinetica.FilterBySeriesRequest.FilterBySeriesRequest ( string table\_name,
string view\_name,
string track\_id,
IList\< string > target\_track\_ids,
IDictionary\< string, string > options = null )
inline

Constructs a FilterBySeriesRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the filter by track operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be a currently existing table with a track present.
view\_name If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
track\_id The ID of the track which will act as the filtering points. Must be an existing track within the given table.
target\_track\_ids 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 Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_VIEW\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • 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'.
  • 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:
The default value is an empty Dictionary.

Definition at line 352 of file FilterBySeries.cs.

◆ FilterBySeriesRequest() \[3/4]

kinetica.FilterBySeriesRequest.FilterBySeriesRequest ( )
inline

Constructs a FilterBySeriesRequest object with default parameters.

Definition at line 242 of file FilterBySeries.cs.

◆ FilterBySeriesRequest() \[4/4]

kinetica.FilterBySeriesRequest.FilterBySeriesRequest ( string table\_name,
string view\_name,
string track\_id,
IList\< string > target\_track\_ids,
IDictionary\< string, string > options = null )
inline

Constructs a FilterBySeriesRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the filter by track operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be a currently existing table with a track present.
view\_name If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
track\_id The ID of the track which will act as the filtering points. Must be an existing track within the given table.
target\_track\_ids 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 Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_VIEW\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • 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'.
  • 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:
The default value is an empty Dictionary.

Definition at line 352 of file FilterBySeries.cs.

Property Documentation

◆ options

IDictionary\< string, string > kinetica.FilterBySeriesRequest.options = new Dictionary\()
getset

Optional parameters.

  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of FilterBySeriesRequest.view\_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_VIEW\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of FilterBySeriesRequest.view\_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • 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'.
  • 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:

The default value is an empty Dictionary.

Definition at line 238 of file FilterBySeries.cs.

◆ table\_name

string kinetica.FilterBySeriesRequest.table\_name
getset

Name of the table on which the filter by track operation will be performed, in \[schema\_name.

]table\_name format, using standard name resolution rules.

Must be a currently existing table with a track present.

Definition at line 127 of file FilterBySeries.cs.

◆ target\_track\_ids

IList\< string > kinetica.FilterBySeriesRequest.target\_track\_ids = new List\()
getset

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.

Definition at line 149 of file FilterBySeries.cs.

◆ track\_id

string kinetica.FilterBySeriesRequest.track\_id
getset

The ID of the track which will act as the filtering points.

Must be an existing track within the given table.

Definition at line 143 of file FilterBySeries.cs.

◆ view\_name

string kinetica.FilterBySeriesRequest.view\_name = ""
getset

If provided, then this will be the name of the view containing the results, in \[schema\_name.

]view\_name format, using standard name resolution rules and meeting table naming criteria.

Must not be an already existing table or view. The default value is ''.

Definition at line 137 of file FilterBySeries.cs.

The documentation for this class was generated from the following files: