Exposing a parameter to control gaussian pulse width during iterative deconvolution

Author: geojunky

seismic/receiver_fn/generate_rf_helper.py

@@ -11,8 +11,6 @@
 
 RAW_RESAMPLE_RATE_HZ = 10.0
 BANDPASS_FILTER_ORDER = 2
-ITER_GWIDTH_PRF = 2.5 # gaussian filter width for iterative deconvolution of P RFs
-ITER_GWIDTH_SRF = 3.5 # gaussian filter width for iterative deconvolution of S RFs
 
 def transform_stream_to_rf(ev_id, stream3c, rf_config, **kwargs):
     """Generate P-phase receiver functions for a single 3-channel stream.
@@ -138,7 +136,7 @@ def transform_stream_to_rf(ev_id, stream3c, rf_config, **kwargs):
 
             both_sided = False
             winsrc = 'P'
-            iter_gwidth = ITER_GWIDTH_PRF if rf_type == 'prf' else ITER_GWIDTH_SRF
+            iter_gwidth_factor = config_processing.get('iter_gwidth_factor')
             if(rf_type == 'srf'):
                 both_sided = True
                 winsrc = (trim_start_time_sec, trim_end_time_sec, 5)
@@ -149,7 +147,7 @@ def transform_stream_to_rf(ev_id, stream3c, rf_config, **kwargs):
                         winsrc=winsrc,
                         func=rf_iter_deconv, normalize=normalize, min_fit_threshold=75.0,
                         both_sided=both_sided,
-                        gwidth=iter_gwidth)
+                        gwidth=iter_gwidth_factor)
         else:
             assert False, "Not yet supported deconvolution technique '{}'".format(deconv_domain)
         # end if

seismic/receiver_fn/rf_config.py

@@ -25,7 +25,8 @@
 DEFAULT_TRIM_END_TIME_SEC = 150.0
 DEFAULT_ROTATION_TYPE = 'zrt'   # from ['zrt', 'lqt']
 DEFAULT_DECONV_DOMAIN = 'time'  # from ['time', 'freq', 'iter']
-DEFAULT_GAUSS_WIDTH = 1.0
+DEFAULT_GAUSS_WIDTH = 1.0 # for frequency domain
+DEFAULT_ITER_GWIDTH_FACTOR = 2.5 # gaussian pulse-width factor for iterative deconvolution
 DEFAULT_WATER_LEVEL = 0.01
 DEFAULT_SPIKING = 0.5
 DEFAULT_NORMALIZE = False
@@ -66,6 +67,7 @@ def __init__(self, config_source: Union[str, dict]):
           "gauss_width": float # Gaussian freq domain filter width. Only required for freq-domain deconvolution
           "water_level": float # Water-level for freq domain spectrum. Only required for freq-domain deconvolution
           "spiking": float # Spiking factor (noise suppression), only required for time-domain deconvolution
+          "iter_gwidth_factor": float # Gaussian pulse-width factor, required only for iterative deconvolution
           "normalize": bool # Whether to normalize RF amplitude
         }
 
@@ -103,6 +105,7 @@ def __init__(self, config_source: Union[str, dict]):
                         "gauss_width": DEFAULT_GAUSS_WIDTH,
                         "water_level": DEFAULT_WATER_LEVEL,
                         "spiking": DEFAULT_SPIKING,
+                        "iter_gwidth_factor": DEFAULT_ITER_GWIDTH_FACTOR,
                         "normalize": DEFAULT_NORMALIZE,
                     },
 
@@ -179,7 +182,7 @@ def _validate(self):
         # validate <processing> block
         cp_keys = {'rf_type', 'custom_preproc', 'trim_start_time', 'trim_end_time',
                    'rotation_type', 'deconv_domain', 'gauss_width', 'water_level',
-                   'spiking', 'normalize'}
+                   'spiking', 'iter_gwidth_factor', 'normalize'}
         if(not set(self.config_processing.keys()).issubset(cp_keys)):
             raise ValueError('Invalid key(s) found in <processing> block in the config file. '
                              'Valid keys are: {}'.format(cp_keys))