Skip to content

Commit 7d49308

Browse files
authored
Added a doc comment for the geoid module (#79)
1 parent c16303f commit 7d49308

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

swiftnav/src/geoid.rs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
// Copyright (c) 2020-2021 Swift Navigation Inc.
2+
// Contact: Swift Navigation <dev@swiftnav.com>
3+
//
4+
// This source is subject to the license found in the file 'LICENSE' which must
5+
// be be distributed together with this source. All other rights reserved.
6+
//
7+
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
8+
// EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
9+
// WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
10+
//! Geoid height calculation
11+
//!
12+
//! GNSS positions have a height which is usually referenced to a ellipsoid,
13+
//! a smooth surface which very roughly approximates the mean sea level. This
14+
//! ellipsoid can deviate by a large amount for the actual local mean sea level
15+
//! due to the variations in the local gravitational field. A geoid model is
16+
//! built to better approximate these variations in mean sea level, and can be
17+
//! used to give a height relative to mean sea level which can be more helpful
18+
//! to an end user.
19+
120
use crate::coords::LLHRadians;
221

322
/// List of potential Geoid models used

0 commit comments

Comments
 (0)