NAME
toolort - module to orient a VSP sonde by rotating 3-
component data about the z-axis so that the P-arrival lies
in the x-z plane.
SYNOPSIS
toolort [ -Nntap ] [ -Tttap ] [ -Ootap ] [ -Pptap ] [ -sisrc
] [ -misrc2 ] [ -rsnrst ] [ -renred ] [ -xsnxst ] [ -xenxed
] [ -xddeltax ] [ -dtdeltat ] [ -flat ] [ -pick ] [ -rotan-
gle ] [ -ROTangle ] [ -aangopt ] [ -L ] [ -V ] [ -? ]
DESCRIPTION
toolort computes, for each input record, the polar rotation
angle corresponding to a linear-regression fit found in the
x,y plane within a user specified time-window. All x,y data
within that record is then rotated about the z axis (by that
angle) so that the trend of the vector data (in that time-
window) lies in the x-z plane. If multiple sources are used
at each receiver depth, common receiver locations are
rotated by the same angle. The polarity is estimated form
the z component if possible.
toolort gets both its data and its parameters from command
line arguments. These arguments specify the input and out-
put file name-root (and suffix), the start and end records
for processing, the source orientation, a 2nd (optional)
source orientation, a flatfile/pickfile flag, the input
search window flat/pick file, a pickfile sample units over-
ride, an additional static rotation angle for use with a
second source orientation (or a file of rotation angles as a
function of some index down the line), an output angle range
specifcation, a window length analysis flag, and a verbose
printout flag. Input data is expected in three files (for
single source), or six files (for two sources), each with
the Amoco filename extension convention. [note: each record
corresponds to a particular receiver depth in the borehole.]
The linear-regression time window is input by either a flat
file of StartTime, EndTime, Record values, or a pickfile
containing one pick for window start and one for window end.
Command line arguments
-N ntap
Enter the input seismic data file name-root immediately
after typing -N. This input file should include the
complete path name if the file resides in a different
directory. Example -N/b/vsp/dummy tells the program to
look for file 'dummy.11[ttap; see below]]', etc. in
directory '/b/vsp'.
-T ttap
Enter the input seismic data set suffix immediately
after typing -T. The input files are [ntap].12[ttap]
etc. The default is: no suffix.
-O otap
Enter the output seismic data file name-root immedi-
ately after typing -O. The output data set also
requires the full path name (see above). The suffix
ttap will NOT be attached to these filenames. This
output file is not required when piping the output to
another process.
-P ptap
Enter the name of the pick/flat file containing the
maximum amplitude search window parameters immediately
after typing -P. This input file should include the
complete path name if the file resides in a different
directory. Example -N/b/vsp/dummy tells the program to
look for file 'dummy' in directory '/b/vsp'.
This file may either be a pick file in XSD format or a
flat file in the following format:
StartTime,EndTime,Record
StartTime,EndTime,Record
StartTime,EndTime,Record
. . .
. . .
. . .
. . .
StartTime,EndTime,Record
0 ,0 ,-1
If using the XSD pickfile format toolort expects two
segments with increasing sequential record number. The
easiest way to satisfy this constraint is to plot one
desired trace from every record then pick the window
start and end from left to right. Should you forget to
flag the pickfile with the correct sample units you may
use the sample unit override (see below) to compensate.
-s isrc [Default:1]
Enter source type that determines the input file. If
[isrc] is 2, then the input files will be
[rootname].21[suffix], [rootname].22[suffix], and
[rootname].23[suffix]. The default value is 1.
-m isrc2 [Default:0]
Enter the second source type. This program allow the
user to calculate the rotation angle based on the data
of two sources. The second source is optional (either
not use this option or use 0 which stands for no second
source).
-rs nrst [Default:first record]
Enter start record number.
-re nred [Default:last record]
Enter end record number.
-xs nxst [Default:nrst]
Enter the start record for hodogram xgraph output. The
program will generate xgraph files with the name
[rootname][suffix].xgr[record#] for each record within
the range specified by -xs, -xe, and -xd. The xgraph
files contain the hodograms as well as the linear
regression fit line or constant angle rotation line.
The results can help in judging the quality of linear
regression rotation angle.
-xe nxed [Default:nred]
Enter the end record for hodogram xgraph output.
-xd deltax [Default:1]
Enter the record increment for hodogram xgraph output.
You may not want to output hodograms for all records
since that will generate a lot of xgraph files.
Instead, you can choose a larger record step, or choose
the end record close to the start record. Note that the
fortran program may have an upper limit for the number
of output files.
-dt deltat [Default:not used]
Enter the pickfile sample units override in ms.
-flat
Enter the command line argument '-flat' when a flat
file is used to input maximum amplitude search window.
-pick
Enter the command line argument '-pick' when a pick
file is used to input maximum amplitude search window.
-rot [Default:0]
Enter the additional rotation angle (in degrees)
desired.
-ROT [Default:0]
Enter the constant rotation angle (in degrees) desired.
A NON-ZERO ENTRY RESULTS IN ONLY THIS ROTATION.
-a angopt [Default:0]
Enter the desired output angle range: 0 for 0 to 360
degree, 1 for -180 to 180 degree. This option is
offered so that the user can choose an angle range that
has continuous angle change with record#.
-L Enter the command line argument '-L' to get an output
ascii file [rootname][suffix].[sourcetype].ang. The
file contains the calculated rotation angle and its
standard deviation for various window length at every
record. The information can help in choosing the best
window length in pick/flat file. The implemented window
length are i*(winlen/3) where winlen is the window
length specified within the current pick/flat file.
-V Enter the command line argument '-V' to get additional
printout.
-? Enter the command line argument '-?' to get online
help. The program terminates after the help screen is
printed.
BUGS
Picks must be in increasing sequential record number.
SEE ALSO
wrot(1) grot(1)
AUTHOR
Original code by L Teng and L Thomsen
COPYRIGHT
copyright 2001, Amoco Production Company
All Rights Reserved
an affiliate of BP America Inc.
Man(1) output converted with
man2html