From fe3747f0fdd5c0a46f3c83856955115a263b7145 Mon Sep 17 00:00:00 2001 From: Jeremy Fee <jmfee@usgs.gov> Date: Thu, 26 Feb 2015 14:47:54 -0700 Subject: [PATCH] Update algorithms section of XYZ --- docs/XYZ.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/XYZ.md b/docs/XYZ.md index 043e0106b..7600fcf3c 100644 --- a/docs/XYZ.md +++ b/docs/XYZ.md @@ -174,18 +174,17 @@ raw data were known to be bad. > to this where possible. -## Algorithm +## Library Notes -The geomag algorithm references the 3 reference frames as geo for -geographic/cartesian, obs for observatory and mag for magnetic/cylindrical. In -reference to this article +This library references the 3 reference frames as `geo` for +geographic/cartesian, `obs` for observatory and `mag` for magnetic/cylindrical: - `geo` is XYZ - `obs` is heZ - `mag` is HDZ -> Note: in this library all channels are uppercase. -> We use context (ie obs vs. mag), to differentiate between h,e and HD. +> Note: within this library all channels are uppercase. +> We use context (ie obs vs. mag vs geo), to differentiate between h,H; e,E; and d,D. > This mirrors the various data formats, (ie IAGA2002, etc). The underlying library provides calculations for both the basic conversions, -- GitLab