Added srf_downsampler and associated changes to Python and GP codes to support the SRF downsampler

fabiolsilva · fabiolsilva · commit 8bd6e287abb4 · 2025-03-27T11:26:06.000-07:00
diff --git a/bbp/comps/genslip.py b/bbp/comps/genslip.py
@@ -1,8 +1,8 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 """
 BSD 3-Clause License
 
-Copyright (c) 2021, University of Southern California
+Copyright (c) 2025, University of Southern California
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -57,7 +57,7 @@ class Genslip(object):
 
     def __init__(self, i_r_velmodel, i_r_srcfile,
                  o_r_srffile, i_vmodel_name, sim_id=0,
-                 **kwargs):
+                 output_mrf=False, **kwargs):
         """
         Initialize class variables
         """
@@ -75,6 +75,9 @@ def __init__(self, i_r_velmodel, i_r_srcfile,
         self.slip_sigma = None
         self.range_fwidth_frac = None
         self.r_srcfiles = []
+        self.output_mrf = output_mrf
+        self.ncoarsestk = None
+        self.ncoarsedip = None
 
         # Get all src files that were passed to us
         if kwargs is not None and len(kwargs) > 0:
@@ -260,7 +263,7 @@ def run(self):
         a_fault_seg_in = os.path.join(a_tmpdir, "fault_seg.in")
         a_gsftmp = os.path.join(a_tmpdir, r_gsftmp)
 
-        r_outroot = "m%.2f-%.2fx%.2f_s%d-v5.4.1" % (cfg.CFGDICT[0]["magnitude"],
+        r_outroot = "m%.2f-%.2fx%.2f_s%d-v5.5.2" % (cfg.CFGDICT[0]["magnitude"],
                                                     cfg.CFGDICT[0]["dlen"],
                                                     cfg.CFGDICT[0]["dwid"],
                                                     cfg.CFGDICT[0]["seed"])
@@ -333,6 +336,37 @@ def run(self):
                       "> %s 2>> %s" % (a_srffile, self.log))
         bband_utils.runprog(progstring)
 
+        # Start with default values
+        self.ncoarsestk = int(cfg.NCOARSESTK)
+        self.ncoarsedip = int(cfg.NCOARSEDIP)
+
+        # Check if user wants to use the srf_downsample feature
+        if 'ncoarsestk' in cfg.CFGDICT[0]:
+            self.ncoarsestk = int(cfg.CFGDICT[0]["ncoarsestk"])
+        if 'ncoarsedip' in cfg.CFGDICT[0]:
+            self.ncoarsedip = int(cfg.CFGDICT[0]["ncoarsedip"])
+
+        if self.ncoarsestk != 1 or self.ncoarsedip != 1:
+            # Run downsampler if ncoarsestk/ncoarsedip != 1
+            print("Downsampling the SRF file...")
+            print("ncoarsestk = %d, ncoarsedip = %d" %
+                  (self.ncoarsestk, self.ncoarsedip))
+            srf_downsample_bin = os.path.join(install.A_GP_BIN_DIR,
+                                              "srf_downsample")
+            b_srffile = os.path.join(a_indir, "%s_dsmp%dx%d.srf" %
+                                     (r_outroot, self.ncoarsestk,
+                                      self.ncoarsedip))
+            progstring = ("%s ncoarsestk=%d ncoarsedip=%d < %s > %s 2>> %s\n" %
+	                  (srf_downsample_bin, self.ncoarsestk,
+                           self.ncoarsedip, a_srffile, b_srffile,
+                           self.log))
+            bband_utils.runprog(progstring)
+            # From now on, switch to use our newly created b_srffile,
+            # note that both original srf file from genslip and the
+            # downsampled srf file from the downsampler are saved
+            # in the indata folder
+            a_srffile = b_srffile
+
         #
         # mv result to outputfile
         #
@@ -343,6 +377,25 @@ def run(self):
         progstring = "cp %s %s" % (a_srffile, os.path.join(a_outdir, self.r_srffile))
         bband_utils.runprog(progstring)
 
+        # Generate MRF file if needed
+        if self.output_mrf:
+            src_base = os.path.basename(self.r_srcfile)
+            r_mrf_file = "%s.mrf" % (src_base[0:src_base.rfind('.')])
+            a_mrf_file = os.path.join(a_indir, r_mrf_file)
+            srf2mrf_bin = os.path.join(install.A_GP_BIN_DIR, "srf2mrf")
+            progstring = ("%s velfile=%s < %s > %s 2>> %s\n" %
+                          (srf2mrf_bin, a_velfile,
+                           a_srffile, a_mrf_file, self.log))
+            bband_utils.runprog(progstring)
+
+            # Copy MRF file to outdata and tmpdata
+            progstring = "cp %s %s" % (a_mrf_file,
+                                       os.path.join(a_tmpdir, r_mrf_file))
+            bband_utils.runprog(progstring)
+            progstring = "cp %s %s" % (a_mrf_file,
+                                       os.path.join(a_outdir, r_mrf_file))
+            bband_utils.runprog(progstring)
+
         # Plot SRF
         plot_srf.run(self.r_srffile, sim_id=self.sim_id)
 
diff --git a/bbp/comps/genslip_cfg.py b/bbp/comps/genslip_cfg.py
@@ -1,8 +1,8 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 """
 BSD 3-Clause License
 
-Copyright (c) 2021, University of Southern California
+Copyright (c) 2025, University of Southern California
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -100,6 +100,13 @@ def __init__(self, a_srcfiles):
         self.DEEP_RISETIMEDEP_RANGE = 2.5
         self.DEEP_RISETIME_FAC = 2.0
 
+        # Default parameters for downsampling a SRF file
+        # NCOARSESTK and NCOARSEDIP default value is 1
+        # which disables any downsampling, can be changed
+        # in the SRC file
+        self.NCOARSESTK = 1
+        self.NCOARSEDIP = 1
+
         # Read src files
         self.CFGDICT = []
         self.num_srcfiles = len(a_srcfiles)
diff --git a/bbp/comps/hfsims.py b/bbp/comps/hfsims.py
@@ -2,7 +2,7 @@
 """
 BSD 3-Clause License
 
-Copyright (c) 2023, University of Southern California
+Copyright (c) 2024, University of Southern California
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -53,7 +53,7 @@ class Hfsims(object):
     Implement Robert Graves hfsim.csh as a python component
     """
     def __init__(self, i_r_velmodel, i_r_srcfile, i_r_srffile, i_r_stations,
-                 i_vmodel_name, val_name=None, sim_id=0):
+                 i_vmodel_name, val_name=None, sim_id=0, use_mrf=False):
         self.sim_id = sim_id
         self.r_velmodel = i_r_velmodel
         self.r_srcfile = i_r_srcfile
@@ -80,6 +80,11 @@ def __init__(self, i_r_velmodel, i_r_srcfile, i_r_srffile, i_r_stations,
         self.deep_rvfac = None
         self.rvsig = None
         self.c_zero = None
+        self.use_mrf = use_mrf
+
+        # Switch to MRF file if requested
+        if self.use_mrf:
+            self.r_srffile = "%s.mrf" % (os.path.splitext(self.r_srffile)[0])
 
     def run(self):
         """
diff --git a/bbp/comps/jbsim.py b/bbp/comps/jbsim.py
@@ -52,13 +52,18 @@ class Jbsim(object):
     """
 
     def __init__(self, i_r_velmodel, i_r_srcfile, i_r_srffile,
-                 i_r_stations, i_vmodel_name, sim_id=0):
+                 i_r_stations, i_vmodel_name, sim_id=0, use_mrf=False):
         self.sim_id = sim_id
         self.r_velmodel = i_r_velmodel
         self.r_srcfile = i_r_srcfile
         self.r_srffile = i_r_srffile
         self.r_stations = i_r_stations
         self.vmodel_name = i_vmodel_name
+        self.use_mrf = use_mrf
+
+        # Switch to MRF file if requested
+        if self.use_mrf:
+            self.r_srffile = "%s.mrf" % (os.path.splitext(self.r_srffile)[0])
 
     def run(self):
         """
diff --git a/bbp/src/gp/StandRupFormat/.gitignore b/bbp/src/gp/StandRupFormat/.gitignore
@@ -4,4 +4,5 @@ generic_slip2srf
 srf2moment
 srf2stoch
 srf2xyz
-srf2mrf
+srf2mrf
+srf_downsample
diff --git a/bbp/src/gp/StandRupFormat/function.h b/bbp/src/gp/StandRupFormat/function.h
@@ -66,4 +66,8 @@ void gcproj(float *,float *,float *,float *,float *,double *,double *,double *,d
 void gen_matrices(double *,double *,float *,float *,float *);
 void dump_sliprate(char *,struct standrupformat *,int,float *,float *,float *);
 
-void srf_to_mrf(struct standrupformat *,struct standrupformat *,struct velmodel *,int,int,int,char **);
+void srf_to_mrf1(struct standrupformat *,struct standrupformat *,struct velmodel *,int,int,int,char **);
+void srf_to_mrf6_dsampXXX(struct standrupformat *,struct standrupformat *,struct velmodel *,int,int,int,int,int,char **);
+void srf_to_mrf6_dsamp(struct standrupformat *,struct standrupformat *,struct velmodel *,int,int,int,int,int,int,int,char **);
+
+void srf_dwnsamp(struct standrupformat *,struct standrupformat *,int,int,int,int,int,int,char **);
diff --git a/bbp/src/gp/StandRupFormat/makefile b/bbp/src/gp/StandRupFormat/makefile
@@ -36,7 +36,7 @@ FFLAGS = ${UFLAGS} -ffixed-line-length-132
 
 ##### make options
 
-all: srf2stoch generic_slip2srf fault_seg2gsf srf2moment srf2xyz srf2mrf
+all: srf2stoch generic_slip2srf fault_seg2gsf srf2moment srf2xyz srf2mrf srf_downsample
 
 test_header : test_header.c ${OBJS} ${GEOPROJ_OBJS}
 	$(CC) $(CFLAGS) -o test_header test_header.c ${LDLIBS} ${GEOPROJ_OBJS}
@@ -70,7 +70,11 @@ srf2mrf : srf2mrf.c ${OBJS} ${GEOPROJ_OBJS}
 	${CC} -o srf2mrf srf2mrf.c ${LDLIBS} ${INCPAR} ${GEOPROJ_OBJS}
 	cp srf2mrf ../bin/
 
+srf_downsample : srf_downsample.c ${OBJS} ${GEOPROJ_OBJS}
+	${CC} -o srf_downsample srf_downsample.c ${LDLIBS} ${INCPAR} ${GEOPROJ_OBJS}
+	cp srf_downsample ../bin/
+
 ${OBJS} : ${HEADS}
 
 clean :
-	rm -f *.o ${GENRAND_OBJS} ${BAILEY_OBJS} ${GEOPROJ_OBJS} *.o srf2xyz fault_seg2gsf srf2moment generic_slip2srf srf2stoch test_header srf2mrf
+	rm -f *.o ${GENRAND_OBJS} ${BAILEY_OBJS} ${GEOPROJ_OBJS} *.o srf2xyz fault_seg2gsf srf2moment generic_slip2srf srf2stoch test_header srf2mrf srf_downsample
diff --git a/bbp/src/gp/StandRupFormat/srf2mrf.c b/bbp/src/gp/StandRupFormat/srf2mrf.c
@@ -11,6 +11,15 @@ struct standrupformat srf, mrf;
 char velfile[1024];
 struct velmodel vmod;
 
+struct srf_apointvalues *apval_in, *apval_out;
+int ip, ig;
+size_t msize;
+
+int ncoarsestk = 1;
+int ncoarsedip = 1;
+int stk_off = 0;
+int dip_off = 0;
+
 int inbin = 0;
 int outbin = 0;
 
@@ -21,18 +30,44 @@ sprintf(infile,"stdin");
 sprintf(outfile,"stdout");
 sprintf(velfile,"NOT_PROVIDED");
 
+sprintf(mrf.src_format,"MOMENT");
+
 setpar(ac,av);
 getpar("infile","s",infile);
 getpar("outfile","s",outfile);
 getpar("velfile","s",velfile);
+getpar("mrf_format","s",mrf.src_format); /* valid options: "MOMENT", ("MOMENT-1MECH"), "MOMENT-6MECH" */
+
+getpar("ncoarsestk","d",&ncoarsestk);
+getpar("ncoarsedip","d",&ncoarsedip);
+
+stk_off = (int)(0.5*(ncoarsestk-1.0) + 0.5);
+dip_off = (int)(0.5*(ncoarsedip-1.0) + 0.5);
+
+getpar("stk_off","d",&stk_off);
+getpar("dip_off","d",&dip_off);
+
 getpar("use_srf_lame","d",&use_srf_lame);
 getpar("print_command","d",&print_command);
 endpar();
 
 read_Fvelmodel(velfile,&vmod);
 read_srf(&srf,infile,inbin);
 
-srf_to_mrf(&srf,&mrf,&vmod,use_srf_lame,print_command,ac,av);
+fprintf(stderr,"np= %d\n",srf.srf_apnts.np);
+apval_in = srf.srf_apnts.apntvals;
+msize = srf.srf_apnts.np*sizeof(struct srf_apointvalues);
+for(ip=0;ip<srf.srf_apnts.np;ip++)
+   msize = msize + (apval_in[ip].nt1 + apval_in[ip].nt2 + apval_in[ip].nt3)*sizeof(float);
+
+msize = msize + (int)((6.0*msize)/(1.0*ncoarsestk*ncoarsedip));
+
+fprintf(stderr,"memory esimate (Gb)= %.4f\n",1.0e-09*msize);
+
+if(ncoarsestk == 1 && ncoarsedip == 1)
+   srf_to_mrf1(&srf,&mrf,&vmod,use_srf_lame,print_command,ac,av);
+else
+   srf_to_mrf6_dsamp(&srf,&mrf,&vmod,ncoarsestk,ncoarsedip,stk_off,dip_off,use_srf_lame,print_command,ac,av);
 
 write_srf(&mrf,outfile,outbin);
 }
diff --git a/bbp/src/gp/StandRupFormat/srf_downsample.c b/bbp/src/gp/StandRupFormat/srf_downsample.c
@@ -0,0 +1,63 @@
+#include "include.h"
+#include "structure.h"
+#include "function.h"
+#include "defs.h"
+#include "getpar.h"
+
+int main(int ac,char **av)
+{
+char infile[1024], outfile[1024];
+struct standrupformat srf_in, srf_out;
+
+struct srf_apointvalues *apval_in;
+int ip;
+size_t msize;
+
+int ncoarsestk = 1;
+int ncoarsedip = 1;
+int stk_off = 0;
+int dip_off = 0;
+
+int inbin = 0;
+int outbin = 0;
+
+int print_command = 1;
+
+sprintf(infile,"stdin");
+sprintf(outfile,"stdout");
+
+sprintf(srf_out.src_format,"SLIP");
+
+setpar(ac,av);
+getpar("infile","s",infile);
+getpar("outfile","s",outfile);
+
+getpar("ncoarsestk","d",&ncoarsestk);
+getpar("ncoarsedip","d",&ncoarsedip);
+
+stk_off = (int)(0.5*(ncoarsestk-1.0) + 0.5);
+dip_off = (int)(0.5*(ncoarsedip-1.0) + 0.5);
+
+getpar("stk_off","d",&stk_off);
+getpar("dip_off","d",&dip_off);
+
+getpar("print_command","d",&print_command);
+endpar();
+
+read_srf(&srf_in,infile,inbin);
+
+fprintf(stderr,"np= %d\n",srf_in.srf_apnts.np);
+
+apval_in = srf_in.srf_apnts.apntvals;
+msize = srf_in.srf_apnts.np*sizeof(struct srf_apointvalues);
+for(ip=0;ip<srf_in.srf_apnts.np;ip++)
+   msize = msize + (apval_in[ip].nt1 + apval_in[ip].nt2 + apval_in[ip].nt3)*sizeof(float);
+
+msize = msize + (int)((1.0*msize)/(1.0*ncoarsestk*ncoarsedip));
+
+fprintf(stderr,"memory esimate (Gb)= %.4f\n",1.0e-09*msize);
+
+srf_dwnsamp(&srf_in,&srf_out,ncoarsestk,ncoarsedip,stk_off,dip_off,print_command,ac,av);
+
+write_srf(&srf_out,outfile,outbin);
+}
diff --git a/bbp/src/gp/StandRupFormat/srf_subs.c b/bbp/src/gp/StandRupFormat/srf_subs.c
diff --git a/bbp/src/gp/StandRupFormat/structure.h b/bbp/src/gp/StandRupFormat/structure.h
