aboutsummaryrefslogtreecommitdiffstats
path: root/libtellurian_sea_level.3
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2024-10-20 00:01:25 +0200
committerMattias Andrée <m@maandree.se>2024-10-20 00:01:25 +0200
commit6ac74a858b8f9ff122c8494dd4590fe1e5678a24 (patch)
treedeb9423a156ce1b3aad6815da0ce15e0eadfb443 /libtellurian_sea_level.3
parentm doc (diff)
downloadlibtellurian-6ac74a858b8f9ff122c8494dd4590fe1e5678a24.tar.gz
libtellurian-6ac74a858b8f9ff122c8494dd4590fe1e5678a24.tar.bz2
libtellurian-6ac74a858b8f9ff122c8494dd4590fe1e5678a24.tar.xz
Third commit
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to 'libtellurian_sea_level.3')
-rw-r--r--libtellurian_sea_level.359
1 files changed, 59 insertions, 0 deletions
diff --git a/libtellurian_sea_level.3 b/libtellurian_sea_level.3
new file mode 100644
index 0000000..80dc6ea
--- /dev/null
+++ b/libtellurian_sea_level.3
@@ -0,0 +1,59 @@
+.TH LIBTELLURIAN_SEA_LEVEL 3 libtellurian
+.SH NAME
+libtellurian_sea_level \- Calculate a geocentric radius
+
+.SH SYNPOSIS
+.ni
+#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 a 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)