viewshed::Visibility Class Reference

Class that provides static functions to assist with viewshed calculation. More...

#include <visibility.h>

Static Public Member Functions
static double	distance (const double &x1, const double &y1, const double &x2, const double &y2, const double &cellSize)
	Calculate distance.
static double	gradient (double elevationDiff, double distance)
	Calculate gradient.
static double	curvatureCorrections (const double &distance, const double &refractionCoeff, const double &earthDiameter)
	Calculate elevation change based on distance, atmospheric refraction and earth curvature.
static double	curvatureCorrections (double &distance)
	Calculate elevation change based on distance, atmospheric refraction and earth curvature. This version uses default values of refraction coefficient 0.142860 and earth diameter 12740000.
static CellEventPosition	eventPosition (const CellEventPositionType &eventType, const int &row, const int &col, const int &pointRow, const int &pointCol)
	Obtain cell event postion based on cell event position type, row, column and important point.
static double	angle (const double &row, const double &column, const int &pointRow, const int &pointCol)
	Calculate horizontal angle.

Detailed Description

Class that provides static functions to assist with viewshed calculation.

Member Function Documentation

angle()

double Visibility::angle ( const double & row, const double & column, const int & pointRow, const int & pointCol )

static

Calculate horizontal angle.

Parameters

row
column
pointRow
pointCol

Returns

double

curvatureCorrections() [1/2]

double Visibility::curvatureCorrections ( const double & distance, const double & refractionCoeff, const double & earthDiameter )

static

Calculate elevation change based on distance, atmospheric refraction and earth curvature.

Parameters

distance
refractionCoeff	Refraction coefficient.
earthDiameter	Diameter of Earth to use.

Returns

double

curvatureCorrections() [2/2]

double viewshed::Visibility::curvatureCorrections ( double & distance )

inlinestatic

Calculate elevation change based on distance, atmospheric refraction and earth curvature. This version uses default values of refraction coefficient 0.142860 and earth diameter 12740000.

Parameters

distance

Returns

double

distance()

double Visibility::distance ( const double & x1, const double & y1, const double & x2, const double & y2, const double & cellSize )

static

Calculate distance.

Parameters

x1
y1
x2
y2
cellSize

Returns

double

eventPosition()

CellEventPosition Visibility::eventPosition ( const CellEventPositionType & eventType, const int & row, const int & col, const int & pointRow, const int & pointCol )

static

Obtain cell event postion based on cell event position type, row, column and important point.

Parameters

eventType
row
col
pointRow
pointCol

Returns

CellEventPosition

gradient()

double Visibility::gradient ( double elevationDiff, double distance )

static

Calculate gradient.

Parameters

elevationDiff
distance

Returns

double

---

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

• /home/runner/work/cpp-viewshed-library/cpp-viewshed-library/include/viewshed/visibility.h
• /home/runner/work/cpp-viewshed-library/cpp-viewshed-library/src/library/visibility/visibility.cpp