From eec2ab7c38f1dbe41345fb6ddccc76e50758b5d7 Mon Sep 17 00:00:00 2001
From: Hal Simpson <hasimpson@usgs.gov>
Date: Wed, 1 Jul 2015 00:14:54 -0600
Subject: [PATCH] added comments, refactored is_new_data to use
gap_is_new_data, and created gap_is_new_data
---
geomagio/TimeseriesUtilities.py | 91 +++++++++++++++++++++++++++++++++
1 file changed, 91 insertions(+)
diff --git a/geomagio/TimeseriesUtilities.py b/geomagio/TimeseriesUtilities.py
index 60efb0d0..744e5e71 100644
--- a/geomagio/TimeseriesUtilities.py
+++ b/geomagio/TimeseriesUtilities.py
@@ -4,6 +4,27 @@ import obspy
import numpy
def get_timeseries_gaps(timeseries, channels, starttime, endtime):
+ """Get gaps in a given timeseries
+ Parameters
+ ----------
+ timeseries: obspy.core.stream
+ the stream to check for gaps in
+ channels: array_like
+ list of channels to look for gaps in
+ starttime: obspy.core.UTCDateTime
+ time of first sample.
+ endtime: obspy.core.UTCDateTime
+ time of last sample.
+
+ Returns
+ -------
+ dictionary of channel gaps arrays
+
+ Notes
+ -----
+ Returns a dictionary with channel: gaps array pairs. Where the gaps array
+ consists of arrays of starttime/endtime pairs representing each gap.
+ """
gaps = {}
for channel in channels:
stream_gap = get_stream_gaps(
@@ -14,6 +35,20 @@ def get_timeseries_gaps(timeseries, channels, starttime, endtime):
def get_stream_gaps(stream, starttime, endtime):
+ """Gets gaps in a stream representing a single channel
+ Parameters
+ ----------
+ stream: obspy.core.stream
+ a stream containing a single channel of data.
+ starttime: obspy.core.UTCDateTime
+ time of first sample.
+ endtime: obspy.core.UTCDateTime
+ time of last sample.
+
+ Returns
+ -------
+ array of gaps
+ """
gaps = []
gap = None
@@ -34,6 +69,24 @@ def get_stream_gaps(stream, starttime, endtime):
return gaps
def get_merged_gaps(gaps, channels):
+ """Get gaps merged across channels/streams
+ Parameters
+ ----------
+ gaps: dictionary
+ contains channel/gap array pairs
+ channels: array_like
+ array of channels to look for gaps in
+
+ Returns
+ -------
+ array_like
+ an array of startime/endtime arrays representing gaps.
+
+ Notes
+ -----
+ Takes an dictionary of gaps, and merges those gaps across channels,
+ returning an array of the merged gaps.
+ """
all_gaps = []
gap_stream = []
for channel in channels:
@@ -59,6 +112,18 @@ def get_merged_gaps(gaps, channels):
return merged_gaps
def is_new_data(input_gaps, output_gaps):
+ """Is new data available in gaps
+ Parameters
+ ----------
+ input_gaps: array_like
+ an array of startime/endtime gap pairs holding the input gaps
+ output_gaps: array_like
+ an array of starttime/endtime gap pairs holding the ouput gaps
+
+ Returns
+ boolean
+ True if there's new data available, False otherwise
+ """
for output_gap in output_gaps:
for input_gap in input_gaps:
if (output_gap[0] >= input_gap[0] and
@@ -67,7 +132,33 @@ def is_new_data(input_gaps, output_gaps):
return False
return True
+def gap_is_new_data(input_gaps, output_gap):
+ """Is new data available for a single gap
+ Parameters
+ ----------
+ input_gaps: array_like
+ an array of startime/endtime gap pairs holding the input gaps
+ output_gaps: array_like
+ starttime/endtime pair representing a single gap
+
+ Returns
+ boolean
+ True if there's new data available for the gap, False otherwise
+ """
+ for input_gap in input_gaps:
+ if (output_gap[0] >= input_gap[0] and
+ output_gap[0] <= input_gap[1] and
+ output_gap[1] <= input_gap[1]):
+ return False
+ return True
+
def get_seconds_of_interval(interval):
+ """Gets number of seconds for a given interval string
+ Parameters
+ ----------
+ interval: string
+ The string representing an interval size
+ """
if interval == 'second':
return 1
if interval == 'minute':
--
GitLab