> ## 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.FilterByRadiusRequest > kinetica.FilterByRadiusRequest — Kinetica C# API

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

Inheritance diagram for kinetica.FilterByRadiusRequest:
Collaboration diagram for kinetica.FilterByRadiusRequest:

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

Public Member Functions
  FilterByRadiusRequest ()
  Constructs a FilterByRadiusRequest object with default parameters.
 
  FilterByRadiusRequest (string table\_name, string view\_name, string x\_column\_name, double x\_center, string y\_column\_name, double y\_center, double radius, IDictionary\< string, string > options=null)
  Constructs a FilterByRadiusRequest object with the specified parameters.
 
  FilterByRadiusRequest ()
  Constructs a FilterByRadiusRequest object with default parameters.
 
  FilterByRadiusRequest (string table\_name, string view\_name, string x\_column\_name, double x\_center, string y\_column\_name, double y\_center, double radius, IDictionary\< string, string > options=null)
  Constructs a FilterByRadiusRequest 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 radius 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  x\_column\_name \[get, set]
  Name of the column to be used for the x-coordinate (the longitude) of the center.
 
double  x\_center \[get, set]
  Value of the longitude of the center.
 
string  y\_column\_name \[get, set]
  Name of the column to be used for the y-coordinate-the latitude-of the center.
 
double  y\_center \[get, set]
  Value of the latitude of the center.
 
double  radius \[get, set]
  The radius of the circle within which the search will be performed.
 
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.filterByRadius.

Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a FilterByRadiusRequest.view\_name is passed in as part of the request.

For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.

Definition at line 25 of file FilterByRadius.cs.

Constructor & Destructor Documentation

◆ FilterByRadiusRequest() \[1/4]

kinetica.FilterByRadiusRequest.FilterByRadiusRequest ( )
inline

Constructs a FilterByRadiusRequest object with default parameters.

Definition at line 168 of file FilterByRadius.cs.

◆ FilterByRadiusRequest() \[2/4]

kinetica.FilterByRadiusRequest.FilterByRadiusRequest ( string table\_name,
string view\_name,
string x\_column\_name,
double x\_center,
string y\_column\_name,
double y\_center,
double radius,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByRadiusRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the filter by radius operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
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 ''.
x\_column\_name Name of the column to be used for the x-coordinate (the longitude) of the center.
x\_center Value of the longitude of the center. Must be within \[-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
y\_column\_name Name of the column to be used for the y-coordinate-the latitude-of the center.
y\_center Value of the latitude of the center. Must be within \[-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
radius The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX\_INT.
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 which is to contain the newly created view. If the schema is non-existent, it will be automatically created.
The default value is an empty Dictionary.

Definition at line 244 of file FilterByRadius.cs.

◆ FilterByRadiusRequest() \[3/4]

kinetica.FilterByRadiusRequest.FilterByRadiusRequest ( )
inline

Constructs a FilterByRadiusRequest object with default parameters.

Definition at line 168 of file FilterByRadius.cs.

◆ FilterByRadiusRequest() \[4/4]

kinetica.FilterByRadiusRequest.FilterByRadiusRequest ( string table\_name,
string view\_name,
string x\_column\_name,
double x\_center,
string y\_column\_name,
double y\_center,
double radius,
IDictionary\< string, string > options = null )
inline

Constructs a FilterByRadiusRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the filter by radius operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.
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 ''.
x\_column\_name Name of the column to be used for the x-coordinate (the longitude) of the center.
x\_center Value of the longitude of the center. Must be within \[-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
y\_column\_name Name of the column to be used for the y-coordinate-the latitude-of the center.
y\_center Value of the latitude of the center. Must be within \[-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
radius The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX\_INT.
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 which is to contain the newly created view. If the schema is non-existent, it will be automatically created.
The default value is an empty Dictionary.

Definition at line 244 of file FilterByRadius.cs.

Property Documentation

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 164 of file FilterByRadius.cs.

◆ radius

double kinetica.FilterByRadiusRequest.radius
getset

The radius of the circle within which the search will be performed.

Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX\_INT.

Definition at line 117 of file FilterByRadius.cs.

◆ table\_name

string kinetica.FilterByRadiusRequest.table\_name
getset

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

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

Must be an existing table.

Definition at line 82 of file FilterByRadius.cs.

◆ view\_name

string kinetica.FilterByRadiusRequest.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 92 of file FilterByRadius.cs.

◆ x\_center

double kinetica.FilterByRadiusRequest.x\_center
getset

Value of the longitude of the center.

Must be within \[-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.

Definition at line 101 of file FilterByRadius.cs.

◆ x\_column\_name

string kinetica.FilterByRadiusRequest.x\_column\_name
getset

Name of the column to be used for the x-coordinate (the longitude) of the center.

Definition at line 96 of file FilterByRadius.cs.

◆ y\_center

double kinetica.FilterByRadiusRequest.y\_center
getset

Value of the latitude of the center.

Must be within \[-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.

Definition at line 110 of file FilterByRadius.cs.

◆ y\_column\_name

string kinetica.FilterByRadiusRequest.y\_column\_name
getset

Name of the column to be used for the y-coordinate-the latitude-of the center.

Definition at line 105 of file FilterByRadius.cs.

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