New option --freq_band for trace plotting commands

Author: claudiodsf

CHANGELOG.md

@@ -20,6 +20,8 @@ to the latest version.
   scale
 - New option `--force` for commands that write files, to overwrite existing
   files without asking
+- New option `--freq_band` for trace plotting commands, to override the
+  frequency band specified in the config file
 - Config option `waveform_data_path` renamed to `sds_data_path`
 - New config option `event_data_path` to specify the path to a local directory
   with waveform files organized per event

requake/config/parse_arguments.py

@@ -183,6 +183,7 @@ def parse_arguments(progname='requake'):
         type=float, default=None,
         help='maximum cross-correlation coefficient (default: %(default)s)'
     )
+    # ---
     # --- traceid
     #     a parent parser for the "traceid" option,
     #     used by several subparsers
@@ -192,10 +193,21 @@ def parse_arguments(progname='requake'):
         help='use this traceid instead of the one set in the config file'
     )
     # ---
+    # --- freq_band
+    #     a parent parser for the "freq_band" option,
+    #     used by several subparsers
+    freq_band = argparse.ArgumentParser(add_help=False)
+    freq_band.add_argument(
+        '-F', '--freq_band', nargs=2, type=float, default=None,
+        metavar=('FREQ_MIN', 'FREQ_MAX'),
+        help='use this frequency band instead of the one set in the '
+             'config file. Specify FREQ_MIN and FREQ_MAX in Hz.'
+    )
+    # ---
     # --- plot_pair
     plot_pair = subparser.add_parser(
         'plot_pair',
-        parents=[traceid],
+        parents=[traceid, freq_band],
         help='plot traces for a given event pair'
     )
     plot_pair.add_argument('evid1')
@@ -308,7 +320,10 @@ def parse_arguments(progname='requake'):
     # --- plot_families
     plotfamilies = subparser.add_parser(
         'plot_families',
-        parents=[longerthan, shorterthan, minevents, family_numbers, traceid],
+        parents=[
+            longerthan, shorterthan, minevents, family_numbers,
+            traceid, freq_band
+        ],
         help='plot traces for one ore more event families'
     )
     plotfamilies.add_argument(

requake/plot/plot_pair.py

@@ -74,7 +74,7 @@ def plot_pair():
     fig.canvas.manager.set_window_title(title)
     title = f'{tr1.stats.evid}-{tr2.stats.evid} CC: {cc_max:.2f}'
     ax[0].set_title(title, loc='left')
-    title = f'{tr1.id} | {config.cc_freq_min:.1f}-{config.cc_freq_max:.1f} Hz'
+    title = f'{tr1.id} | {tr1.stats.freq_min:.1f}-{tr1.stats.freq_max:.1f} Hz'
     ax[0].set_title(title, loc='right')
     stats1 = tr1.stats
     stats2 = tr2.stats

requake/waveforms/waveforms.py

@@ -302,16 +302,39 @@ def get_event_waveform(ev):
     return tr
 
 
-def process_waveforms(st):
-    """Demean and filter a waveform trace or stream."""
-    st = st.copy()
-    st.detrend(type='demean')
-    st.taper(max_percentage=0.05, type='cosine')
-    st.filter(
+def process_waveforms(tr_or_st):
+    """
+    Demean and filter a waveform trace or stream.
+
+    :param tr_or_st: waveform stream or trace
+    :type tr_or_st: obspy.Stream or obspy.Trace
+
+    :return: processed waveform stream or trace
+    :rtype: obspy.Stream or obspy.Trace
+    """
+    tr_or_st = tr_or_st.copy()
+    tr_or_st.detrend(type='demean')
+    tr_or_st.taper(max_percentage=0.05, type='cosine')
+    freq_min = (
+        config.args.freq_band[0] if config.args.freq_band else
+        config.cc_freq_min
+    )
+    freq_max = (
+        config.args.freq_band[1] if config.args.freq_band else
+        config.cc_freq_max
+    )
+    tr_or_st.filter(
         type='bandpass',
-        freqmin=config.cc_freq_min,
-        freqmax=config.cc_freq_max)
-    return st
+        freqmin=freq_min,
+        freqmax=freq_max)
+    if isinstance(tr_or_st, Stream):
+        for tr in tr_or_st:
+            tr.stats.freq_min = freq_min
+            tr.stats.freq_max = freq_max
+    else:
+        tr_or_st.stats.freq_min = freq_min
+        tr_or_st.stats.freq_max = freq_max
+    return tr_or_st
 
 
 skipped_evids = []