filterByRadiusGeometry

FilterByRadiusGeometryResponse kinetica.Kinetica.filterByRadiusGeometry ( FilterByRadiusGeometryRequest request_ )

inline

Calculates which geospatial geometry objects from a table intersect 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 view_name is passed in as part of the request.

Parameters

request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

Definition at line 38291 of file KineticaFunctions.cs.

FilterByRadiusGeometryResponse kinetica.Kinetica.filterByRadiusGeometry	(	string	table_name,
		string	view_name,
		string	column_name,
		double	x_center,
		double	y_center,
		double	radius,
		IDictionary< string, string >	options = null )

inline

Calculates which geospatial geometry objects from a table intersect 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 view_name is passed in as part of the request.

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 ”.
column_name	Name of the geospatial geometry column to be filtered.
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_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: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of view_name and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created. The default value is an empty Dictionary.

Returns

Response object containing the result of the operation.

Definition at line 38404 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< FilterByRadiusGeometryResponse > kinetica.Kinetica.FilterByRadiusGeometryAsync	(	FilterByRadiusGeometryRequest	request_,
		System.Threading.CancellationToken	cancellationToken = default )

inline

Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.

circular NAI). (async)

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 view_name is passed in as part of the request.

Parameters

request_	Request object containing the parameters for the operation.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 38315 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< FilterByRadiusGeometryResponse > kinetica.Kinetica.FilterByRadiusGeometryAsync	(	string	table_name,
		string	view_name,
		string	column_name,
		double	x_center,
		double	y_center,
		double	radius,
		IDictionary< string, string >	options = null,
		System.Threading.CancellationToken	cancellationToken = default )

inline

Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.

circular NAI). (async)

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 view_name is passed in as part of the request.

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 ”.
column_name	Name of the geospatial geometry column to be filtered.
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_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: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of view_name and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created. The default value is an empty Dictionary.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 38503 of file KineticaFunctions.cs.

API

◆ filterByRadiusGeometry() [1/2]

◆ filterByRadiusGeometry() [2/2]

◆ FilterByRadiusGeometryAsync() [1/2]

◆ FilterByRadiusGeometryAsync() [2/2]

​◆ filterByRadiusGeometry() [1/2]

​◆ filterByRadiusGeometry() [2/2]

​◆ FilterByRadiusGeometryAsync() [1/2]

​◆ FilterByRadiusGeometryAsync() [2/2]

◆ filterByRadiusGeometry() [1/2]

◆ filterByRadiusGeometry() [2/2]

◆ FilterByRadiusGeometryAsync() [1/2]

◆ FilterByRadiusGeometryAsync() [2/2]