aboutsummaryrefslogtreecommitdiffstats
path: root/libtellurian_sea_level.3
blob: 94016413dd201a0bfa239572e2cb1cef51cbcb55 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
.TH LIBTELLURIAN_SEA_LEVEL 3 libtellurian
.SH NAME
libtellurian_sea_level \- Calculate a geocentric radius

.SH SYNPOSIS
.nf
#include <libtellurian.h>

double libtellurian_sea_level(double \fIlatitude\fP);

double libtellurian_sea_level_radians(double \fIlatitude\fP);
.fi
.PP
Link with
.I -ltellurian
.IR -lm .

.SH DESCRIPTION
The
.BR libtellurian_sea_level ()
function calculates the distance from the centre of
the Earth the ellipsoid, for any point on the given
.IR latitude ,
which givens the nominal sea level at this position,
which is close to the actual sea level, and is the
reference datum for the altitude (ellipsoidal height)
reported in raw GPS measurements.
.PP
The
.I latitude
shall be specified according to GPS and in degrees.
.PP
The
.BR libtellurian_sea_level_radians ()
function is identical to the
.BR libtellurian_sea_level ()
function except that
.I latitude
shall be specified in radians.

.SH RETURN VALUE
The
.BR libtellurian_sea_level ()
and
.BR libtellurian_sea_level_radians ()
functions return the distance from the centre of
the Earth to the ellipsoid, measured in meters.

.SH ERRORS
None.

.SH NOTES
Some GPS systems, espcially those for hiking, surveying,
and aviation, report orthometric height (height above
sea level), rather than ellipsoidal height to make it
easier for the user to interpret.

.SH SEE ALSO
.BR libtellurian (7)