Skip to content

Added a doc comment for the geoid module #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 30, 2021
Merged

Added a doc comment for the geoid module #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions swiftnav/src/geoid.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
// Copyright (c) 2020-2021 Swift Navigation Inc.
// Contact: Swift Navigation <dev@swiftnav.com>
//
// This source is subject to the license found in the file 'LICENSE' which must
// be be distributed together with this source. All other rights reserved.
//
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
// EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
//! Geoid height calculation
//!
//! GNSS positions have a height which is usually referenced to a ellipsoid,
//! a smooth surface which very roughly approximates the mean sea level. This
//! ellipsoid can deviate by a large amount for the actual local mean sea level
//! due to the variations in the local gravitational field. A geoid model is
//! built to better approximate these variations in mean sea level, and can be
//! used to give a height relative to mean sea level which can be more helpful
//! to an end user.

use crate::coords::LLHRadians;

/// List of potential Geoid models used
Expand Down