filter\_by\_radius

filter\_by\_radius(
table\_name: string,
view\_name: string | undefined,
x\_column\_name: string,
x\_center: number,
y\_column\_name: string,
y\_center: number,
radius: number,
options?: Record\<string, string>,
callback?: GPUdbCallback,
): Promise\<FilterByRadiusResponse>
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 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.
Parameters
- table\_name: string
  
  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: string | undefined
  
  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.
- x\_column\_name: string
  
  Name of the column to be used for the x-coordinate (the longitude) of the center.
- x\_center: number
  
  Value of the longitude of the center. Must be within \[-180.0, 180.0].
- y\_column\_name: string
  
  Name of the column to be used for the y-coordinate-the latitude-of the center.
- y\_center: number
  
  Value of the latitude of the center. Must be within \[-90.0, 90.0].
- radius: number
  
  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.
- Optionaloptions: Record\<string, string>
  
  Optional parameters.
- Optionalcallback: GPUdbCallback
  
  Optional callback function
Returns Promise\<FilterByRadiusResponse>

Promise\ - Promise resolving to the response
- Defined in src/GPUdb.ts:9426

filter\_by\_radius\_request

filter\_by\_radius\_request(
request: FilterByRadiusRequest,
callback?: GPUdbCallback,
): Promise\<FilterByRadiusResponse>
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 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.
Parameters
- request: FilterByRadiusRequest
  
  Request object containing the parameters for the operation
- Optionalcallback: GPUdbCallback
  
  Optional callback function
Returns Promise\<FilterByRadiusResponse>

Promise\ - Promise resolving to the response
- Defined in src/GPUdb.ts:9381

filter\_by\_radius

Parameters

Returns Promise\<FilterByRadiusResponse>

filter\_by\_radius\_request

Parameters

Returns Promise\<FilterByRadiusResponse>