From aa218d7cdba033706d2d41a153f7c028d755489b Mon Sep 17 00:00:00 2001
From: Hal Simpson <hasimpson@usgs.gov>
Date: Mon, 12 Jan 2015 20:45:29 -0700
Subject: [PATCH] updated comments
---
geomagio/StreamConverter.py | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/geomagio/StreamConverter.py b/geomagio/StreamConverter.py
index a5175144..7629c00d 100644
--- a/geomagio/StreamConverter.py
+++ b/geomagio/StreamConverter.py
@@ -55,6 +55,18 @@ def get_geo_from_obs(obs):
def get_mag_from_geo(geo):
+ """Convert a stream to magnetic coordinate system.
+
+ Parameters
+ ----------
+ geo: obspy.core.Stream
+ stream containing observatory components X, Y, Z, and F.
+
+ Returns
+ -------
+ obspy.core.Stream
+ new stream object containing magnetic components H, D, Z, and F.
+ """
x = geo.select(channel='X')[0]
y = geo.select(channel='Y')[0]
z = geo.select(channel='Z')[0]
--
GitLab