refract_usage.f 15 KB
Newer Older
1
2
3
c this is <refract_usage.f>
c------------------------------------------------------------------------------
cS
thomas.forbriger's avatar
thomas.forbriger committed
4
c ($Id$)
5
6
7
c
c 24/05/2000 by Thomas Forbriger (IfG Stuttgart)
c
thomas.forbriger's avatar
thomas.forbriger committed
8
c ----
9
c refract is free software; you can redistribute it and/or modify
thomas.forbriger's avatar
thomas.forbriger committed
10
11
12
13
c it under the terms of the GNU General Public License as published by
c the Free Software Foundation; either version 2 of the License, or
c (at your option) any later version. 
c 
14
c refract is distributed in the hope that it will be useful,
thomas.forbriger's avatar
thomas.forbriger committed
15
16
17
18
19
20
21
22
23
c but WITHOUT ANY WARRANTY; without even the implied warranty of
c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
c GNU General Public License for more details.
c 
c You should have received a copy of the GNU General Public License
c along with this program; if not, write to the Free Software
c Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
c ----
c
24
25
26
27
c print command line hints
c
c REVISIONS and CHANGES
c    24/05/2000   V1.0   Thomas Forbriger
28
c    25/05/2000   V1.1   quick info was missing
29
c    11/01/2001   V1.2   introduced hypocenter option
thomas.forbriger's avatar
thomas.forbriger committed
30
c    17/06/2003   V1.3   introduced plflag_tracenum
thomas.forbriger's avatar
thomas.forbriger committed
31
c    09/09/2004   V1.4   introduced plflag_tracenum
thomas.forbriger's avatar
thomas.forbriger committed
32
c    26/11/2010   V1.5   provide help regarding file formats
33
c    17.12.2010   V1.6   format selection was missing in quick help
34
c    12/11/2012   V1.7   new option -Sn
35
c    20/11/2012   V1.8   new file specific flag v:
36
c                        new option -Eu
37
c                        new file specific flag b:
38
39
c    24/10/2013   V1.9   - new option -So
c                        - new option -S3
40
41
42
c
c==============================================================================
c
43
      subroutine refract_usage_short(version)
44
45
46
47
48
49
50
c
c declare parameters
      character*(*) version
cE
c------------------------------------------------------------------------------
c go
      print *,version
51
      print *,'Usage: refract [-D] [-d dev] [-v] [-p] [-ty format]'
52
      print *,'               [-Tt title] [-Tx label] [-Ty label] [-Tm T|F]'
thomas.forbriger's avatar
thomas.forbriger committed
53
      print *,'               [-Ta label] [-Tl T|F] [-Ts factor] [-TM t,x]'
54
      print *,'               [-TL n] [-Lw width] [-Lc] [-Lm max] [-Lt width]'
55
56
      print *,'               [-Cb r,g,b] [-Cf r,g,b] [-CW] [-Cc] [-Cm max]'
      print *,'               [-Eg] [-Ev] [-Eb] [-EP T|F] [-ES T|F] [-ET T|F]'
thomas.forbriger's avatar
thomas.forbriger committed
57
58
      print *,'               [-En] [-Es] [-Ew T|F] [-Et T|F] [-Ep T|F]'
      print *,'               [-Eu] [-Ef]'
thomas.forbriger's avatar
thomas.forbriger committed
59
      print *,'               [-Fp file] [-Fa file] [-Ft file] [-Fm file]'
60
61
      print *,'               [-Sx x1,x2] [-St t1,t2] [-Se exp] [-Sa lev]'
      print *,'               [-Sc lev] [-Sm mode] [-Sr vel] [-Si] [-SM]'
62
      print *,'               [-Sn] [-SR radius] [-SO minoff] [-Sh] [-So n]'
63
      print *,'               [-C] [-L] [-R radius] [-O minoff]'
64
      print *,'          file [t:n,n-n] [o:s] [s:i,s,w] [n:name]'
65
      print *,'               [h:h,l,s] [r:r,g,b] [f:format] [v:f]'
66
      print *,'         [file ...]'
67
      print *,'   or: refract -help'
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
      print *,'   or: refract -xhelp'
      return
      end
c
cS
c----------------------------------------------------------------------
c
      subroutine refract_usage_formats(version)
c
c declare parameters
      character*(*) version
c
cE
c go
      call refract_usage_short(version)
      print *,' '
      call sff_help_details
c
      stop
      end
c 
cS
c----------------------------------------------------------------------
c
      subroutine refract_usage(version)
c
c declare parameters
      character*(*) version
c
cE
c declare local variables
      integer iargc
      character*(*) refract_usage_id
      parameter (refract_usage_id=
     & '$Id$')
c
c------------------------------------------------------------------------------
c go
      call refract_usage_short(version)
107
108
109
110
111
c
      if (iargc().lt.1) stop 'ERROR: missing arguments'
c 
      print *,' '
      print *,'REFRACTion seismics - data interpretation'
112
113
      print *,'Copyright 1998, 2010 by Thomas Forbriger (IfG Stuttgart)'
      print *,' '
114
115
      call usage_purpose
      print *,' '
116
117
      print *,'-help        print online help to terminal'
      print *,'-xhelp       print online help on file formats to terminal'
118
119
120
121
      print *,' '
      print *,'-D           debug'
      print *,'-d dev       output device'
      print *,'-v           verbose'
122
      print *,'-p           interactive mode'
thomas.forbriger's avatar
thomas.forbriger committed
123
      print *,'-ty formatID format ID of data file type to be used'
124
125
126
127
128
129
130
      print *,' '
      print *,'Titles, labels, legends'
      print *,'-----------------------'
      print *,' '
      print *,'-Tt title      title string'
      print *,'-Tx label      x axis label'
      print *,'-Ty label      y axis label'
thomas.forbriger's avatar
thomas.forbriger committed
131
      print *,'-Ta label      replace mode setting annotations by ''label'' '
132
133
134
135
      print *,'-Tm T|F        print mode settings (T: yes; F: no)'
      print *,'-Tl T|F        print standard legend (T: yes; F: no)'
      print *,'-Ts factor     character height factor'
      print *,'-TM t,x        plot model box at time t and offset x'
136
137
      print *,'-TL n          do not use more than n lines for'
      print *,'               file name annotations'
138
139
140
141
142
143
144
      print *,' '
      print *,'Line options'
      print *,'------------'
      print *,' '
      print *,'-Lw width      standard line width'
      print *,'-Lc            use cycling line styles'
      print *,'-Lm max        maximum line style cycling index'
145
      print *,'-Lt width      width of synthetic traveltime curves'
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
      print *,' '
      print *,'Line options'
      print *,'------------'
      print *,' '
      print *,'-Cb r,g,b      background (index 0) RGB value'
      print *,'-Cf r,g,b      foreground (index 1) RGB value'
      print *,'-CW            swap color index 0 and 1 (black on white)'
      print *,'-Cc            use cycling line colors'
      print *,'-Cm max        maximum line color cycling index'
      print *,' '
      print *,'Elements and style'
      print *,'------------------'
      print *,' '
      print *,'-Eg            plot grid'
      print *,'-Ev            wiggle plot (variable area)' 
      print *,'-Eb            bubble plot'
      print *,'-EP T|F        cycle styles for picks (T:yes; F:no)'
      print *,'-ES T|F        cycle styles for waveforms (T:yes; F:no)'
      print *,'-ET T|F        cycle styles for traveltimes (T:yes; F:no)'
      print *,'-Ew T|F        plot waveforms (T:yes; F:no)'
      print *,'-Et T|F        plot synthetic traveltimes (T:yes; F:no)'
      print *,'-Ep T|F        plot picks (T:yes; F:no)'
thomas.forbriger's avatar
thomas.forbriger committed
168
      print *,'-En            label each trace with its number'
thomas.forbriger's avatar
thomas.forbriger committed
169
      print *,'-Es            label each trace with its station name'
170
      print *,'-Eu            plot scales for each trace'
thomas.forbriger's avatar
thomas.forbriger committed
171
      print *,'-Ef            plot frame enclosing view surface'
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
      print *,' '
      print *,'File reading'
      print *,'------------'
      print *,' '
      print *,'-Fp file       read traveltime polygon values from file'
      print *,'-Fa file       read arrival time pick values from file'
      print *,'-Ft file       read taper pick values from file'
      print *,'-Fm file       read model values from file'
      print *,' '
      print *,'Seismogram scaling'
      print *,'------------------'
      print *,' '
      print *,'-Sx x1,x2      display offset range [x1,x2]'
      print *,'-St t1,t2      display time range [t1,t2]'
      print *,'-Se exp        set scaling exponent'
      print *,'-Sa lev        set scaling amplitude level'
      print *,'-Sc lev        set scaling clipping level'
      print *,'-Sm mode       set scaling mode'
      print *,'                 1: scale traces individually'
      print *,'                 2: scale all traces to first trace as reference'
192
193
194
195
      print *,'                 3: scale all traces to nearest offset'
      print *,'                    trace of each dataset as reference'
      print *,'-S3 min,max    use scaling mode 3 but refer to average'
      print *,'               amplitude in offset range from min to max'
196
      print *,'-Sr vel        set traveltime reduction velocity'
thomas.forbriger's avatar
thomas.forbriger committed
197
198
      print *,'-Sn            do not align offset shifted traces along'
      print *,'               slope of reduced times'
199
200
201
202
203
204
      print *,'-Si            invert polarity'
      print *,'-SM            remove average'
      print *,'-SR radius     offset scale will be given in degrees on'
      print *,'               a sphere with radius [km].'
      print *,'-SO minoff     set minimum offset difference for two'
      print *,'               different receiver locations'
205
206
      print *,'-Sh            offset is distance to hypocenter (rather than'
      print *,'               epicenter)'
207
208
      print *,'-So n          define ordinate scale:'
      print *,'               n=0: source to receiver offset (default)'
thomas.forbriger's avatar
thomas.forbriger committed
209
210
211
      print *,'               n=1: x1 coordinate'
      print *,'               n=2: x2 coordinate'
      print *,'               n=3: x3 coordinate'
212
213
214
215
      print *,'               in cases where ordinate scales other than'
      print *,'               source to receiver offset are used together'
      print *,'               with reduced time scales, the application'
      print *,'               of option -Sn is recommended.'
216
217
      print *,' '
      print *,'The following options are supported for backward compatibility:'
218
219
      print *,'---------------------------------------------------------------'
      print *,' '
220
221
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
      print *,'-C           colors'
      print *,'-L           line styles'
      print *,'-M mode      scaling mode'
      print *,'-e expo      scaling exponent'
      print *,'-R radius    offset scale will be given in degrees on'
      print *,'             a sphere with radius [km].'
      print *,'-O minoff    set minimum offset difference for two'
      print *,'             different receiver locations'
      print *,' '
      print *,'File specific options that may be given:'
      print *,'========================================'
      print *,' '
      print *,'Trace selection - t:'
      print *,'--------------------'
      print *,'  Each datafile name may be followed by a list of'
      print *,'  traces. This list selects a range of traces in'
      print *,'  the file which will be processed. The list may'
      print *,'  not contain blanks (which is the separator to the'
      print *,'  next filname). The traces will always be processed'
      print *,'  in the order they appear in the data file, not the.'
      print *,'  order in the list.'
      print *,' '
      print *,'  Examples:'
      print *,'    t:2           will select only trace 2'
      print *,'    t:4-6,2,4     will select traces 2, 4, 5 and 6'
      print *,'    t:9,8,10,14   will select traces 8, 9, 10 and 14'
      print *,' '
247
248
249
250
251
252
      print *,'Shift offsets - o:'
      print *,'------------------'
      print *,'  You may shift all offsets within the file by ''s'' meters:'
      print *,' '
      print *,'    o:s'
      print *,' '
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
280
281
282
283
284
285
286
287
288
      print *,'Plot style options - s:'
      print *,'-----------------------'
      print *,'  You may set the color index, line style and line width'
      print *,'  through a flag following the filename:'
      print *,' '
      print *,'    s:i,s,w'
      print *,' '
      print *,'  The integer values are:'
      print *,'  i:     color index'
      print *,'  s:     line style'
      print *,'  w:     line width'
      print *,' '
      print *,'Legend string - n:'
      print *,'------------------'
      print *,' '
      print *,'  You may set a legend string alternative to the filename'
      print *,'  through:'
      print *,' '
      print *,'    n:string'
      print *,' '
      print *,'RGB color - r:'
      print *,'--------------'
      print *,' '
      print *,'  You may set an explicit color to be used for that file:'
      print *,'  (r,g,b are real values giving the RGB color triple)'
      print *,' '
      print *,'    r:r,g,b'
      print *,' '
      print *,'HLS color - h:'
      print *,'--------------'
      print *,' '
      print *,'  You may set an explicit color to be used for that file:'
      print *,'  (h,l,s are real values giving the HLS color triple)'
      print *,' '
      print *,'    h:h,l,s'
      print *,' '
thomas.forbriger's avatar
thomas.forbriger committed
289
290
291
292
293
294
295
296
      print *,'Input file format - f:'
      print *,'----------------------'
      print *,' '
      print *,'  For each input file you can select a data fiel format'
      print *,'  from the list given below (at end of help text).'
      print *,' '
      print *,'    f:formatID'
      print *,' '
297
298
299
300
301
302
303
304
305
306
307
308
      print *,'Variable area plot - v:'
      print *,'-----------------------'
      print *,' '
      print *,'  Select variable area plot for this specific file.'
      print *,' '
      print *,'    v:f'
      print *,' '
      print *,'  f=0:  do not use variable area for this file'
      print *,'  f=1:  use variable area for this file'
      print *,'  else: use variable area if selected with global'
      print *,'        option -v'
      print *,' '
309
310
311
312
313
      print *,'Plot baseline for traces from this file - b:'
      print *,'--------------------------------------------'
      print *,' '
      print *,'    b:T|F'
      print *,' '
314
315
316
317
318
319
320
321
322
323
324
325
326
      print *,'Menus to be used in interactive picking mode:'
      print *,'============================================='
      print *,' '
      call help_loopaction
      call help_menu_scaling
      call help_menu_pick
      call help_menu_hardcopy
      call help_menu_flags
      call help_menu_keyboard
      call help_menu_elements
      call help_menu_readwrite
      print *,' '
      call pgp_showdevices
327
328
      print *,' '
      call sff_help_formats
329
330
331
      stop
c
c the following line prevents the linker from removing the ID string
332
      print *, refract_usage_id
333
334
      end
c
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
c----------------------------------------------------------------------
c
      subroutine usage_purpose
c
      print *,'Purpose'
      print *,'  - plots of seismic waveforms arranging the '
     &       ,'traces along an offset axis'
      print *,'    for waveform comparison'
      print *,'  - refracted wave travel-time inversion to '
     &       ,'subsurface model'
      print *,'  - picking of arrival times'
      print *,'  - definition of offset dependent waveform '
     &       ,'tapers'
      print *,' '
      print *,'Features'
      print *,'  - supports interactive as well as '
     &       ,'non-interactive plotting'
      print *,'  - graphics output is done through PGPLOT '
     &       ,'featuring a variety of devices and'
      print *,'    graphics formats (including Postscript, '
     &       ,'X11, Tektronix, PNG, GIF, etc)'
      print *,'  - supports a variety of input formats '
     &       ,'including SeismicUn*x and raw ASCII'
      print *,'    (through libdatrwxx)'
      print *,'  - appearance of plots can be controlled by '
     &       ,'many parameters'
      print *,'    (color, line width, etc)'
      print *,'  - plotting on velocity reduced time scale'
      print *,'  - comparing shallow seismic shot data with '
     &       ,'true amplitudes'
      print *,'  - display of synthetic arrival times of '
     &       ,'refracted and reflected waves'
      print *,'    together with waveforms'
      print *,'...'
      print *,'    …'
c
      return
      end
c
374
c ----- END OF refract_usage.f -----