summaryrefslogtreecommitdiff
path: root/doc/explan_geoid.c.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/explan_geoid.c.xml')
-rw-r--r--doc/explan_geoid.c.xml45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/explan_geoid.c.xml b/doc/explan_geoid.c.xml
new file mode 100644
index 00000000..071e9579
--- /dev/null
+++ b/doc/explan_geoid.c.xml
@@ -0,0 +1,45 @@
+<sect1 id="geoid.c"><title><filename>geoid.c</filename></title>
+<informaltable frame='all' pgwide='1'>
+<tgroup cols='2'>
+<colspec colname='c1'></colspec>
+<colspec colname='c2'></colspec>
+<spanspec spanname='s1' namest='c1' nameend='c2'></spanspec>
+
+<thead>
+<row>
+ <entry>Functions:-</entry><entry>Provides conversion between the ECEF and WGS84 co-ordinate reference systems.</entry>
+</row>
+</thead>
+
+<tbody>
+<row>
+ <entry><function>static double bilinear(double x1, double y1, double x2, double y2, double x, double y, double z11, double z12, double z21, double z22)</function></entry>
+ <entry><para>This is a piece of mathematical manipulation only used internally in this code, so wrestle with it if you will!</para></entry>
+</row>
+<row>
+ <entry><function>double wgs84_separation(double lat, double lon)</function></entry>
+ <entry><para>This is used by drivers to get the separation of MSL from the WGS84 datum at a pair of Latitude/Longitude co-ordinates. The data is in a pre-defined table.</para></entry>
+</row>
+<row>
+ <entry><function>void ecef_to_wgs84fix(struct gps_data_t *gpsdata, double x, double y, double z, double vx, double vy, double vz)</function></entry>
+ <entry><para>This does exactly what it says! Co-ordinate system conversion from ecef to the wgs84 equivalent.</para></entry>
+</row>
+<row>
+ <entry><function>static double fix_minuz(double d)</function></entry>
+ <entry><para>This forces a value of -0.0 to be the same as 0.0 so that certain trig functions act in a predictable manner.</para></entry>
+</row>
+<row>
+ <entry><function>int main(int argc, char **argv)</function></entry>
+ <entry><para>This is a local test routine which exercises the other code for debugging purposes. It is normally shut off by an <function>#ifdef</function>.</para></entry>
+</row>
+</tbody>
+
+<tfoot>
+<row>
+ <entry spanname='s1' align='left'>Notes based on <function>$Id: geoid.c 4257 2007-01-18 03:56:43Z ckuethe $</function></entry>
+</row>
+</tfoot>
+
+</tgroup>
+</informaltable>
+</sect1>