#include <gridpp.h>

Classes
struct	is_not_equal

struct	within_radius

Public Member Functions
ivec	get_closest_neighbours (float lat, float lon, int num, bool include_match=true) const
	Find a set of nearest points. More...

CoordinateType	get_coordinate_type () const

vec	get_lats () const

vec	get_lons () const

int	get_nearest_neighbour (float lat, float lon, bool include_match=true) const
	Find single nearest points. More...

ivec	get_neighbours (float lat, float lon, float radius, bool include_match=true) const
	Find all points with a radius. More...

ivec	get_neighbours_with_distance (float lat, float lon, float radius, vec &distances, bool include_match=true) const
	Find all points with a radius. More...

int	get_num_neighbours (float lat, float lon, float radius, bool include_match=true) const
	Find the number of points within a radius. More...

const vec &	get_x () const

const vec &	get_y () const

const vec &	get_z () const

	KDTree (const KDTree &other)

	KDTree (CoordinateType type=Geodetic)

	KDTree (vec lats, vec lons, CoordinateType type=Geodetic)

KDTree &	operator= (KDTree other)

int	size () const

Static Public Member Functions
static float	calc_distance (const Point &p1, const Point &p2)
	Calculate distance between two points using Haversine function. More...

static float	calc_distance (float lat1, float lon1, float lat2, float lon2, CoordinateType type=Geodetic)
	Calculate distance between two coordinates using Haversine function. More...

static float	calc_distance_fast (float lat1, float lon1, float lat2, float lon2, CoordinateType type=Geodetic)
	Calculate an approximate distance between two coordinates. More...

static float	calc_straight_distance (const Point &p1, const Point &p2)
	Calculate straight line distance between two points. More...

static float	calc_straight_distance (float x0, float y0, float z0, float x1, float y1, float z1)
	Calculate straight line distance between two 3D coordinates. More...

static float	deg2rad (float deg)

static float	rad2deg (float deg)

Protected Types
typedef boost::geometry::model::box< point >	box

typedef boost::geometry::model::point< float, 3, boost::geometry::cs::cartesian >	point

typedef std::pair< point, unsigned >	value

Protected Attributes
vec	mLats

vec	mLons

boost::geometry::index::rtree< value, boost::geometry::index::quadratic< 16 > >	mTree

CoordinateType	mType

vec	mX

vec	mY

vec	mZ

Detailed Description

Helper class for Grid and Points representing a tree of points.

Member Typedef Documentation

◆ box

typedef boost::geometry::model::box<point> gridpp::KDTree::box

protected

◆ point

typedef boost::geometry::model::point<float, 3, boost::geometry::cs::cartesian> gridpp::KDTree::point

protected

◆ value

typedef std::pair<point, unsigned> gridpp::KDTree::value

protected

Constructor & Destructor Documentation

◆ KDTree() [1/3]

gridpp::KDTree::KDTree	(	vec	lats,
		vec	lons,
		CoordinateType	type = `Geodetic`
	)

◆ KDTree() [2/3]

gridpp::KDTree::KDTree ( const KDTree & other )

◆ KDTree() [3/3]

gridpp::KDTree::KDTree ( CoordinateType type = Geodetic )

inline

Member Function Documentation

◆ calc_distance() [1/2]

float gridpp::KDTree::calc_distance	(	const Point &	p1,
		const Point &	p2
	)

static

Calculate distance between two points using Haversine function.

Parameters

p1	First point
p2	Second point

Returns: Distance [m]

◆ calc_distance() [2/2]

float gridpp::KDTree::calc_distance	(	float	lat1,
		float	lon1,
		float	lat2,
		float	lon2,
		CoordinateType	type = `Geodetic`
	)

static

Calculate distance between two coordinates using Haversine function.

Parameters

lat1	Latitude [deg] or y-coordinate [m] for first point
lon1	Longitude [deg] or x-coordinate [m] for first point
lat2	Latitude [deg] or y-coordinate [m] for second point
lon2	Longitude [deg] or x-coordinate [m] for second point
type	Coordinate type for both points

Returns: Distance [m]

◆ calc_distance_fast()

float gridpp::KDTree::calc_distance_fast	(	float	lat1,
		float	lon1,
		float	lat2,
		float	lon2,
		CoordinateType	type = `Geodetic`
	)

static

Calculate an approximate distance between two coordinates.

Parameters

lat1	Latitude [deg] or y-coordinate [m] for first point
lon1	Longitude [deg] or x-coordinate [m] for first point
lat2	Latitude [deg] or y-coordinate [m] for second point
lon2	Longitude [deg] or x-coordinate [m] for second point
type	Coordinate type for both points

Returns: Distance [m]

◆ calc_straight_distance() [1/2]

float gridpp::KDTree::calc_straight_distance	(	const Point &	p1,
		const Point &	p2
	)

static

Calculate straight line distance between two points.

This is much faster than calc_distance.

Parameters

p1	First point
p2	Second point

Returns: Distance [m]

◆ calc_straight_distance() [2/2]

float gridpp::KDTree::calc_straight_distance	(	float	x0,
		float	y0,
		float	z0,
		float	x1,
		float	y1,
		float	z1
	)

static

Calculate straight line distance between two 3D coordinates.

This is much faster than calc_distance.

Parameters

x0	x-coordinate of first point [m]
y0	y-coordinate of first point [m]
z0	z-coordinate of first point [m]
x1	x-coordinate of second point [m]
y1	y-coordinate of second point [m]
z1	z-coordinate of second point [m]

Returns: Distance [m]

◆ deg2rad()

float gridpp::KDTree::deg2rad ( float deg )

static

◆ get_closest_neighbours()

ivec gridpp::KDTree::get_closest_neighbours	(	float	lat,
		float	lon,
		int	num,
		bool	include_match = `true`
	)		const

Find a set of nearest points.

Parameters

lat	Latitude of lookup-point
lon	Longitude of lookup-point
num	Number of points to find

◆ get_coordinate_type()

CoordinateType gridpp::KDTree::get_coordinate_type ( ) const

◆ get_lats()

vec gridpp::KDTree::get_lats ( ) const

◆ get_lons()

vec gridpp::KDTree::get_lons ( ) const

◆ get_nearest_neighbour()

int gridpp::KDTree::get_nearest_neighbour	(	float	lat,
		float	lon,
		bool	include_match = `true`
	)		const

Find single nearest points.

Parameters

lat	Latitude of lookup-point
lon	Longitude of lookup-point

◆ get_neighbours()

ivec gridpp::KDTree::get_neighbours	(	float	lat,
		float	lon,
		float	radius,
		bool	include_match = `true`
	)		const

Find all points with a radius.

Parameters

lat	Latitude of lookup-point
lon	Longitude of lookup-point
radius	Lookup radius [m]

◆ get_neighbours_with_distance()

ivec gridpp::KDTree::get_neighbours_with_distance	(	float	lat,
		float	lon,
		float	radius,
		vec &	distances,
		bool	include_match = `true`
	)		const

Find all points with a radius.

Parameters

lat	Latitude of lookup-point
lon	Longitude of lookup-point
radius	Lookup radius [m]
distances	Vector to store separation distances [m]

◆ get_num_neighbours()

int gridpp::KDTree::get_num_neighbours	(	float	lat,
		float	lon,
		float	radius,
		bool	include_match = `true`
	)		const

Find the number of points within a radius.

Parameters

lat	Latitude of lookup-point
lon	Longitude of lookup-point
radius	Lookup radius [m]

◆ get_x()

const vec & gridpp::KDTree::get_x ( ) const

◆ get_y()

const vec & gridpp::KDTree::get_y ( ) const

◆ get_z()

const vec & gridpp::KDTree::get_z ( ) const

◆ operator=()

gridpp::KDTree & gridpp::KDTree::operator= ( gridpp::KDTree other )

◆ rad2deg()

float gridpp::KDTree::rad2deg ( float deg )

static

◆ size()

int gridpp::KDTree::size ( ) const

Member Data Documentation

◆ mLats

vec gridpp::KDTree::mLats

protected

◆ mLons

vec gridpp::KDTree::mLons

protected

◆ mTree

boost::geometry::index::rtree< value, boost::geometry::index::quadratic<16> > gridpp::KDTree::mTree

protected

◆ mType

CoordinateType gridpp::KDTree::mType

protected

◆ mX

vec gridpp::KDTree::mX

protected

◆ mY

vec gridpp::KDTree::mY

protected

◆ mZ

vec gridpp::KDTree::mZ

protected

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

/home/thomasn/repos/gridpp/include/gridpp.h
/home/thomasn/repos/gridpp/src/api/kdtree.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ box

◆ point

◆ value

Constructor & Destructor Documentation

◆ KDTree() [1/3]

◆ KDTree() [2/3]

◆ KDTree() [3/3]

Member Function Documentation

◆ calc_distance() [1/2]

◆ calc_distance() [2/2]

◆ calc_distance_fast()

◆ calc_straight_distance() [1/2]

◆ calc_straight_distance() [2/2]

◆ deg2rad()

◆ get_closest_neighbours()

◆ get_coordinate_type()

◆ get_lats()

◆ get_lons()

◆ get_nearest_neighbour()

◆ get_neighbours()

◆ get_neighbours_with_distance()

◆ get_num_neighbours()

◆ get_x()

◆ get_y()

◆ get_z()

◆ operator=()

◆ rad2deg()

◆ size()

Member Data Documentation

◆ mLats

◆ mLons

◆ mTree

◆ mType

◆ mX

◆ mY

◆ mZ