stf.c 12.3 KB
Newer Older
tilman.metz's avatar
tilman.metz committed
1
/*-----------------------------------------------------------------------------------------
2
 * Copyright (C) 2016  For the list of authors, see file AUTHORS.
tilman.metz's avatar
tilman.metz committed
3
 *
Florian Wittkamp's avatar
Florian Wittkamp committed
4
 * This file is part of IFOS.
tilman.metz's avatar
tilman.metz committed
5
 * 
Florian Wittkamp's avatar
Florian Wittkamp committed
6
 * IFOS is free software: you can redistribute it and/or modify
tilman.metz's avatar
tilman.metz committed
7 8 9
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, version 2.0 of the License only.
 * 
Florian Wittkamp's avatar
Florian Wittkamp committed
10
 * IFOS is distributed in the hope that it will be useful,
tilman.metz's avatar
tilman.metz committed
11 12 13 14 15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
Florian Wittkamp's avatar
Florian Wittkamp committed
16
 * along with IFOS. See file COPYING and/or <http://www.gnu.org/licenses/gpl-2.0.html>.
tilman.metz's avatar
tilman.metz committed
17 18 19 20 21 22 23 24 25 26
-----------------------------------------------------------------------------------------*/

/*------------------------------------------------------------------------
 *   inversion for source time function 
 *  ----------------------------------------------------------------------*/

#include "fd.h"
#include "stfinv/stfinv.h"
#include "segy.h"

27
void stf(FILE *fp, float **sectionvy, float ** sectionvy_obs, float ** sectionvy_conv, float * source_time_function, int  **recpos, int  **recpos_loc, int ntr_glob,int ntr, float ** srcpos, int ishot, int ns, int iter, int nshots, float FC, int SH,int nsrc_glob){
tilman.metz's avatar
tilman.metz committed
28 29 30

	/* declaration of global variables */
	extern float DT, DH;
31
	extern int SEIS_FORMAT, MYID, NT, SOURCE_SHAPE, TIME_FILT, TIMEWIN, TAPER_STF, ORDER;
32
	extern char  PARA[STRING_SIZE], DATA_DIR[STRING_SIZE];
33
	extern int TRKILL_STF, NORMALIZE, USE_WORKFLOW, WORKFLOW_STAGE;
tilman.metz's avatar
tilman.metz committed
34 35
	extern char TRKILL_FILE_STF[STRING_SIZE];
	extern char SIGNAL_FILE[STRING_SIZE];
36
    extern char SIGNAL_FILE_SH[STRING_SIZE];
37
    extern FILE *FP;
38
    
39 40 41 42 43 44
    extern int TRKILL_STF_OFFSET;
    extern float TRKILL_STF_OFFSET_LOWER;
    extern float TRKILL_STF_OFFSET_UPPER;
    
    extern int USE_WORKFLOW;
    extern int WORKFLOW_STAGE;
45 46 47
    extern int VERBOSE;
    char obs_y_tmp[STRING_SIZE];
    char mod_y_tmp[STRING_SIZE];
48
    
tilman.metz's avatar
tilman.metz committed
49
	/* declaration of variables for trace killing */
50
	int ** kill_tmp = NULL, *kill_vector = NULL, h, j;
51
	char trace_kill_file[STRING_SIZE];
tilman.metz's avatar
tilman.metz committed
52 53 54 55 56 57 58
	FILE *ftracekill;
	
	/* --------------- declaration of variables --------------- */
	unsigned int nrec, nsamp, i, npairs;
	float dt;
	float xr=0.0, yr=0.0;
	float XS=0.0, YS=0.0;
59
	char qw[STRING_SIZE];
tilman.metz's avatar
tilman.metz committed
60 61
	
	/* variables for wavelet */
62
	int nt, nts = 0;
tilman.metz's avatar
tilman.metz committed
63 64
	float tshift, amp=0.0, fc, tau, t, ts, ag;
	float * wavelet, * stf_conv_wavelet, *psource=NULL;
65
	
tilman.metz's avatar
tilman.metz committed
66 67 68 69 70 71
	wavelet=vector(1,ns);
	stf_conv_wavelet=vector(1,ns);
	
	printf("\n================================================================================================\n\n");
	printf("\n ***** Inversion of Source Time Function - shot: %d - it: %d ***** \n\n",ishot,iter);
	
72 73 74 75 76
    /* if TRKILL_STF==1 a trace killing is applied */
    if(TRKILL_STF){
        kill_tmp = imatrix(1,ntr_glob,1,nshots);
        kill_vector = ivector(1,ntr_glob);
        
77 78 79 80 81 82 83 84 85 86 87
        
        /*------------------*/
        /* clear kill table */
        /*------------------*/
        for(i=1;i<=nsrc_glob;i++){
            for (j=1; j<=ntr_glob; j++) {
                kill_tmp[j][i]=0;
            }
        }
        
        if(TRKILL_STF_OFFSET==1) {
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
            
            if(MYID==0) {
                printf("Automatic offset based TraceKill for STF\n");
            }
            
            /* Generate TraceKill file on the fly */
            create_trkill_table(kill_tmp,ntr_glob,recpos,nsrc_glob,srcpos,-100,TRKILL_STF_OFFSET_LOWER,TRKILL_STF_OFFSET_UPPER);
            
        } else {
            if(USE_WORKFLOW){
                sprintf(trace_kill_file,"%s_%i.dat",TRKILL_FILE_STF,WORKFLOW_STAGE);
                ftracekill=fopen(trace_kill_file,"r");
                if (ftracekill==NULL){
                    sprintf(trace_kill_file,"%s.dat",TRKILL_FILE_STF);
                    ftracekill=fopen(trace_kill_file,"r");
                    if (ftracekill==NULL){
                        declare_error(" Trace kill file could not be opened!");
                    }
                }
            }else{
108 109 110
                sprintf(trace_kill_file,"%s.dat",TRKILL_FILE_STF);
                ftracekill=fopen(trace_kill_file,"r");
                if (ftracekill==NULL){
111
                    declare_error(" Trace kill file could not be opened!");
112 113
                }
            }
114 115 116 117 118
            
            for(i=1;i<=ntr_glob;i++){
                for(j=1;j<=nshots;j++){
                    fscanf(ftracekill,"%d",&kill_tmp[i][j]);
                }
119
            }
120 121
            
            fclose(ftracekill);
122 123 124 125 126
            
            if(TRKILL_STF_OFFSET==2) {
                /* Generate TraceKill file on the fly */
                create_trkill_table(kill_tmp,ntr_glob,recpos,nsrc_glob,srcpos,-100,TRKILL_STF_OFFSET_LOWER,TRKILL_STF_OFFSET_UPPER);
            }
127
        }
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
        h=1;
        for(i=1;i<=ntr_glob;i++){
            kill_vector[h] = kill_tmp[i][ishot];
            h++;
        }
    } /* end if(TRKILL_STF)*/
    
    if(TRKILL_STF){
        for(i=1;i<=ntr_glob;i++){
            if(i==1)printf("\n ***** Trace killing is applied for trace: ***** \n ***** \t");
            if(kill_vector[i]==1){
                printf("%d \t",i);
                for(j=1;j<=ns;j++){
                    sectionvy[i][j]=0.0;
                    sectionvy_obs[i][j]=0.0;
                }
            }
            if(i==ntr_glob)printf(" ***** \n\n");
        }
    }
tilman.metz's avatar
tilman.metz committed
148 149
	/* trace killing ends here */
	
150
	if(TIMEWIN==1){
151 152
		time_window_glob(sectionvy, iter, ntr_glob, ns, ishot);
		time_window_glob(sectionvy_obs, iter, ntr_glob, ns, ishot);
153 154
	}
	
tilman.metz's avatar
tilman.metz committed
155
	/* NORMALIZE TRACES */
156 157 158 159
	if(NORMALIZE==1){
		normalize_data(sectionvy,ntr_glob,ns);
		normalize_data(sectionvy_obs,ntr_glob,ns);
	}
tilman.metz's avatar
tilman.metz committed
160 161 162 163 164 165 166 167 168 169
	
	nrec=(unsigned int)ntr_glob;
	nsamp=(unsigned int)ns;
	dt=DT;
	npairs=nrec;
	
	/* source coordinates are written into trace header fields */
	XS=srcpos[1][ishot];	
	YS=srcpos[2][ishot];
	
170
	
tilman.metz's avatar
tilman.metz committed
171
	/* TF Software: see libstfinv */
172
	
tilman.metz's avatar
tilman.metz committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
	struct CTriples data;
	data.n=nrec;
	data.triples=(struct CWaveformTriple *)malloc(nrec*sizeof(struct CWaveformTriple));
	if (data.triples == NULL) {abort();}
	for (i=0;i<nrec;i++){
	
		xr=recpos[1][i+1]*DH;
		yr=recpos[2][i+1]*DH;
		
		data.triples[i].data=&sectionvy_obs[i+1][1];
		
		data.triples[i].synthetics=&sectionvy[i+1][1];
		
		data.triples[i].convolvedsynthetics=&sectionvy_conv[i+1][1];
		
		data.triples[i].header.sx=(unsigned int)iround(XS*1000.0);  /* X source coordinate */
		data.triples[i].header.sy=0.0;
		data.triples[i].header.sz=(unsigned int)iround(YS*1000.0);  /* source depth (positive) */
		data.triples[i].header.rx=(unsigned int)iround(xr*1000.0);  /* group coordinates */
		data.triples[i].header.ry=0.0;
		data.triples[i].header.rz=(unsigned int)iround(yr*1000.0);
		data.triples[i].header.sampling.n=nsamp;
		data.triples[i].header.sampling.dt=dt;
	}
	
	struct CWaveform stf;
	stf.series = &source_time_function[1];
	stf.sampling.n=nsamp;
	stf.sampling.dt=dt;
	
	
	initstfinvengine(data, stf, PARA);
205
	
tilman.metz's avatar
tilman.metz committed
206 207 208 209 210
	runstfinvengine();
	
	/* END TF Software */
	
	
211
	psource=vector(1,ns);
tilman.metz's avatar
tilman.metz committed
212
	
213 214
	if (SOURCE_SHAPE==3) psource=rd_sour(&nts,fopen(SIGNAL_FILE,"r"));
	if (SOURCE_SHAPE==7){
215
		inseis_source_wavelet(psource,ns,ishot,SH,1);
216
	}
tilman.metz's avatar
tilman.metz committed
217 218 219 220 221
	
	/* calculating wavelet SIN**3 for convoling with STF */
	tshift=srcpos[4][ishot];
	fc=srcpos[5][ishot];
	ts=1.0/fc;
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
    for (nt=1;nt<=ns;nt++){
        t=(float)nt*DT;
        switch (SOURCE_SHAPE){
                case 1 :
                /* New Ricker Wavelet, equal to SOFI2D */
                tau=PI*(t-1.5*ts-tshift)/(ts);
                amp=(((1.0-2.0*tau*tau)*exp(-tau*tau)));
                break;
                case 2 :
                if ((t<tshift) || (t>(tshift+ts))) amp=0.0;
                else amp=((sin(2.0*PI*(t-tshift)*fc)
                           -0.5*sin(4.0*PI*(t-tshift)*fc)));
                break;
                case 3 :
                /* source wavelet from file SOURCE_FILE */
                if (nt<=nts) amp=psource[nt];
                else amp=0.0;
                break;
                case 4 :
                /* sinus raised to the power of three */
                if ((t<tshift) || (t>(tshift+ts))) amp=0.0;
                else amp=pow(sin(PI*(t+tshift)/ts),3.0);
                break;
                
                break;
                case 5 :
                /* first derivative of a Gaussian */
                ts=1.2/fc;
                ag  = PI*PI*fc*fc;
                amp = - 2.0 * ag * (t-ts) * exp(-ag*(t-ts)*(t-ts));
                break;
                case 6 :
                /* Bandlimited Spike */
                amp=0.0;
                if(nt==1+iround(tshift/DT)){
                    amp = 1.0;}
                break;
                case 7 :
                /* source wavelet from file SOURCE_FILE */
                amp=psource[nt];
                break;
                case 8 :
                /* integral of sinus raised to the power of three */
                if (t<tshift) {
                    amp=0.0;}
                if ((t>=tshift) && (t<=(tshift+ts))){
                    amp=(ts/(0.75*PI))*(0.5-0.75*cos(PI*(t-tshift)/ts)+0.25*pow(cos(PI*(t-tshift)/ts),3.0));}
                if (t>(tshift+ts))
            {amp=ts/(0.75*PI);}
                break;                                                                                                                                           	
            default : 
                declare_error("Which source-wavelet ? ");
                
                
        }/* end of switch (SOURCE_SHAPE)  */
        wavelet[nt]=amp;
        
    }/*  end of for (nt=1;nt<=ns;nt++) */
280
	
tilman.metz's avatar
tilman.metz committed
281 282 283
	/* convolving wavelet with STF */
	conv_FD(wavelet,source_time_function,stf_conv_wavelet,ns);
	
284
	if(TAPER_STF)
285
		taper(stf_conv_wavelet, ns, fc);
tilman.metz's avatar
tilman.metz committed
286
	
287 288 289 290 291 292 293 294 295 296 297 298
    /* Writing out used seismograms for debugging purposes */
    if(VERBOSE){
        /* --------------- writing out the observed seismograms --------------- */
        sprintf(obs_y_tmp,"%s.shot%d.it%d.inputSTF.observed.su",SIGNAL_FILE,ishot,iter);
        printf(" PE %d is writing %d observed seismograms (vy) for shot = %d to\n\t %s \n",MYID,ntr_glob,ishot,obs_y_tmp);
        outseis_glob(fp,fopen(obs_y_tmp,"w"),1,sectionvy_obs,recpos,recpos_loc,ntr_glob,srcpos,0,ns,SEIS_FORMAT,ishot,0);
        
        /* --------------- writing out the modelled seismograms --------------- */
        sprintf(mod_y_tmp,"%s.shot%d.it%d.inputSTF.synthetic.su",SIGNAL_FILE,ishot,iter);
        printf(" PE %d is writing %d modelled seismograms (vy) for shot = %d to\n\t %s \n",MYID,ntr_glob,ishot,mod_y_tmp);
        outseis_glob(fp,fopen(mod_y_tmp,"w"),1,sectionvy,recpos,recpos_loc,ntr_glob,srcpos,0,ns,SEIS_FORMAT,ishot,0);
    }
299
	
tilman.metz's avatar
tilman.metz committed
300
	/* --------------- writing out the source time function --------------- */
301
	if((TIME_FILT==1)||(TIME_FILT==2)){
302
        if(SH==0) {
303 304 305 306 307
            if(USE_WORKFLOW){
                sprintf(qw,"%s.stage%d.shot%d_%dHz.su",SIGNAL_FILE,WORKFLOW_STAGE,ishot,(int)FC);
            } else {
                sprintf(qw,"%s.shot%d_%dHz.su",SIGNAL_FILE,ishot,(int)FC);
            }
308
        } else {
309 310 311 312 313
            if(USE_WORKFLOW){
                sprintf(qw,"%s.stage%d.shot%d_%dHz.su",SIGNAL_FILE_SH,WORKFLOW_STAGE,ishot,(int)FC);
            } else {
                sprintf(qw,"%s.shot%d_%dHz.su",SIGNAL_FILE_SH,ishot,(int)FC);
            }
314
        }
315 316
		printf(" PE %d is writing source time function for shot = %d to\n\t %s \n",MYID,ishot,qw);
		outseis_vector(fp,fopen(qw,"w"),1,stf_conv_wavelet,recpos,recpos_loc,ntr,srcpos,0,ns,SEIS_FORMAT,ishot,0);
tilman.metz's avatar
tilman.metz committed
317
	}
318 319
    
    if(SH==0) {
320 321 322 323 324
        if(USE_WORKFLOW){
            sprintf(qw,"%s.stage%d.shot%d.su",SIGNAL_FILE,WORKFLOW_STAGE,ishot);
        } else {
            sprintf(qw,"%s.shot%d.su",SIGNAL_FILE,ishot);
        }
325
    } else {
326 327 328 329 330
        if(USE_WORKFLOW){
            sprintf(qw,"%s.stage%d.shot%d.su",SIGNAL_FILE_SH,WORKFLOW_STAGE,ishot);
        } else {
            sprintf(qw,"%s.shot%d.su",SIGNAL_FILE_SH,ishot);
        }
331
    }
tilman.metz's avatar
tilman.metz committed
332 333 334 335 336 337 338 339 340 341 342 343 344
	printf(" PE %d is writing source time function for shot = %d to\n\t %s \n",MYID,ishot,qw);
	outseis_vector(fp,fopen(qw,"w"),1,stf_conv_wavelet,recpos,recpos_loc,ntr,srcpos,0,ns,SEIS_FORMAT,ishot,0);
	
	
	/*freestfinvengine();
	free(data.triples);*/
	
	free_vector(wavelet,1,ns);
	free_vector(stf_conv_wavelet,1,ns);
	free_vector(psource,1,ns);
	
	/* free memory for trace killing */
	if(TRKILL_STF){
345 346
		free_imatrix(kill_tmp,1,ntr_glob,1,nshots);
		free_ivector(kill_vector,1,ntr_glob);
tilman.metz's avatar
tilman.metz committed
347
	}
348
}