From 94558c1831eed8235d4cfb1ad1f5be2f71a429bf Mon Sep 17 00:00:00 2001
From: Jeremy Fee <jmfee@usgs.gov>
Date: Mon, 16 Nov 2015 09:11:17 -0700
Subject: [PATCH] Update create_empty_trace docstring
---
geomagio/Util.py | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/geomagio/Util.py b/geomagio/Util.py
index eb20b98c..ee2cff6a 100644
--- a/geomagio/Util.py
+++ b/geomagio/Util.py
@@ -1,5 +1,5 @@
import urllib2
-from numpy import full, nan
+import numpy
from obspy.core import Stats, Trace
@@ -54,19 +54,22 @@ def read_url(url):
def create_empty_trace(trace, channel):
"""
- Utility to create a trace containing the given numpy array.
+ Utility to create an empty trace, similar to another trace.
Parameters
----------
- stream: obspy.core.stream
+ trace: obspy.core.Trace
+ Trace that is source of most metadata, including array length.
+ channel: String
+ Channel name for created Trace.
Returns
-------
obspy.core.Trace
- Trace a duplicated empty channel.
+ a Trace object, filled with numpy.nan.
"""
stats = Stats(trace.stats)
stats.channel = channel
count = len(trace.data)
- numpy_data = full((count), nan)
+ numpy_data = numpy.full((count), numpy.nan)
return Trace(numpy_data, stats)
--
GitLab