From e7f9f8efcfd9a4a68f4cd34129914b0764ee426b Mon Sep 17 00:00:00 2001
From: "E. Joshua Rigler" <erigler@usgs.gov>
Date: Tue, 22 Nov 2022 11:05:21 -0700
Subject: [PATCH] Now process inchannels, not outchannels
The original version of AverageAlgorithm.py seemed to be written
to process the Controller's `--outchannels`. It "worked" for several
years because `--outchannels` defaulted to `--inchannels`. But what
we actually always wanted was to process `--inchannels`.
Mostly this was just a matter of semantics, but when I recently added
the ability to average fewer than the full complement of inputs, it
was also necessary to change the `can_produce_data()` method to check
for "any" instead of "all" channels, which in turn required that the
AverageAlgorithm class properly instantiate its `_inchannels` and
`_outchannels` class variables, instead of just set them to `None`.
To briefly explain the different changes in this commit:
- added `Algorithm.__init__(self, inchannels=[channel])` to ensure that
can_produce_data() would work when run via programmatic interface.
- added `Algorithm.configure(self, arguments)` to AverageAlgorithm.configure()
to ensure that can_produce_data() would work when run via Controller.py.
- changed all variations of `outchannel` to `inchannel`
- cleaned up where class variables were modified inside process() method
---
geomagio/algorithm/AverageAlgorithm.py | 29 +++++++++++++-------------
1 file changed, 15 insertions(+), 14 deletions(-)
diff --git a/geomagio/algorithm/AverageAlgorithm.py b/geomagio/algorithm/AverageAlgorithm.py
index fe970d63..065e674a 100644
--- a/geomagio/algorithm/AverageAlgorithm.py
+++ b/geomagio/algorithm/AverageAlgorithm.py
@@ -53,13 +53,13 @@ class AverageAlgorithm(Algorithm):
min_count_start=None,
min_count_end=None,
):
- Algorithm.__init__(self)
+ Algorithm.__init__(self, inchannels=[channel])
self._npts = -1
self._stt = -1
self._stats = None
self.scales = scales
self.observatories = observatories
- self.outchannel = channel
+ self.inchannel = channel
self.outlocation = location
self.min_count = min_count
self.min_count_start = min_count_start
@@ -135,11 +135,11 @@ class AverageAlgorithm(Algorithm):
out_stream:
new stream object containing the averaged values and available observatories.
"""
- self.observatories = self.observatories or [t.stats.station for t in timeseries]
+ observatories = self.observatories or [t.stats.station for t in timeseries]
- self.outchannel = self.outchannel or timeseries[0].stats.channel
+ inchannel = self.inchannel or timeseries[0].stats.channel
- self.outlocation = self.outlocation or timeseries[0].stats.location
+ outlocation = self.outlocation or timeseries[0].stats.location
min_count = self.min_count or len(self.observatories)
min_count_start = self.min_count_start or timeseries[0].stats.starttime
@@ -148,7 +148,7 @@ class AverageAlgorithm(Algorithm):
scale_values = self.scales or ([1] * len(timeseries))
lat_corr = {}
i = 0
- for obs in self.observatories:
+ for obs in observatories:
new_obs = {str(obs): scale_values[i]}
lat_corr.update(new_obs)
i += 1
@@ -159,7 +159,7 @@ class AverageAlgorithm(Algorithm):
# initialize array for data to be appended
combined = []
# loop over stations
- for obsy in self.observatories:
+ for obsy in observatories:
# lookup latitude correction factor, default = 1.0
if obsy in lat_corr:
@@ -194,9 +194,9 @@ class AverageAlgorithm(Algorithm):
# create first output trace metadata
average_stats = obspy.core.Stats()
average_stats.station = "USGS"
- average_stats.channel = self.outchannel
+ average_stats.channel = inchannel
average_stats.network = "NT"
- average_stats.location = self.outlocation
+ average_stats.location = outlocation
average_stats.starttime = timeseries[0].stats.starttime
average_stats.npts = timeseries[0].stats.npts
average_stats.delta = timeseries[0].stats.delta
@@ -260,13 +260,14 @@ class AverageAlgorithm(Algorithm):
arguments: Namespace
parsed command line arguments
"""
+ Algorithm.configure(self, arguments)
- self.observatories = arguments.observatory
- if arguments.outchannels:
- if len(arguments.outchannels) > 1:
- raise AlgorithmException("Only 1 channel can be specified")
- self.outchannel = arguments.outchannels[0]
+ if self._inchannels:
+ if len(self._inchannels) > 1:
+ raise AlgorithmException("Only 1 input channel can be specified")
+ self.inchannel = self._inchannels
+ self.observatories = arguments.observatory
self.scales = arguments.average_observatory_scale
if self.scales:
if len(self.observatories) != len(self.scales):
--
GitLab