Thursday, June 22, 2000

Perl P2/91 & P2/94 fathometer data correction script (code nostalgia)

This is the last posting of a series of postings initiated by me finding an old backup hard disk containing some scripts written when I was working in the Marine Seismic industry.

I remember hacking these scripts in the ed editor on HP-UX, with no version control apart from manually maintaining the versions in different directories. Code wise the script is not something to look at for code structure etc... but it worked well at the time over a period of almost 3 years.

Perl 5 did have full support for classes but for some reason I did not implement this using OO.

The help information in the script states:

DESCRIPTION:
------------
This script comes in handy when your echosounder data in the P291/P294
file either is extremly noisy or non existing. The script can:
- correct noisy data, by deleting corrupt data and inserting new data
- insert new data where data is missing
The script needs the P291/P294 file with the bad data, also needed is a
"WD" file where each line contains a data pair of (SP/Water depths).


WHERE TO GET THE WD FILE:
-------------------------
SEISMIC data processors. To see more help type: "correct_P2_fatho HELPSEISMIC"
at the command prompt.

This version the script allows multiple SP ranges in the WD file.
What happens is that when the SEISMIC data operators pick the water bootom for the
SP range that are bad, the normally pick all SP ranges at one time so you
get at WD file consisting of several SP range-datasets like this (SP/depth):

 992      1285    (start first SP range)
  .         .
 999      1022    (end first SP range)
1245      1000    (start second SP range)
  .         .
1255       995    (end second SP range)   
The script will insert or remove the values for the SP ranges in the WD file
(in this example: 992-999, 1245-1255). The SP range in between the 2 ranges will
not be changed and will retain the original values from the echosounder.


IMPORTANT:
----------
The water depth file cannot have any text/empty lines in the beginning
of the file. The last line must be the last data set (no empty lines).
The script does not care about spaces or TABs on a line. Leading spaces
in a line is no problem. Some times the file from SEISMIC data processing can have double
values for the same shotpoint, this is not a problem.

 992      1285    (double values, not a problem)
 992      1285
      993              1285    (different spacing, not a problem)

and for seismic data processors the help states the following

             correct_p2_fatho v1.3
                  by
                Kenneth Thorman
             SEISMIC data - HELP
                     
1. Migrate the Near Trace Gather
2. Pick the water depth of migrated near trace gather in QCTOOL
3. Output formatted listing of DBU (this will be shotrec/time pairs)
4. In DBU examine file created in QCTOOL

EXAMPLE DBU FORMATTED OUTPUT LISTING

  Enter project name [exnor] :
  Enter access mode (r[eadonly], u[pdate]) [readonly] : u
  Enter selection (h|...|q) [l] : e 17awbpick
  Enter examine option (h|l|o|d|f|g|...|q) [l] : o
  Enter output listing file name (or "stdout") [stdout] : 17wblist.txt
  Enter examine option (h|l|o|d|f|g|...|q) [l] : f
  Enter filename of an existing format [] :
  Enter maximum line length for the list (max 255) [79] :
  Enter number of chars for instance number (0=none) [0] :
  Enter repeat factor for header line (0=no header) [50] : 0
  Select fields to tabulate :
  Enter field (q to quit, \ to list) [KEY1] :
  Enter number of characters to display field data in [4] : 8
  Enter field (q to quit, \ to list) [key1] : time
  Enter number of characters to display field data in [4] : 8
  Enter number of decimal places to display [2] : 4
  Enter field (q to quit, \ to list) [time] : q
  Enter filename to save format (leave blank for none) [] :
  Enter first instance to list (0 to quit) [1] :
  Enter last instance to list [21] :
  Enter first instance to list (0 to quit) [1] : 0
  Enter examine option (h|l|o|d|f|g|...|q) [l] : q
  Enter selection (h|...|q) [e] : q


5. run the following command from the command line:
SYNTAX:

awk '{printf "%s \t %.2f\n", $1+SPRec->SP, $2*Water_Vel}' inputfile > outputfile       

Variables:
SPRec-SP    -     difference from shot record to SP (1000)
Water_Vel   -     water velocity used / 2       ( 750)
inputfile   -     the DBU list
outputfile  -     file to give to the QC

Example:
awk '{printf "%s \t %.2f\n", $1+1000, $2*750}' EX00-22.WD.dbu > EX00-22.waterdepth

.
And finally here is the script


?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
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
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
#!/opt/perl5/bin/perl
 
#################################################################################
#   GENERAL COMMENTS FOR THIS SCRIPT   #
#################################################################################
#           #
# THE TOP LINE YOU SEE IN THIS SCRIPT IS THE LINE THAT TELLS THE COMPUTER WHERE #
# TO LOOK FOR THE PERL - EXECUTOR. (NO IT HAS NOTHING TO DO WITH HANGING :-) #
# IF YOU DO NOT KNOW WHERE PERL IS LOCATED/INSTALLED ON YOUR COMPUTER THEN TRY  #
# TYPING THE FOLLOWING AT THE COMMAND PROMPT.     #
#           #
# whereis perl         #
# which perl         #
#           #
# IMPORTANT:  THIS SCRIPT WAS WRITTEN FOR PERL VERSION 5. SINCE THERE WAS A  #
#   BIG RE-WRITE/CHANGE FROM V4 TO V5 I DOUBT IT WILL RUN ON PERL 4 #
#           #
# 17 Dec 1999,          #
# Kenneth Thorman        #
#################################################################################
 
 
 
 
  
 
#################################################################################
#    SUB ROUTINE DECLARATION     #
#################################################################################
sub GetFileBaseName;
sub CheckCommandLineSyntax;
sub OpenFiles;
sub DecideDepthOutput;
sub PutWaterDepthFileIntoArray;
sub ExtractSP;
sub ExtractWD;
sub FormatEchosounderTimeStamp;
sub CreateEchosounderDataCard;
sub Presentation1;
sub Presentation2;
sub Presentation3;
sub Presentation4;
sub DisplayOnlineHelp;
sub DisplayHELPSEISMIC;
 
#################################################################################
#   VARABLE DECLARATION     #
#################################################################################
$wd_file = $ARGV[1];
$outfile = "$ARGV[0]" . ".wd";
$log_dir = "./";
 
 
 
#################################################################################
#   MAIN SCRIPT FLOW     #
#################################################################################
CheckCommandLineSyntax;
OpenFiles;
$filebasename = GetFileBaseName($ARGV[0]);
$wd_line = <WDFILE>;
$firstsp = int (ExtractSP ($wd_line));
PutWaterDepthFileIntoArray;
$fields_in_array = @wd_file;
$wdc = 0;
 
$min_sp = 100000;
$x = $fields_in_array;
while ($x >= 0) {    # Loop through the array backwards
  if (($min_sp > $x) and (@wd_file[$x] ne "")) {
    $min_sp = $x;
  }
  $x--;
}
 
$x = $min_sp;
while ($x <= $fields_in_array) {
  if ((@wd_file[$x] eq "") and (@wd_file[$x-1] ne "")){
    @wd_sp_string[$wdc] = $x-1;
    $wdc++;
  }
  elsif ((@wd_file[$x] ne "") and (@wd_file[$x-1] eq "")){
    @wd_sp_string[$wdc] = $x;
    $wdc++;
  } 
  $x++;
}
print (@wd_sp_string);
 
$x = 1;
while (@wd_sp_string[$x] ne ""){
  if (@wd_sp_string[$x+1] eq ""){
    $wd_sp_ranges = $wd_sp_ranges . $wd_sp_string[$x-1] . "-" . $wd_sp_string[$x] . ".";
  }
  else{
   $wd_sp_ranges = $wd_sp_ranges . $wd_sp_string[$x-1] . "-" . $wd_sp_string[$x] . ", ";
  }
  $x = $x + 2;
}
  
$fields_in_array = @wd_file;
$lastsp = $fields_in_array - 1;
$T14101_Cards_Encountered = 1;
Presentation1;
 
 
$sp_count = 0;
$line = <P291FILE>;
while ($line ne ""){
  if (($line =~ /E1000/) and ($line =~ /$filebasename/)){
    $p291sp = int(substr($line,24,8));
    if ($sp_count == 0){
      Presentation2;
      $sp_count = 1;
    }
    elsif (($p291sp % 500) == 0){
      Presentation3;
    }
    if (($T14101_Cards_Encountered == 0) and ($wd_file[$p291sp] ne "")){
      $ETimeStamp = FormatEchosounderTimeStamp($line);
      $wd = @wd_file[$p291sp];
      $string = CreateEchosounderDataCard($wd, $ETimeStamp, "                                                                     ");
      print OUTFILE ($string);
      print OUTFILE ($line);
      $T14101_Cards_Encountered = 0;
    } 
    else{
      print OUTFILE ($line);
      $T14101_Cards_Encountered = 0;
    }
  }
  elsif (($line =~ /T14101/) and ($wd_file[$p291sp] ne "")){
    $wd = @wd_file[$p291sp];
    $rest_str = substr($line,12,68);
    $string = CreateEchosounderDataCard($wd, $rest_str);
    print OUTFILE ($string);
    $T14101_Cards_Encountered = 1;
  }
  else{
    print OUTFILE ($line);
  }
  $line = <P291FILE>;
}
$date = `date -u +%x`;
chop ($date);
print LOGFILE ("$date     $outfile     $wd_sp_ranges\n"); 
Presentation4;
 
 
 
 
 
#################################################################################
#   SUB ROUTINES      #
#################################################################################
 
#################################################################################
#COMMENTS: "CheckCommandLineSyntax"      #
#-------------------------------------------------------------------------------#
#          #
# ASSIGN THE NUMBER OF CMD. LINE ARG. TO $arg_cnt    #
# IF NUMBER OF CMD. LINE .ARG. NOT EQUALS 2     #
# EXIT PROGRAM AND DISPLAY THE FOLLOWING LINE     #
# "SYNTAX: correct_p291_wb <P291 File> <Waterdepth file> ..."   #
#################################################################################
 
sub CheckCommandLineSyntax{
  $arg_cnt = @ARGV;  
  if ($ARGV[0] eq "HELPSEISMIC"){
    DisplayHELPSEISMIC;
    die ("SYNTAX: correct_p2_fatho <P2 File> <Waterdepth file> ...\n\n");
  }
  elsif ($arg_cnt != 2){
    DisplayOnlineHelp;
    die ("SYNTAX: correct_p2_fatho <P2 File> <Waterdepth file> ...\n\n");
  }
}
 
 
 
 
 
 
 
 
sub DisplayOnlineHelp{
  $~ = "HELP";
  write;
}
format HELP =
 
     correct_p2_fatho v1.3
      by
       Kenneth Thorman
           
DESCRIPTION:
------------
This script comes in handy when your echosounder data in the P291/P294
file either is extremly noisy or non existing. The script can:
- correct noisy data, by deleting corrupt data and inserting new data
- insert new data where data is missing
The script needs the P291/P294 file with the bad data, also needed is a
"WD" file where each line contains a data pair of (SP/Water depths).
 
 
WHERE TO GET THE WD FILE:
-------------------------
SEISMIC data processors. To see more help type: "correct_P2_fatho HELPSEISMIC"
at the command prompt.
 
This version the script allows multiple SP ranges in the WD file.
What happens is that when the SEISMIC data operators pick the water bootom for the
SP range that are bad, the normally pick all SP ranges at one time so you
get at WD file consisting of several SP range-datasets like this (SP/depth):
 
 992   1285 (start first SP range)
  .         .
 999    1022 (end first SP range)
1245   1000 (start second SP range)
  .         .
1255   995 (end second SP range)
The script will insert or remove the values for the SP ranges in the WD file
(in this example: 992-999, 1245-1255). The SP range in between the 2 ranges will
not be changed and will retain the original values from the echosounder.
 
 
IMPORTANT:
----------
The water depth file cannot have any text/empty lines in the beginning
of the file. The last line must be the last data set (no empty lines).
The script does not care about spaces or TABs on a line. Leading spaces
in a line is no problem. Some times the file from SEISMIC data processing can have double
values for the same shotpoint, this is not a problem.
 
 992   1285 (double values, not a problem)
 992   1285
   993     1285 (different spacing, not a problem)
    
.
 
 
 
 
 
 
sub DisplayHELPSEISMIC{
  $~ = "HELPSEISMIC";
  write;
}
format HELPSEISMIC =
 
     correct_p2_fatho v1.3
      by
       Kenneth Thorman
    SEISMIC data - HELP
           
1. Migrate the Near Trace Gather
2. Pick the water depth of migrated near trace gather in QCTOOL
3. Output formatted listing of DBU (this will be shotrec/time pairs)
4. In DBU examine file created in QCTOOL
 
EXAMPLE DBU FORMATTED OUTPUT LISTING
 
  Enter project name [exnor] :
  Enter access mode (r[eadonly], u[pdate]) [readonly] : u
  Enter selection (h|...|q) [l] : e 17awbpick
  Enter examine option (h|l|o|d|f|g|...|q) [l] : o
  Enter output listing file name (or "stdout") [stdout] : 17wblist.txt
  Enter examine option (h|l|o|d|f|g|...|q) [l] : f
  Enter filename of an existing format [] :
  Enter maximum line length for the list (max 255) [79] :
  Enter number of chars for instance number (0=none) [0] :
  Enter repeat factor for header line (0=no header) [50] : 0
  Select fields to tabulate :
  Enter field (q to quit, \ to list) [KEY1] :
  Enter number of characters to display field data in [4] : 8
  Enter field (q to quit, \ to list) [key1] : time
  Enter number of characters to display field data in [4] : 8
  Enter number of decimal places to display [2] : 4
  Enter field (q to quit, \ to list) [time] : q
  Enter filename to save format (leave blank for none) [] :
  Enter first instance to list (0 to quit) [1] :
  Enter last instance to list [21] :
  Enter first instance to list (0 to quit) [1] : 0
  Enter examine option (h|l|o|d|f|g|...|q) [l] : q
  Enter selection (h|...|q) [e] : q
 
 
5. run the following command fron the command line:
SYNTAX:
 
awk '{printf "%s \t %.2f\n", $1+SPRec->SP, $2*Water_Vel}' inputfile > outputfile 
 
Variables:
SPRec-SP    -  difference from shot record to SP (1000)
Water_Vel   -  water velocity used / 2    ( 750)
inputfile   -  the DBU list
outputfile  -   file to give to the QC
 
Example:
awk '{printf "%s \t %.2f\n", $1+1000, $2*750}' EX00-22.WD.dbu > EX00-22.waterdepth
 
.
 
 
 
 
#################################################################################
#COMMENTS: "GetFileBaseName"       #
#-------------------------------------------------------------------------------#
#          #
# INPUT  : FILENAME (TEXT STRING) EX. BR98-092.0.P291    #
# FUNCTION: READ THE STRING FROM THE START WHEN ENCOUNTING A "." THROW THE REST #
#    AWAY         #
# OUTPUT  : FILE BASE NAME (LINENAME) EX. BR98-092    #
#################################################################################
 
sub GetFileBaseName{
  my ($input_str) = @_;
  my ($end_pos, $temp);
       
  if ($input_str =~ /\./g)
  {
    $end_pos = pos ($input_str);
  }
   
  $temp = substr ($input_str, 0, $end_pos-1);
  return ($temp);
}
 
 
 
 
 
 
 
 
#################################################################################
#COMMENTS: "OpenFiles"        #
#-------------------------------------------------------------------------------#
#          #
# OPENS ALL NECCESARY FILES (P291 ORIGINAL, WATER DEPTH FILE, OUTFILE)  #
# IF A PROBLEM IS ENCOUNTERED OPENING ANY OF THE FILE AN ERROR MESSAGE IS  #
# DISPLAYED.         #
#################################################################################
 
sub OpenFiles{
  open (WDFILE, "$wd_file") or die ("Could not open infile $ARGV[1].\n");
  open (P291FILE, "$ARGV[0]") or die ("Could not open infile $ARGV[0].\n");
  open (OUTFILE, ">$outfile") or die ("Could not open outfile $outfile.\n");
  $log = $log_dir . "correct_P2_fatho.LOG";
  if (-e $log){
    open (LOGFILE, ">>$log") or die ("Could not open logfile.\n");
  }
  else{
    open (LOGFILE, ">$log") or die ("Could not open logfile.\n");
    print LOGFILE ("\n\n\n     Echosounder data\n");
    print LOGFILE ("Date:      Filename:   corrected for SP range:\n");
    print LOGFILE ("-----------------------------------------------------------\n");
  }
}
 
 
 
 
 
 
 
#################################################################################
#COMMENT: "Presentation 1-3"       #
#-------------------------------------------------------------------------------#
#          #
# THIS SUB ROUTINE PRESENTS IMPORTANT INFORMATION TO THE USER IN A EASIER #
# READABLE WAY THAN IF IT HAD BEEN TRHOWN OUT ON THE SCREEN.   #
#################################################################################
 
sub Presentation1{
$~ = "MYFORMAT1";
write;
}
 
sub Presentation2{
$~ = "MYFORMAT2";
write;
}
 
sub Presentation3{
$~ = "MYFORMAT3";
write;
}
 
sub Presentation4{
$~ = "MYFORMAT4";
write;
}
 
 
format MYFORMAT1 =
 
 
 
 
***************************************************************************
*      FILE       |  FIRST SP  |  LAST SP  |  NOW PROCESSING  *
***************************************************************************
* Water depth correction file: @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<*
           $wd_sp_ranges
***************************************************************************
.
 
format MYFORMAT2 =
* @<<<<<<<<<<<<<<<<<<<<<<<<<< |  @|||||||  |           |      *
  @ARGV[0]     $p291sp
.
 
format MYFORMAT3 =
* @<<<<<<<<<<<<<<<<<<<<<<<<<< |       |           |@|||||||||||||||||*
  @ARGV[0]          $p291sp
.
 
format MYFORMAT4 =
* @<<<<<<<<<<<<<<<<<<<<<<<<<< |       |  @||||||  |    *
  @ARGV[0]        $p291sp
***************************************************************************
* STATUS: FINISHED PROCESSING            *
* CORRECTED P291 FILE: @<<<<<<<<<<<<<<<<<<<<<<      *
   $outfile
***************************************************************************
 
Author  : Kenneth Thorman       
Script  : correct_p291_fatho v1.3     
Date    : 19/6 - 1999       
 
 
*********************************************************************
* This script is shareware, if you find this script usefull a small *
* contribution would be appreciated.                                *
* It encourages to write more usefull scripts and programs.         *
*********************************************************************
        
.
 
 
 
 
 
 
 
 
#################################################################################
#COMMENT: "ExtractSP"        #
#-------------------------------------------------------------------------------#
#           #
# THIS SUB ROUTINE EXTRACTS THE SHOTPOINT NUMBER IN A TEXT FILE   #
# THE FILE CAN HAVE LEADEING SPACES, IT CAN BE UNEVENLY SEPARATED BY SPACES #
# BUT IT MUST CONTAIN 2 NUMBERS PER LINE, SHOTPOINT NUMBER / WATERDEPTH  #
# EXAMPLES: 993   1285       #
#    994       1285   #
#          #
# BASICALLY IT DOES NOT CARE ABOUT SPACES, AT THE TOP OF THE FILE THE CAN BE #
# NO TEXT, AND THERE CAN BE NO BLANK LINES INBETWEEN LINES   #
#          #
# INPUT:  ONE LINE OF TEXT      #
# RETURN VALUE: SHOTPOINT NUMBER      #
#################################################################################
 
sub ExtractSP{
 
  my ($temp_line) = @_;
  my (@temp_array, $SP);
   
  @temp_array = split (/[\t ]+/, $temp_line);
  if (@temp_array[0] eq ""){
    $SP = @temp_array[1];
  }
  else{
    $SP = @temp_array[0];
  }
  return ($SP);
}
 
 
 
 
 
 
 
 
#################################################################################
#COMMENT: "ExtractWD"        #
#-------------------------------------------------------------------------------#
#           #
# THIS SUB ROUTINE EXTRACTS THE WATER DEPTH NUMBER IN A TEXT FILE  #
# THE FILE CAN HAVE LEADEING SPACES, IT CAN BE UNEVENLY SEPARATED BY SPACES #
# BUT IT MUST CONTAIN 2 NUMBERS PER LINE, SHOTPOINT NUMBER / WATERDEPTH  #
# EXAMPLES: 993   1285       #
#    994       1285   #
#          #
# BASICALLY IT DOES NOT CARE ABOUT SPACES, AT THE TOP OF THE FILE THE CAN BE #
# NO TEXT, AND THERE CAN BE NO BLANK LINES INBETWEEN LINES   #
#          #
# INPUT:  ONE LINE OF TEXT      #
# RETURN VALUE: WATER DEPTH       #
#################################################################################
 
sub ExtractWD{
 
  my ($temp_line) = @_;
  my (@temp_array, $WD);
 
  @temp_array = split (/[\t ]+/, $temp_line);
  if (@temp_array[0] eq ""){
    $WD = @temp_array[2];
  }
  else{
    $WD = @temp_array[1];
  }
  return ($WD);
}
 
 
 
 
 
 
 
 
#################################################################################
#COMMENT: "PutWaterDepthFileIntoArray"      #
#-------------------------------------------------------------------------------#
#          #
# THIS SUB ROUTINE DOES EXACTLY WHAT THE NAME IMPLIES. IT USES THE 2 ABOVE  #
# MENTIONED SUB ROUTINES TO EXTRACT THE SP NUMBER AND THE WATER DEPTH FROM A  #
# FILE AND THE IT PUTS THESE VALUE INTO AN ARRAY BUILT UP AS FOLLOWS  #
# SP NUMBER (INDEX VALUE) / WATER DEPTH (FIELD VALUE)    #
#          #
# SO NOW YOU CAN REFERENCE THE ARRAY BY SHOTPOINT NUMBER AND THEN GET THE  #
# WATER DEPTH AT THE SPECIFIC SHOTPOINT      #
#################################################################################
 
sub PutWaterDepthFileIntoArray{
  while ($wd_line ne ""){
    $sp = int (ExtractSP ($wd_line));
    $wd = int (ExtractWD ($wd_line));
    @wd_file[$sp] = $wd;
    $wd_line = <WDFILE>;
  }
}
 
 
 
 
 
 
 
#################################################################################
#COMMENT: "FormatEchosounderTimeStamp"      #
#-------------------------------------------------------------------------------#
#          #
# THIS SUB ROUTINE EXTRACTS AND FORMATS THE TIMESTAMP FROM THE E1000 GENERAL    #
# CARD  IN THE P291 FILE AND SUBTRACTS 0.1 SECOND.     #
# THIS IS DONE SO THE ECHOSOUNDER CARD CREATED LATER        #
# WILL HAVE A SEQUENTIAL INCREASING TIMESTAMP COMPARED TO THE CARDS LOCATED     #
# BEFORE AND AFTER IT IN THE P291 FILE. THE TIME STAMP IN THE GENERAL CARD IS   #
# NOT IN THE SAME FORMAT AS THE TIMESTAMP NEEDED FOR THE ECHOSOUNDER CARD #
#          #
# GENERAL CARD: HHMMSS.S       #
# ECHO CARD   : HHMMSSS        #
#          #
# INPUT  : E1000 - GENERAL LINE FROM P291 FILE     #
# OUTPUT : TIMESTAMP IN CORRECT FORMAT FOR A T14101 CARD IN THE P291 FILE #
#################################################################################
 
sub FormatEchosounderTimeStamp{
   
  my ($temp_line) = @_;
  my ($string);
   
  $time = substr ($temp_line,58,9);
  $string = sprintf("%7.1f", ($time - 0.1));
  $string =~ s/\.//;
  return ($string);
}
 
 
 
 
 
 
 
#################################################################################
#COMMENT: "CreateEchosounderDataCard"      #
#-------------------------------------------------------------------------------#
#          #
# THIS SUB ROUTINE CREATES/OR MODIFIES THE ECHOSOUNDER CARD DEPENDING ON WHICH  #
# ROUTINE IT IS CALLED FROM, AND WHAT VARIABLE THAT IS PASSED TO IT.  #
#################################################################################
 
sub CreateEchosounderDataCard{
 
  my ($wd, $TimeStamp, $end_string) = @_;
  my ($temp_string);
 
  if ($wd < 100){     
    $water_depth = sprintf("  %5.1f", $wd);
  }
  elsif ($wd < 1000){
    $water_depth = sprintf(" %5.1f", $wd);
  }
  else{
    $water_depth = sprintf("%5.1f", $wd);
  }
 
  $temp_string = "T14101" . "$water_depth" . "$TimeStamp" . "$end_string";
  $string = substr($temp_string,0,80) . "\n";
  return ($string);
}
 
 
 
 
 
 
 
 
# Version History:
 
# 1.3:  The online help and the comments in the script clarified
# plus check for compatibility with the new P294 format
# 1.2:  Seperate SP-ranges in the WD file allowed
# 1.1:  The output to a log file was created.
# 1.0:  Script created
Posted by at 2 comments:
Labels: ,

Wednesday, June 21, 2000

Perl P190 Navigation Merge script (code nostalgia)

Continuing my explorations of the newly found old backup hard disk I found this small gem :). The code and structure could arguably be improved on a lot but considering this stared out as a small utility script that was immensely useful and it just worked back in 1997-1999 it never got rewritten.

When you are doing marine seismic exploration you are  gathering navigation data (where have the boat been and where have the recording equipment been located) when recording the seismic data. Quite a lot of the time a "seismic line" cannot be completed due to equipment failure, noise on the hydrophones ... If this happens you circle the boat and try again with an Alpha, Beta ... part of the line.
 
The navigation data is recorded in P2/91 & P2/94 (P2/94 EXCHANGE FORMAT FOR RAW MARINE POSITIONING DATA) format and the processed navigational data can be in P1/90 format (U.K.O.O.A. P1/90 POST PLOT DATA EXCHANGE TAPE).

Anyway this perl script processes and combines any Alpha, Beta ... lines into one file.

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
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
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
#!/opt/perl5/bin/perl
 
# Script : Navigation Merging v1.52
 
# Description
 
# This script takes any number of P190 files and merges them
# file1, file2,file3. It can deal with incrementing SP as well
# as decrementing SP. It also searches Alpha, Bravo, Charlie
# linename prefixes in the final .cmb file. and changes this to
# the basic linename. Corrects LSP in the header if Streamer Model
# comment is exported to file.
 
# Linename P98-030
# Alphaname P98-030A
 
# The script looks for
# VP98-030A       1    3141145154.97S12115 5.23E...
 
# and changes this to
# VP98-030        1    3141145154.97S12115 5.23E...
 
# Author :     Kenneth Thorman
# Date      :     27/12/1998
 
 
 
 
# MAJOR SUBROUTINES
sub CheckCommandLineSyntax;
sub CreateOutputFile;
sub WriteFirstFile;
sub WriteMiddleFiles;
sub GetSPRangeForAllFiles;
sub CreateSPRangeHeaderRemark;
 
 
 
# MINOR SUBROUTINES
sub Author;
sub GetFileBaseName;
sub MakeReadmeFile;
sub Presentation1;
sub HeadFileInfo;
sub BodyFileInfo;
sub Finish;
sub HeaderStatus;
 
 
 
################################### MAIN SCRIPT ################################
 
    # Check that the user has entered the right amount of command line arguments
    CheckCommandLineSyntax;
     
    # Open the "cmb" file for writing
    CreateOutputFile;
 
    # In order to put a remark in the header about the streamer shaping we need
    # to know the SP range for the files we are combining
    GetSPRangeForAllFiles;
 
    # Create the header remark
    CreateSPRangeHeaderRemark;
 
    # Since we have to process the first file different than the remaining files
    # we do it here in a seperate procedure
    WriteFirstFile;
 
    # Since we have processed the first file above lets set the pointer to the
    # second supplied file
    $counter = 1;
 
    # Run through the files one by one as long as there files left to process
    while ($counter < ($arg_cnt))
    {
         WriteMiddleFiles ($ARGV[$counter]);
 
         # Move to the next file
         $counter++;
    }
 
    # Make a README file in the current directory explaining the "cmb" file
    MakeReadmeFile;
 
    # Before finishing of time for a little bit of narcisim from my side
    # Print the author information
    Finish;
 
 
 
################################### SUB ROUTINES ###############################
 
sub CheckCommandLineSyntax
{
  $arg_cnt = @ARGV;   # GET NUMBER OF CMD LINE ARGUMENTS
  if ($arg_cnt < 2)   # IF 0 CMD ARGUMENTS THEN ERROR!
  {
    print ($info);
    print ("\nYou need at least 2 command line arguments!\n");
    die ("SYNTAX: nav_merge file1 file2 file3 file4 ...\n\n");
    Author;
  }
}
 
 
 
sub GetSPRangeForAllFiles{
   
  $arg_cnt = @ARGV;
  $file_cnt = 0;
   
  foreach $file (@ARGV){
    open (P190FILE, "$file") or die ("Could not open $file.\n");
    #print ("Checking SP range for file: $file...\n");
    $filebasename = GetFileBaseName($file);
    $vessel_record = "V" . $filebasename;
    $count = 1;
      
    $line = <P190FILE>;
    while ($line !~ /EOF/g){
      if ($line =~ /^V/) {
         $last_sp = substr($line,20,5);   
      }
      $line = <P190FILE>;
      if (($line =~ /$vessel_record/) and ($count != 0)){
        $first_sp = substr($line,20,5);
        $count--;
      }
    }
     
    if ($file_cnt == 0){
      $final_FSP = $first_sp;
      #print ("Final FSP is: $final_FSP\n");
      $FSP = 1;
    }
    if ($file_cnt == $arg_cnt-1){
      $final_LSP = $last_sp;
      #print ("Final LSP is: $final_LSP\n");
    }
    $file_cnt++;
    close (P190FILE);
  }
  #print ("FSP: $final_FSP   LSP: $final_LSP\n");
}
 
 
 
sub CreateOutputFile
{
  $output_filename = $ARGV[0] . ".cmb";
  open (OUTFILE,">$output_filename") or die ("Cannot create file $output_filename");
}
 
 
 
sub CreateSPRangeHeaderRemark
{
  $cmb_line_name = GetFileBaseName ($ARGV[0]);
  $temp_str1 = sprintf("H2600 Streamer_001 Model Line %s shots %d to %d: Arc                                          ",
                        $cmb_line_name, $final_FSP, $final_LSP); 
  $temp_str2 = substr($temp_str1,0,80);
  $str_to_add = $temp_str2 . "\n";
}
 
 
 
sub WriteFirstFile
{
  open (HEADFILE, "$ARGV[0]") or die ("Could not open file $ARGV[0].\n");
  $filebasename = GetFileBaseName($ARGV[0]);
  $count = 1;
      
  $line = <HEADFILE>;
  $file_card = substr($line,0,1);
  $SPrangeheader = "no";
  $vessel_record = "V" . $filebasename;
 
  while ($line !~ /EOF/g){
    if ($file_card eq "H"){
      if (($line =~ /H2600/) and ($line =~ /$final_FSP/) and ($line !~ /$final_LSP/)){
        print OUTFILE ($str_to_add);
 $error =  "LSP in the header was incorrect.\n";
        $status = "Corrected. Now reflecting actual SP range in .cmb file";
        HeaderStatus;
        $SPrangeheader = "yes";
      }
      else{
        print OUTFILE ($line);
      }
    }
    elsif ($SPrangeheader eq "no"){
      print OUTFILE ($str_to_add);
      print OUTFILE ($line);
      $error =  "No SP range comment found in header";
      $status = "Corrected. Comment inserted: $str_to_add";
      HeaderStatus;
      $SPrangeheader = "yes";
    }
    else{
      print OUTFILE ($line);
    }  
    if ($line =~ /^V/) {
       $headfile_lsp = substr($line,20,5);
    }
    if (($line =~ /$vessel_record/) and ($count != 0)){
      $headfile_fsp = substr($line,20,5);
      $count--;
    }
    $line = <HEADFILE>;
    $file_card = substr($line,0,1);
     
  }
  Presentation1;
  HeadFileInfo;
  close (HEADFILE);
}  
 
 
 
sub WriteMiddleFiles
{
  my ($file_name) = @_;    #  ASSIGN PASSED PARA. TO $file_name
   
  open (BODYFILE, $file_name) or die ("Could not open file $file_name.\n");
    
  $line = <BODYFILE>;
  $count = 1;
   
  if ($headfile_fsp < $headfile_lsp)             # INCREMENTING SP NUMBER
  {
    while ($line ne "")
    {
       
      if  ($line =~ /^V/) {
        $temp = substr($line,20,5);
      }
              
      if (((~ /$filebasename/) and ($temp > $headfile_lsp) and ($line !~ /H2600/)) or ($line =~ /EOF/)) {
        if ($line =~ /$filebasename[A-Z]/)
        {
          $line =~ s/$filebasename[A-Z]/$filebasename /;
          print OUTFILE ($line);
        }
        elsif ($counter == ($arg_cnt-1))
        {
          print OUTFILE ($line);
        }
        if (($line =~ /$vessel_record/) and ($count != 0)) #  GET FIRST EXPORTED SP
        {
          $tailfile_fsp = substr($line,20,5);
          $count = 0;
        }
      }
 
      if (($line =~ /^R/) and ($temp < $headfile_lsp)){
       print OUTFILE ($line);
      }
 
      if ($line =~ /^V/) {
        $tailfile_lsp = substr($line,20,5);
      }
 
      $line = <BODYFILE>;
    }
  }
   
   
  elsif ($headfile_fsp > $headfile_ls)
  {
    while ($line ne "")    # DECREMENTING SP NUMBER
    {
       
       
      if  ($line =~ /^V/) {
        $temp = substr($line,20,5);
      }
       
       
      if ((($line =~ /$filebasename/) and ($temp < $headfile_lsp) and ($line !~ /H2600/)) or ($line =~ /EOF/))      {     
        if ($line =~ /$filebasename[A-Z]/) {
          $line =~ s/$filebasename[A-Z]/$filebasename /;
          print OUTFILE ($line);
        }
        elsif ($counter == ($arg_cnt-1)) {
          print OUTFILE ($line);
        }
        if (($line =~ /$vessel_record/) and ($count != 0)) {
          $tailfile_fsp = substr($line,20,5);
          $count = 0;
        }
      }
 
      if (($line =~ /^R/) and ($temp < $headfile_lsp)){
       print OUTFILE ($line);
      }
 
       
      if ($line =~ /^V/) {
        $tailfile_lsp = substr($line,20,5);
      }
 
      $line = <BODYFILE>;
    }
  }
  BodyFileInfo;
  $headfile_fsp = $tailfile_fsp;
  $headfile_lsp = $tailfile_lsp; 
  close (BODYFILE);
}
 
 
 
sub MakeReadmeFile
{
  open (READMEFILE,"> README");
  print READMEFILE ("Note: All \"cmb\" files are combined from multiple line segments\n");
  print READMEFILE ("      as per the seismic merge.\n");
  close (READMEFILE);
}
 
 
 
sub Author
{
  print ("\n\nNavigation Merge v1.5\n\n");
  print ("Author: Kenneth Thorman\n");
  print ("Date  : 27 dec 1998\n");
}
 
 
 
sub HeaderStatus{
$~ = "HEADERSTATUS";
write;
}
 
 
 
sub Presentation1{
$~ = "MYFORMAT1";
write;
}
 
 
 
sub HeadFileInfo{
$~ = "HEADFILEINFO";
write;
}
 
 
 
sub BodyFileInfo{
$~ = "BODYFILEINFO";
write;
}
 
 
 
sub Finish{
$~ = "FINISH";
write;
}
 
 
 
format HEADERSTATUS =
 
 
 
Header Check                                 
------------
Output File : @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$output_filename
Error       : @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$error
Status      : @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$status
.
 
 
 
format MYFORMAT1 =
 
 
Combining Files
---------------
.
 
format HEADFILEINFO =
@<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<       @<<<<<              @<<<<<     
 $ARGV[0]                    $headfile_fsp        $headfile_lsp  
.
 
format BODYFILEINFO =
@<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<        @<<<<<              @<<<<<     
 $ARGV[$counter]                   $tailfile_fsp        $tailfile_lsp  
. 
 
 
 
format FINISH =
 
 
 
 
 
                                     
27-Dec-1998, Kenneth Thorman
 
.
 
 
 
sub GetFileBaseName
{
  my ($input_str) = @_;
  my ($end_pos, $temp);
       
 if ($input_str =~/_/g){
    $start_pos = pos ($input_str);
  }   
  if ($input_str =~ /\./g){
    $end_pos = pos ($input_str) - $start_pos ;
  }
   
  $temp = substr ($input_str, $start_pos, $end_pos-1);
  return ($temp);
}
 
 
#Script   : navigation_merge
#Version  : 1.5
#Author   : Kenneth Thorman
Posted by at No comments:
Labels: ,

Hydrogeologic : Extract data from seismic files for use in surfer

I recently found a backup storage hard disk. This hard disk holds scripts and programs going back to 1998.

This specific perl script I am posting here is/was used to extract water depth data from p190 seismic files and convert it into a format Surfer could read and in turn generate images as the one below (image source: Schlumberger Water Services)





If I were to write this today I would probably write it rather differently, but alas it worked.

Pure nostalgia.

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
#!/opt/perl5/bin/perl
 
# SUB ROUTINE DECLARATION    
sub GetFileBaseName;
sub Grab_XYZ;
sub Presentation1;
sub Presentation2;
sub Presentation3;
 
 
# VARABLE DECLARATION 
@file_list = `ls -1 *.{p190,WGS84,tc,AGD84,AGD66,WGS-84,AGD-84,AGD-66,Kertau}`;
chop @file_list;
open (OUTFILE, ">surfer_file") or die ("Could not open surfer_file.\n");
 
 
# MAIN SCRIPT FLOW
Presentation1;
foreach $file (@file_list){
  open (P190FILE, "$file") or die ("Could not open $file.\n");
  $filebasename = GetFileBaseName($file);
  $shot_record = "S" . $filebasename;
  $counter = 0;
  print ("Filebasename: $filebasename\n"); 
  $line = <P190FILE>;
  while ($line ne ""){
    Grab_XYZ;
  }
  close (P190FILE);
    
  if ($counter == 0){
    $status = "FAILED";
  }
  else{
    $status = "OK";
  }
  Presentation2;
}
close (OUTFILE);
Presentation3;
 
 
 
# SUB ROUTINE IMPLEMENTATIONS
 
sub Grab_XYZ{
 if ($line =~ /$shot_record/){
   $x = substr($line,46,9);
   $y = substr($line,55,9);
   $z = -substr($line,64,6);
   print OUTFILE ("$x $y $z\n");
   $line = <P190FILE>;
   $counter++;
   #print ("$counter\n");
 }
 else{
   $line = <P190FILE>;
 }
}
 
 
 
sub GetFileBaseName
{
  my ($input_str) = @_;
  my ($end_pos, $temp);
   
  if ($input_str =~/_/g){
    $start_pos = pos ($input_str);
  }   
  if ($input_str =~ /\./g){
    $end_pos = pos ($input_str) - $start_pos ;
  }
   
  $temp = substr ($input_str, $start_pos, $end_pos-1);
  return ($temp);
}
 
 
 
 
 
 
sub Presentation1{
$~ = "MYFORMAT1";
write;
}
 
sub Presentation2{
$~ = "MYFORMAT2";
write;
}
 
sub Presentation3{
$~ = "MYFORMAT3";
write;
}
 
format MYFORMAT1 =
 
 
 
 
********************************************************************************
*           |     NUMBER OF VALUES GRABBED      |          *
*              FILE     |-----------------------------------|  STATUS  *
*    |     X     |     Y     |     Z     |          *
********************************************************************************
.
 
 
format MYFORMAT2 =
* @<<<<<<<<<<<<<<<<<<<<<<<<<<   |  @||||||  |  @||||||  |  @||||||  | @||||||| *
  $file        $counter    $counter    $counter   $status
.
 
format MYFORMAT3 =
********************************************************************************
* STATUS: FINISHED PROCESSING             *
* OUTPUT FILE: surfer_file                  *
********************************************************************************
 
Author  : Kenneth Thorman       
Script  : make_surfer_file     
Date    : 26/4 - 1999       
.


Posted by at No comments:
Labels: ,
Subscribe to: Posts (Atom)