OpenSeaSeis Help Page

OpenSeaSeis version 2.01, build date 15 July 2013

Module List

ATTRIBUTE Extract attribute from data
BEAM_FORMING Generate beams from receiver array
BIN Perform binning
CCP Perform ccp binning
CMP Perform CMP binning
CONCATENATE Concatenate adjacent traces
CORRELATION Cross-correlation between adjacent traces, or auto-correlation of same trace
DEBIAS De-bias input data
DESIGNATURE Designature filter operation
DESPIKE Spike/noise burst removal
ELSE Else statement
ELSEIF Elseif statement
ENDIF Endif statement
ENDSPLIT Endsplit statement
ENS_DEFINE Define ensemble trace headers
FFT FFT transform
FFT_2D 2D FFT
FILTER Frequency filter
GAIN Apply gain function to trace samples
GEOTOOLS Various geophysical tools
HDR_DEL Delete trace headers
HDR_MATH Trace header computation
HDR_MATH_ENS Multi-trace header computation
HDR_PRINT Print trace header values
HDR_SET Set trace header from table
HISTOGRAM Histogram
HODOGRAM Hodogram analysis
IF If statement
IMAGE Create image file from seismic display..
INPUT Input OpenSeaSeis data
INPUT_ASCII Input ASCII file
INPUT_CREATE Create traces
INPUT_RSF Input data in RSF format
INPUT_SEGD Input SEGD data
INPUT_SEGY Input SEGY/SU data
INPUT_SINEWAVE Create traces with sine waves
KILL Kill traces
KILL_ENS Kill ensembles
LMO Linear moveout correction (NOT IMPLEMENTED YET)
MIRROR Perform mirror image binning
MUTE Mute trace data
NMO Perform NMO (normal moveout) correction
OFF2ANGLE Offset to angle transform (DEFUNCT MODULE)
ORIENT Solve sensor orientation
ORIENT_CONVERT Convert sensor orientation parameters
OUTPUT Output OpenSeaSeis data
OUTPUT_RSF Output data in RSF format
OUTPUT_SEGY Output SEGY/SU data
OVERLAP Create data overlap between adjacent traces
PICKING Pick first breaks or other event
POSCALC Compute receiver position from time picks
PZ_SUM PZ combination (STILL EXPERIMENTAL)
RAY2D 2D isotropic ray tracer
READ_ASCII Read trace header values from ASCII file
REPEAT Repeat/duplicate traces
RESAMPLE Resample trace to different sample interval (LIMITED FUNCTIONALITY!)
RESEQUENCE Resequence trace header
RMS Compute RMS value in given time window
ROTATE Perform 2D/3D rotation to input traces
SCALING Scale trace data with linear function
SELECT Select traces
SELECT_TIME Select time of interest
SEMBLANCE Semblance panel generation
SORT Sort traces
SPLIT Split/branch trace flow
SPLITTING Shear-wave splitting analysis
STACK Ensemble stack
STATICS Apply trace statics
SUMODULE Generic wrapper for Seismic Unix (SU) module (EXPERIMENTAL)
TEST Demonstration single trace module
TEST_MULTI_ENSEMBLE Test module - multi-trace, ensemble module
TEST_MULTI_FIXED Test module - multi-trace, fixed number of input traces
TIME_SLICE Extract time slice(s) from input data, write to trace header field or output data
TIME_STRETCH Stretch/squeeze data trace
TRC_ADD_ENS Ensemble trace adding
TRC_INTERPOL Interpolate traces (EXPERIMENTAL MODULE)
TRC_MATH Trace sample computation
TRC_MATH_ENS Multi-trace sample computation
TRC_PRINT Print trace samples
TRC_SPLIT Trace split

Module Description

ATTRIBUTE (1.0)

Extract attribute from data.

method

Method
?
minimum Extract minimum from data. Store minimum amplitude (attr1) and time/frequency (attr2)..
maximum Extract maximum from data. Store maximum amplitude (attr1) and time/frequency (attr2)..
max_rms Extract maximum RMS from data. Store maximum RMS amplitude (attr1) and time/frequency (attr2).. RMS is computed over sliding window, given by user parameter 'rms'.
zruns Count how many adjacent samples have the same sample value..
horizon Extract amplitude at horizon time.. Specify input horizon in user parameter 'table'.

width_win

Width of computation window
Width in units of trace, e.g. [ms] or [Hz]
0.5 Width of computation window..
2.0 Width of computation window..

rms

Definition of RMS window
...in units of trace, e.g. [ms] or [Hz]
? Width of RMS window..
0 Increment of RMS window. Set to 0 for sliding window (one sample)..

interpolate

Interpolate max/min between full samples...?
yes
yes Find min/max amplitude using quadratic interpolation.
no Pick min/max amplitude only on full samples without interpolation.

table

Table containing 'horizon'
? Name of table containing horizon definition.

table_key

Key trace header used to match values found in specified table columns
? Trace header name of key header.
? Column number in input table.
no
yes Use this key for interpolation of value.
no Do not use this key for interpolation. The input table is expected to contain the exact key values for this trace header.

table_time

Table column containing seismic time (or depth, frequency..)
? Column number in input table containing vertical dimension value.

Example:

# Extract attribute from data
$ATTRIBUTE
method ?
width_win 0.5 2.0
rms ? 0
interpolate yes
table ?
table_key ? ? no
table_time ?

BEAM_FORMING (1.0)

Generate beams from receiver array.

plane_wave

Beam-form plane waves
The output is a grid of test beams generated with parameters min/max slowness(X) x min/max slowness(Y)
0.0 Minimum slowness X/Y component [s/km].
1.0 Maximum slowness X/Y component [s/km].
50 Number of slowness steps in each dimension. Number of output traces is (N*2+1) * (N*2+1).

plane_wave_fan

Beam-form plane waves in a fan
The output is a grid of test beams generated with parameters min/max slowness x min/max azimuth
0.0 Minimum slowness [s/km].
1.0 Maximum slowness [s/km].
50 Number of slowness steps.
50 Number of azimuth steps.

point_source

Beam-form point sources
The output is a areal grid of test beams for the given area with parameter slowness
0.0 Minimum X coordinate [m].
0.0 Minimum Y coordinate [m].
10.0 Maximum X coordinate [m].
10.0 Maximum Y coordinate [m].
1.0 Increment in each dimension [m].

point_source_slowness

Constant slowness to use for point source beam-forming
1.0 Slowness [s/km].

point_source_offset

Minimum/maximum offset to use in beam forming
0.0 Minimum offset [m].
0.0 Maximum offset [m].

point_source_gain

Apply gain correction
0.0 Apply gain r^g, where r is the source-receiver offset, and g the specified gain.

window

Analysis window
0 Minimum time to analyse [ms].
0 Maximum time to analyse [ms].
zero
zero Sample values outside of the analysis window are set to 0.
cut Only samples in analysis window are output to output trace.

Example:

# Generate beams from receiver array
$BEAM_FORMING
plane_wave 0.0 1.0 50
plane_wave_fan 0.0 1.0 50 50
point_source 0.0 0.0 10.0 10.0 1.0
point_source_slowness 1.0
point_source_offset 0.0 0.0
point_source_gain 0.0
window 0 0 zero

BIN (1.0)

Perform binning.

method

Binning method
If new grid is defined (option 'define'), all parameters named 'grid_...' must be specified. For the other options, any or all grid parameter may be redefined. Grid parameters that are not redefined are taken from the existing input super header
rowcol_to_binxy
rowcol_to_binxy Set bin XY coordinates from row/col numbers.
binxy_to_rowcol Set row/col numbers from bin XY coordinates.
define Define survey grid. Requires to specify all user parameters named 'grid_...'.

grid_azim

Grid azimuth
Inline/crossline (row/col) directions, clock-wise from North
? Inline/row direction [deg]. Direction of increasing crossline/col numbers.
+90
+90 Crossline direction is 90deg clock-wise from inline direction.
-90 Crossline direction is 90deg anticlock-wise from inline direction.
Direction of increasing inline/row numbers.

grid_orig_xy

Grid origin XY coordinates
? Grid origin X coordinate [m].
? Grid origin Y coordinate [m].

grid_orig_rowcol

Grid origin row/col number
1 Origin inline/row number.
1 Origin crossline/col number.

grid_binsize

Grid bin/cell size
? Bin/cell size in inline/row direction [m]. .
? Bin/cell size in crossline/col direction [m]. .

hdr_rowcol

Trace header names for row & column output
row Inline/row output trace header name.
col Crossline/column output trace header name.

hdr_binxy

Trace header names for bin X & Y output
bin_x Bin X trace header name.
bin_y Bin Y output trace header name.

Example:

# Perform binning
$BIN
method rowcol_to_binxy
grid_azim ? +90
grid_orig_xy ? ?
grid_orig_rowcol 1 1
grid_binsize ? ?
hdr_rowcol row col
hdr_binxy bin_x bin_y

CCP (1.0)

Perform ccp binning.

Current implementation is for isotropic assumption only

method

Method for CCP binning
ccp_iso
ccp_iso Use isotropic CCP equation, assuming source & receiver are at same datum.
ray2d Perform CCP binning using output from module 'RAY2D'. No further user parameter input is required.

compute_xy

Compute bin XY location?
yes
yes Compute CCP bin XY location.

compute_bin

Compute CCP bin number?
yes
yes Compute CCP bin number.
no Do not compute CCP bin number.

bin_scalar

Numbering of CCP: Apply scalar to 'normal' CCP number
2 CCP number is computed as follows: ccp = bin_scalar * ratio * (source + rcv). ...the ratio is the ratio between the offset between the source and CCP location and the source-receiver offset.

depth

Target depth at which CCP binning shall be performed
? Target depth [m].

vpvs

Effective Vp/Vs ratio
? Effective Vp/Vs ratio at target level.

time (List)

List of time value [ms]
Time knee points at which specified velocities apply
? List of time values [ms]....

velocity (List)

List of average vertical velocities [m/s]
Velocity values at specified time knee points. In between time knee points, velocities are linearly interpolated.
? List of average vertical velocities [m/s]....

Example:

# Perform ccp binning
$CCP
method ccp_iso
compute_xy yes
compute_bin yes
bin_scalar 2
depth ?
vpvs ?
time ?
velocity ?

CMP (1.0)

Perform CMP binning.

method

CMP binning method
normal
normal 'Normal' CMP binning. Set CMP at centre between source and receiver..
obc_asym Asymmetric CMP binning for OBC geometry before redatuming. This method requires a target depth at which CMP binning will be correct.

bin_scalar

Numbering of CMP: Apply scalar to 'normal' CMP number
2 CMP numbering is computed as follows: cmp = bin_scalar * (source + rcv)/2.

depth

Target depth at which cmp binning shall be performed
? Target depth [m].

Example:

# Perform CMP binning
$CMP
method normal
bin_scalar 2
depth ?

CONCATENATE (1.0)

Concatenate adjacent traces.

This module concatenates traces to form a longer output trace. For example, if user parameter 'ntraces' is set to 3, three sequential traces are concatenated from top to bottom, forming a new output trace with 3x the trace length

mode

Mode of concatenation
traces
traces Concatenate fixed number of sequential traces, specified in user parameter 'ntraces'.
ensemble Concatenate all traces in input ensemble. Specify the maximum number of traces expected in input ensembles in user parameter 'ntraces'..

ntraces

Number of adjacent traces to concatenate
? Number of traces to concatenate.

Example:

# Concatenate adjacent traces
$CONCATENATE
mode traces
ntraces ?

CORRELATION (1.0)

Cross-correlation between adjacent traces, or auto-correlation of same trace.

Note that this version does not provide not a high-res correlation. Correlation lags are only accurate to ~1/2 the sample interval, not less The maximum cross-correlation time and amplitude are stored in new trace headers 'cross_lag' and 'cross_amp'

mode

Mode of correlation: Cross- or auto-correlation
cross
cross Cross-correlation of each consecutive trace pair.
auto Auto-correlation of each single trace.
auto_twosided Auto-correlation of each single trace. Output two-sided auto-correlation.
cross_stacked Cross-correlation of each consecutive trace pair. Stack positive & negative side.

domain

Is correlation window given in time or in samples?
time
time Window is specified in time [ms].
sample Window is specified in samples (1 for first sample).

start

Start time/sample
Start time or sample, this depends on the 'domain' setting
0 Start time/sample of cross-correlation window. Alternatively, name of trace header containing start time/sample.

end

End time/sample
? End time/sample of cross-correlation window. Alternatively, name of trace header containing end time/sample.

max_lag

Maximum cross-correlation lag [ms]
? Maximum cross-correlation lag [ms].

norm

Normalise output correlation function?
Only applicable for auto-correlation
no
yes Normalise zero lag amplitude to 1.
no Do not normalise output.

Example:

# Cross-correlation between adjacent traces, or auto-correlation of same trace
$CORRELATION
mode cross
domain time
start 0
end ?
max_lag ?
norm no

DEBIAS (1.0)

De-bias input data. Remove average DC bias. Save DC bias value in trace header 'dc'..

mode

Mode of operation
trace
trace Remove average DC bias separately from each individual input trace..
ensemble Remove average DC bias from whole input ensemble..

reapply

Re-apply DC bias?
no
yes Re-apply DC bias, e.g. add back DC bias stored in trace header 'dc'..
no Do not re-apply DC bias (normal mode of operation)..

zeros

How shall zeros in data be handled?
include
exclude Exclude zeros from DC bias computation. Zero values will not contribute to DC bias computation, and will remain unchanged in the output.
include Include zeros in DC bias computation.

Example:

# De-bias input data
$DEBIAS
mode trace
reapply no
zeros include

DESIGNATURE (1.0)

Designature filter operation.

This module generates a filter (in the frequency domain) from a specified signature wavelet, and applies this filter to all input traces. Currently supported options: Create zero-phasing filter that removes the specified signature; in other words, apply the transfer function that converts the specified signature wavelet into a zero-phase spike. Add specified white noise to signature spectrum before computing transfer function. Finally, the designature filter spectrum can be further bandpass filtered. Note that this is a naive implementation, using spectral division. The user has the choice to limit the frequency range, add white noise, and to fill notches to alleviate artefacts.

input_wavelet

Name of file containing input signature/response wavelet
? File name.
ms
ms Milliseconds.
s Seconds.

format

Input wavelet ASCII file format
columns
signature Read in source signature from Nucleus ASCII file.
columns Simple file format with 2 or 3 columns: Time[ms] Amplitude (Trace number). Trace number column is optional..

output_wavelet

Name of file containing output wavelet
? File name.
ms
ms Milliseconds.
s Seconds.

zero_time

Zero time in input wavelet
Specifying this parameter overrides the zero time that is found in the ASCII signature file
0
ms
ms Milliseconds.
s Seconds.
samples Samples.

white_noise

Amount of white noise (in percent of maximum amplitude) to add to the signature/response spectrum
0.01

notch_suppression

Suppress notches in signature wavelet
Apply cosine taper around notch frequency to filter
? Notch frequency [Hz].
? Width of suppression filter [Hz].

option

Filter type option
amp_phase
amp_phase Create amplitude & phase designature filter.
amp_only Create amplitude only designature filter.
phase_only Create phase only designature filter.

lowpass

Lowpass filter to apply to designature filter before application
? Cutoff frequency for low-pass filter [Hz]. The cutoff frequency will be damped by -3db.
5 Filter order (1-100).

highpass

Highpass filter to apply to designature filter before application
? Cutoff frequency for highpass filter [Hz]. The cutoff frequency will be damped by -3db.
5 Filter order (1-100).

filename_output

Name of file where designature filter shall be written to
? File name.

override_sample_int

Override sample interval?
no
no .
yes Ignore sample interval of input wavelet. Assume it is the same as the input data.

Example:

# Designature filter operation
$DESIGNATURE
input_wavelet ? ms
format columns
output_wavelet ? ms
zero_time 0 ms
white_noise 0.01
notch_suppression ? ?
option amp_phase
lowpass ? 5
highpass ? 5
filename_output ?
override_sample_int no

DESPIKE (1.0)

Spike/noise burst removal.

method

Despike method. Specifies how to deal with the data window of the identified noise burst/spike
cos_taper
cos_taper Apply cosine taper over spike window.
interpolation Interpolate linearly between first and last sample of identified window.
zero Set samples in spike window to zero.

win_ref

Reference window
Width in units of trace, e.g. [ms] or [Hz]
0 Width of reference window in units of trace.. Reference window over which median background value is computed.
0 Window increment in units of trace.. Set to zero for sliding window, e.g. one sample interval.

win_spike (List)

Width of despike window
Width in units of trace, e.g. [ms] or [Hz]
0 Minimum width of despike window, in units of trace.

start

Start time/frequency for despike application
Despike operation will only be performed within the specified start/end window, given in the units of the trace , e.g. [ms] or [Hz]
0 Start of application window. =0 : Use full trace from first sample.

end

End time/frequency for despike application
Despike operation will only be performed within the specified start/end window, given in the units of the trace , e.g. [ms] or [Hz]
0 End of application window. =0 : Use full trace to last sample.

max_ratio

Maximum ratio for spike detection
Ratio is computed as follows: ratio[i] = sampleValue[i] / median( sampleValues[i +/- refWin/2] )
3 Max ratio for spike detection. Example: Ratio of 2 means that current sample value is twice the median value of the reference window.

output

Output options
apply
apply Apply despike operation.
diff Output detected spikes (difference).

Example:

# Spike/noise burst removal
$DESPIKE
method cos_taper
win_ref 0 0
win_spike 0
start 0
end 0
max_ratio 3
output apply

ELSE (1.0)

Else statement. Branch remaining traces from if-elseif..-endif block.

Example:

# Else statement
$ELSE

ELSEIF (1.0)

Elseif statement. Branch traces that match specified header selection.

header (List)

Names of trace headers used for trace selection
? Trace header name.

select (List)

Selection of trace header values
? List of selection strings, one for each specified header. See documentation for more detailed description of selection syntax.

Example:

# Elseif statement
$ELSEIF
header ?
select ?

ENDIF (1.0)

Endif statement. Marks the end of an If-elseif-else-endif block.

Example:

# Endif statement
$ENDIF

ENDSPLIT (1.0)

Endsplit statement. Marks the end of a Split-endsplit block.

Example:

# Endsplit statement
$ENDSPLIT

ENS_DEFINE (1.0)

Define ensemble trace headers. An 'ensemble' consists of all consecutive traces for which the ensemble trace headers do not change.

header (List)

List of trace header names
? Trace header name.

all

Define all input traces as one ensemble
no
yes Define all input traces as one ensemble. This is done by adding a new integer trace header called 'all' which is set to '1'. If trace header 'all' already exists, a warning is displayed in the log file.
no Do not define all input traces as one ensemble.

Example:

# Define ensemble trace headers
$ENS_DEFINE
header ?
all no

FFT (0.5)

FFT transform. Transform input data from x-t to x-w domain (forward) or vice versa (inverse).

direction

Direction of transform
forward
forward Forward transform from x-t to x-w.
inverse Inverse transform from x-w to x-t.. Inverse transform will only work if a forward transform was applied before.

dump

Dump FFT values to log file
no
yes Dump FFT values to log file.
no Do not dump FFT values.

norm

Normalize output
no
yes Normalize output values. Example: Using the same input data but with different amount of added zeros, the amplitude spectrum will look exactly the same for the same output frequency.
no Do not normalize output values.

taper_type

Taper type of taper to apply to input trace
none
none Do not apply any taper to input trace.
cos Apply cosine taper to input trace.
hanning Apply 'Hanning' cosine taper to input trace. Taper length is 1/2 trace.
blackman Apply 'Blackman' taper (alpha=0.16) to input trace.

taper_len

Taper length in number of samples
10 Length in number of samples.

output

Output options for forward transform
amp_phase
amp_phase Output amplitude and phase spectrum, concatenated into one trace.
amp Output amplitude spectrum only.
real_imag Output real and imaginary values concatenated into one trace.
psd Output PSD spectrum.
psd_even Output PSD spectrum. Omit value at Nyquist frequency, i.e. output 2^N samples..

override

Override domain
no
yes Override domain found in super header.
no Acknowledge domain found in super header.

Example:

# FFT transform
$FFT
direction forward
dump no
norm no
taper_type none
taper_len 10
output amp_phase
override no

FFT_2D (1.0)

2D FFT. 2D Fast Fourier Transform to/from XT - FK domains.

direction

Direction of transform.
forward
forward Forward transform from x-t to k-w. Input must be in XT domain.
inverse Inverse transform from k-w to x-t. Input must be in FK domain.

output

Type of output after FORWARD transform.
amp_phase
amp output amplitude only.
amp_phase output both amplitude and phase.
psd Output PSD spectrum.
real_imag Output complex data such that the real part of the complex data is stored contiguously in the first half of the trace and the imaginary part of the complex data is stored contiguously in the second half of the trace.
complex Output complex data such that the real and imaginary parts of the first complex element are stored, respectively, in the first and second real float words of the trace; the real and imanginary parts of the second complex element are stored, respecitvely, in the third and fourth real float words of the trace, etc.

fix_ntr

For FORWARD transform, fix the number of traces output traces at the specified value.
Ensembles with less traces will be padded. This ensures consistent number of wave numbers after trasform. If not specified, the number of traces in each ensemble will be used 'as is' for the transform. This can be inefficent and may result in an inconsistent number of wave numbers per ensemble after the transform.
? Number of traces to fix the size of the output ensemble. The job will fail if an input ensemble contains more traces than this value.
yes
yes Reset 'fix_ntr' to improve performance.
no Use 'fix_ntr' as specified by the user.

length_opt

For FORWARD transform, reset the input traces length to be optimized for the FFT.
yes
yes Optimize trace length.
no Do not optimize trace length, use the input length.

taper_type

For FORWARD transform, taper type of taper to apply to input trace in the time direction. THIS FEATURE IS UNTESTED!
none
none Do not apply any taper to input trace.
cos Apply cosine taper to input trace.
hanning Apply 'Hanning' cosine taper to input trace. Taper length is 1/2 trace.
blackman Apply 'Blackman' taper (alpha=0.16) to input trace.

taper_len

For FORWARD transform, taper length in number of samples. THIS FEATURE IS UNTESTED!
10 Length in number of samples.

norm

Normalize output. THIS FEATURE IS UNTESTED!
no
yes Normalize output values. Example: Using the same input data but with different amount of added zeros, the amplitude spectrum will look exactly the same for the same output frequency.
no Do not normalize output values.

override

For FORWARD transform, override the domain specified in the superheader.
no
yes Override domain found in super header.
no Acknowledge domain found in super header.

Example:

# 2D FFT
$FFT_2D
direction forward
output amp_phase
fix_ntr ? yes
length_opt yes
taper_type none
taper_len 10
norm no
override no

FILTER (1.0)

Frequency filter.

type

Filter type
butterworth
butterworth Butterworth filter.

lowpass

Lowpass filter
? Cutoff frequency for low-pass filter [Hz]. The cutoff frequency will be damped by -3db.

highpass

Highpass filter
? Cutoff frequency for highpass filter [Hz]. The cutoff frequency will be damped by -3db.

impulse

Output filter impulse response
no
yes Output filter impulse response, zero phase, placed at trace centre..
no Do not output filter impulse response. (i.e. output filtered input data).

unit

Unit of frequency values supplied in parameters
hz
hz Frequencies are specified in [Hz].
percent Frequencies are specified as percent of Nyquist.

order

Filter 'order'
2 Filter order (1-100).

Example:

# Frequency filter
$FILTER
type butterworth
lowpass ?
highpass ?
impulse no
unit hz
order 2

GAIN (1.0)

Apply gain function to trace samples.

tgain

Apply time gain function
2 Time gain value: gain = t^value.

agc

Apply automatic gain control (AGC)
500 AGC sliding window length [ms].

trace_equal

Apply full trace equalisation
1 Average output amplitude.

Example:

# Apply gain function to trace samples
$GAIN
tgain 2
agc 500
trace_equal 1

GEOTOOLS (1.0)

Various geophysical tools. This module is still a prototype for testing only..

tool

Tool
comp_obc_mult1
comp_obc_mult1 Compute time of first water bottom multiple for OBC geometry.

method

Tool method
seabed_flat
seabed_flat Assume flat seabed.
seabed_linear_slope Assume seabed has linear slope.

filename

Input file name
? Input file name. ...containing receiver depths.

header

Trace header name to store result
? Trace header name. ...to store computed travel time.

velocity

Velocity [m/s]
1500.0 Velocity [m/s].

accuracy

Accuracy [m]
10.0 Accuracy [m].

Example:

# Various geophysical tools
$GEOTOOLS
tool comp_obc_mult1
method seabed_flat
filename ?
header ?
velocity 1500.0
accuracy 10.0

HDR_DEL (1.0)

Delete trace headers. Delete one or more trace headers.

header (List)

List of header names to delete
? List of trace header names. Place a star * at the beginning or end of the header name as a wild card (* in arbitrary place not supported yet).

mode

Mode of selection
include
include Kill specified trace headers.
exclude Kill all trace headers EXCEPT the ones specified..

Example:

# Delete trace headers
$HDR_DEL
header ?
mode include

HDR_MATH (1.0)

Trace header computation. Set trace headers, perform mathematical computations based on trace headers, create trace headers.

new

Create new trace header
? New trace header name.
?
int Integer, 4 byte integer type.
int64 Integer, 8 byte integer type.
float Float, 4 byte floating point type.
double Double, 8 byte floating point type.
string String type. The number of characters allocated for the string header is given in the next user parameter. Note: Once a string trace header has been created, its length cannot be increased..
? Trace header description. For string headers, specify the number of string characters here..
? Trace header description (for string headers only).

equation

Mathematical equation
? Trace header name.
? Mathematical equation (or constant text string for string header).. Constants: pi,e. Functions: abs,acos,asin,atan,atan2,ceil,cos,cosh,exp,floor,log,log10,max,min,mod,pow,int,round,sin,sinh,sqrt,tan,tanh,todegrees,toradians,sign.

Example:

# Trace header computation
$HDR_MATH
new ? ? ? ?
equation ? ?

HDR_MATH_ENS (1.0)

Multi-trace header computation. Apply multi-trace mathematical equation.

method

?
median Compute median value of header1.
mean Compute mean value of header1.
linear Fit linear polynom to header1/header2 value pairs.
xcor_cos2 Cross-correlate with cosine function (2*theta variation). header2: S1 azimuth [deg], header2: Time lag from cross-correlation.
minimum Take minimum value of header1.
maximum Take maximum value of header1.
mean_angle Compute mean value of header1 (contains angle in degrees).

header1

Trace header 1 to be used in computation
? Trace header name.

header2

Trace header 2 to be used in computation
? Trace header name.

output

all
all Output all traces. Each trace contains the result in the specified header.
last Output last trace only.
first Output first trace only.

stddev

no
yes Compute standard deviation.. A new trace header with extension _stddev will be created.
no Do not compute standard deviation.

header_select (List)

Names of trace headers used for trace selection
Only selected traces will form input to specified analysis method. All output traces will be updated with the analysis result
? Trace header name.

select (List)

Selection of header values
? List of selection strings, one for each specified header. See documentation for more detailed description of selection syntax.

select_fail

What to do when selection fails?
This parameter gives several options what will be done when the given selection criteria in parameters 'header_select' and 'select' does not match any input trace
all
all Perform specified header operation on all traces in input gather.
none Do not perform operation on any input traces. Leave specified trace header unchanged.
value Set specified trace header to constant value.
header Set specified trace header to value from another trace header.
? For option 'value': Constant value; for option 'header': Name of trace header; otherwise blank.

Example:

# Multi-trace header computation
$HDR_MATH_ENS
method ?
header1 ?
header2 ?
output all
stddev no
header_select ?
select ?
select_fail all ?

HDR_PRINT (1.0)

Print trace header values. Print trace header values to log or external file.

filename

Output file name
? Output file name.

header (List)

List of trace header names to print
? List of trace header names.

format (List)

Format codes
? List of C-style format codes to use for trace header printout.

title

Print title line showing trace header names
none
once Print title line once at the beginning.
none Do not print title line.
trc_inc Print title line with header names every n'th trace.. Specify trace increment in next user parameter.
100 Trace increment in number of traces (only for option 'trc_inc').

auto_correct

Automatically correct mismatches between user specified print format and header type
no
yes Automatically correct print format.
no Abort when mismatch has been found.

auto_format

Automatically format output
yes
yes Automatically format output.
no Manually format output.
12 Number of columns that each header spans. Examples: 12 -> '%12d'/'%12f', 0 -> '%d'/'%f', 12.2 --> '%12f'/'%12.2f', depending on type.

dump_all

Dump all headers
no
yes Dump all headers. This overrides any specification of individual headers.
no Do not create a dump of all headers.

dump_shdr

Dump super headers
Print out super header during module init phase
no
yes Print super header.
no Do not print super header.

Example:

# Print trace header values
$HDR_PRINT
filename ?
header ?
format ?
title none 100
auto_correct no
auto_format yes 12
dump_all no
dump_shdr no

HDR_SET (1.0)

Set trace header from table. Trace header values are read from table and interpolated if necessary.

table

Table containing trace header values
? Name of table containing trace header values.

key

Key trace header used to match values found in specified table columns
? Trace header name of key header.
? Column number in input table.
no
yes Use this key for interpolation of value.
no Do not use this key for interpolation. The input table is expected to contain the exact key values for this trace header.

header

Trace header to be read in/interpolated from specified table column
? Trace header name.
? Column number in input table.

table_sort

Sort table on key columns prior to interpolation?
no
yes Sort input table.
no Do not sort table on input. Assume input table is sorted according to its key columns.

Example:

# Set trace header from table
$HDR_SET
table ?
key ? ? no
header ? ?
table_sort no

HISTOGRAM (1.0)

Histogram.

ntraces

Number of input traces
0

hist

Amplitude range for histogram
? Minimum amplitude.
? Maximum amplitude.
? Step.

Example:

# Histogram
$HISTOGRAM
ntraces 0
hist ? ? ?

HODOGRAM (1.0)

Hodogram analysis. Compute 3D polarisation vector from hodogram..

input

Input data
Specifies how many input traces shall be processed at once
xyz
xyz 3 sequential input traces, containing sensors 3(X), 4(Y) and 5(Z). Sorting of these three may be arbitrary..
xyzp 4 sequential input traces, containing sensors 3(X), 4(Y) and 5(Z), and 4th trace with sensor 1(hydrophone). Sorting of these three may be arbitrary..
ensemble Input whole ensemble (user sorted). Each input ensemble must contain one trace each for sensor 3(X), 4(Y) and 5(Z). Sorting of these three may be arbitrary..

start_time

Start time of analysis window
? Start time [ms].

end_time

End time of analysis window
? End time [ms].

output_axis

Output axis
major
major Output 3d vector along major axis.
minor Output 3d vector along minor axis.

solve_pol

Solve for output vector polarity
yes
yes Yes.
no No. In this case, the polarity of the output vector is unchanged.

pol_method (List)

Method to establish polarity of polarisation vector
?
min_phase Determine polarity from the first peak and trough (minimum phase wavelet).. This specified time window should include the first two lobes of the wavelet, of which the first one determines the polarity. The first lobes (peak/trough or trough/peak) are determined as the minimum and maximum values in the specified time window..
zero_phase Determine polarity from the largest peak or trough in the specified time window.. This method works best for a zero phase wavelet..
hydrophone Polarity is established by cross-correlation with hydrophone trace.. Requires input of 4th trace = hydrophone.
match_hdr Match polarity of polarisation vector with the values in the specified trace headers. Use for example dx, dy, dz derived from the geometry to guide the polarity estimation of the polarisation vector.. Specify trace headers, or values, in parameter 'hdr_pol_match'.

pol_start_time

Start time of polarity analysis window
? Polarity start time [ms].

pol_end_time

End time of polarity analysis window
? Polarity end time [ms].

hdr_pol_match

Header names (or fixed values) for polarity method 'match_hdr'
Header giving approximate polarity of X polarisaton.
Header giving approximate polarity of Y polarisation.
Header giving approximate polarity of Z polarisation.
0 Minimum value to match. If all of the three input headers/values are lower than this value, no attempt will be made to change the polarity.

advanced_opt

Specify advanced options.
no
yes Use advanced options.
no Do not use advanced options..

force_origin

Force vector through origin.
no
yes Force output vector through origin.
no Do not force output vector through origin..

method_linefit

Method for line fitting.
3d
3d Perform full 3d line fitting through data points.

Example:

# Hodogram analysis
$HODOGRAM
input xyz
start_time ?
end_time ?
output_axis major
solve_pol yes
pol_method ?
pol_start_time ?
pol_end_time ?
hdr_pol_match 0
advanced_opt no
force_origin no
method_linefit 3d

IF (1.0)

If statement. Branch traces that match specified header selection.

header (List)

Names of trace headers used for trace selection
? Trace header name.

select (List)

Selection of header values
? List of selection strings, one for each specified header. See documentation for more detailed description of selection syntax.

Example:

# If statement
$IF
header ?
select ?

IMAGE (1.0)

Create image file from seismic display...

filename

Output image file name
Supported extensions/formats: jpg/jpeg, png, bmp, gif (or upper case letters)
? Output image file name.

seismic_filename

Input seismic file name
? Input seismic file name.

temp_dir

Temporary file directory for storing temporary files
Default is /tmp for Linux/UNIX system, and C:/Windows/Temp for Windows system
? Directory name.

properties

Action to perform on temporary 'properties file' that is auto-generated to communicate display settings between OpenSeaSeis and PlotImage
remove
remove Remove temporary 'properties file' after module finished.
keep Keep temporary 'properties file', do not remove.

width

Image width in pixels
600 Image width in pixels.

height

Image height in pixels
800 Image height in pixels.

trace_spacing

Trace spacing
even
even Ensure even trace spacing (traces/pixel = integer value). Generally, this will lead to an adjustment in the image width.
auto Automatic trace spacing dictated by image width.

header

Trace header for trace annotation
? Trace header name.

hdr_date_format

Date format
Only applicable for integer type trace headers containing seconds since 1970-1-1
none
none Do not convert trace header value to date.
hours Display time in number of hours.
days Display time in number of days.
day_month Display time as day/month.
day_month_year Display time as day/month/year.

title

Title text
To print trace header value from first data trace in title text, use the following syntax: %headerName%
? Title text.

fontsize

Font size in pixels
? Font size in pixels.

window

Window to display
? Minimum time/frequency to display [ms] or [Hz].
? Maximum time/frequency to display [ms] or [Hz].

db

Convert to dB?
no
no Do not convert to dB.
yes Convert (absolute) amplitudes to dB.

color_bar

Select this option to show the colour bar (Variable intensity/VI colour map only)
Min/max values are defined by given min/max range, parameters 'min_value', and 'max_value'
right
bottom Display colour bar at bottom of image.
right Display colour bar on the right hand side of image.
30 Size of colour bar.

color_bar_ann

Colour bar annotation
simple
simple Simple annotation.
fancy Fancy annotation.
0 Size of annotation area.

disp_scalar

Display scalar. Data is scaled by this value before plotting
? .

scale_type

Type of scaling
scalar
scalar Use simple scalar to scale data before plotting.
range Apply range (min/max) for plotting.
full_trace Apply full trace equalisation scalar before plotting.

min_value

Minimum value for 'range' scaling
? .

max_value

Maximum value for 'range' scaling
? .

wiggle

Wiggle trace display
linear
linear Apply linear interpolation between samples.
cubic Apply cubic interpolation between samples.
none Do not plot wiggle trace.

vi_type

Variable intensity plot
none
spline 2D spline interpolation.
vertical Vertical interpolation.
discrete Discrete samples.
none No variable intensity plot.

pos_fill

Fill positive wiggle?
yes
yes Fill positive wiggle.
no Do not fill positive wiggle.

neg_fill

Fill negative wiggle?
yes
yes Fill negative wiggle.
no Do not fill negative wiggle.

var_color

Use variable colour for wiggle fill?
no
yes Use variable colour for wiggle fill.
no Use constant colour for wiggle fill.

show_zero_lines

Show zero lines (amplitude = 0) for each trace?
yes
yes Show zero line.
no Do not show zero line.

show_time_lines

Show time lines?
yes
yes Show time lines.
no Do not show time lines.

time_major_inc

Time axis annotation: Major line increment [ms/Hz]
? .

time_minor_inc

Time axis annotation: Minor line increment [ms/Hz]
? .

time_max_decimals

Maximum number of decimal places to display for time/frequency axis annotation
? .

plot_direction

Plot direction: Vertical or horizontal
vertical
vertical Plot data vertically (normal)..
horizontal Plot data horizontally (90deg transposed)..

wiggle_color_map

Colour map for variable colour wiggle fill
blue_white_red
gray_w2b Gray scale, white-black.
gray_b2w Gray scale, black-white.
gray_bwb Gray scale, black-white-black.
gray_wbw Gray scale, white-black-white.
blue_white_red Blue white red.
blue_white_red2 Blue white red (2).
black_white_orange Black white orange.
black_white_red Black white red.
rainbow Rainbow colour scale.
rainbow_black Rainbow colour scale with black.
rainbow_mirror Rainbow colour scale, mirrored around zero.
cold_warm Cold to warm colour.
default Default color map (good for interpretation).

vi_color_map

Colour map for variable intensity plot
gray_w2b
gray_w2b Gray scale, white-black.
gray_b2w Gray scale, black-white.
gray_bwb Gray scale, black-white-black.
gray_wbw Gray scale, white-black-white.
blue_white_red Blue white red.
blue_white_red2 Blue white red (2).
black_white_orange Black white orange.
black_white_red Black white red.
rainbow Rainbow colour scale.
rainbow_black Rainbow colour scale with black.
rainbow_mirror Rainbow colour scale, mirrored around zero.
cold_warm Cold to warm colour.
default Default color map (good for interpretation).

trace_clip

Number of traces where seismic wiggle is clipped
Set to 0 to avoid any clipping
? .

polarity

Plot polarity convention
normal
normal Plot normal polarity (negative value are on left hand side).
reverse Plot reverse polarity (negative values are on right hand side).

log_scale

Plot is log scale?
no
no Normal plot.
yes Plot as log scale (time/frequency axis).

title_vert_axis

Title text for vertical axis
If not specified, default text will be used
?

Example:

# Create image file from seismic display..
$IMAGE
filename ?
seismic_filename ?
temp_dir ?
properties remove
width 600
height 800
trace_spacing even
header ?
hdr_date_format none
title ?
fontsize ?
window ? ?
db no
color_bar right 30
color_bar_ann simple 0
disp_scalar ?
scale_type scalar
min_value ?
max_value ?
wiggle linear
vi_type none
pos_fill yes
neg_fill yes
var_color no
show_zero_lines yes
show_time_lines yes
time_major_inc ?
time_minor_inc ?
time_max_decimals ?
plot_direction vertical
wiggle_color_map blue_white_red
vi_color_map gray_w2b
trace_clip ?
polarity normal
log_scale no
title_vert_axis ?

INPUT (1.0)

Input OpenSeaSeis data. Reads OpenSeaSeis formatted data from disk file, file extension '.cseis'.

filename

Input file name
? Input file name.

ntraces

Number of traces to read in
Input of traces will stop when all traces have been read in, or if the number of traces specified has been reached. Traces will not be filled up to the specified range
1 Number of traces to read in.

merge

Method to merge traces from multiple input files
all
all Read in all traces of file 1, then all traces of file 2 etc.
trace Read in one trace per input file, then repeat until first file has been fully read in. Stop then..
header Merge traces from input files by header value. Assumes data has been previously sorted.. Requires header name to be specified.

header_merge

Trace header name for merged input (parameter 'order', option 'header').
? Trace header name.

nsamples (List)

Number of samples to read in
If number of samples in input data set is smaller, traces will be filled with zeros.
? Number of samples to read in.

header

Name of trace header used for trace selection
Use in combination with user parameter 'select'. NOTE: With the current Seaseis disk data format, selecting traces on input is typically slower than reading in all traces and making the trace selection later on, e.g. by using module 'SELECT'
? Trace header name.

select

Selection of header values
Only traces which fit the trace value selection will be read in. Use in combination with user parameter 'header'
? Selection string. See documentation for more detailed description of selection syntax.

sort

Sort input data traces specified in user parameter 'header' and 'select'?
no
no Do not sort input data traces.
increasing Sort input data traces by specified trace header, in increasing order.
decreasing Sort input data traces by specified trace header, in decreasing order.
simple
simple Simplest sort method. Fastest for small and partially pre-sorted data sets.
tree Tree sorting method. Most efficient for large, totally un-sorted data sets.

ntraces_buffer

Number of traces to buffer
Reading a large number of traces at once may enhance performance, but requires more memory
0 Number of traces to buffer when reading.

Example:

# Input OpenSeaSeis data
$INPUT
filename ?
ntraces 1
merge all
header_merge ?
nsamples ?
header ?
select ?
sort no simple
ntraces_buffer 0

INPUT_ASCII (1.0)

Input ASCII file. Reads seismic data from ASCII file.

filename

Input file name
? Input file name.

format

Input ASCII file format
columns
signature Read in source signature from Nucleus ASCII file.
columns Simple file format with 2 or 3 columns: Time[ms] Amplitude (Trace number). Trace number column is optional.
zmap Input grid data in ZMAP format.

sample_int

Sample interval [ms]
Set/override sample interval found in input file with this value
? Sample interval [ms].

nsamples

Number of samples in output trace
Override number of samples found in input file
? Number of samples.

unit

Unit of vertical dimension found in input file
Only required when input data is amplitude spectrum (specify 'hz')
ms
ms Milliseconds.
s seconds.
hz Hertz. Input data is amplitude spectrum, phase = 0.

phase

Phase behaviour in case input is amplitude spectrum
zero
linear Set to linear phase.
zero Set to zero phase.
1.0 Linear phase shift (scalar).

Example:

# Input ASCII file
$INPUT_ASCII
filename ?
format columns
sample_int ?
nsamples ?
unit ms
phase zero 1.0

INPUT_CREATE (1.0)

Create traces. Simple synthetic trace generator.

length

Trace length
? Length of traces.
ms
ms Milliseconds.
s Seconds.
samples Samples.
hz Hz.

ntraces

Number of traces
1 Number of traces.

sample_int

Sample interval
? Sample interval, either in [ms] or [Hz], depending on domain.

value

Constant value to set trace samples
1.0 Set trace samples to this value.

noise

Add Gaussian random noise
1.0 Maximum amplitude of random noise.

spikes

Add spikes
? List of times/frequencies (unit [ms] or [Hz]) where a spike shall be added (rest of trace is set to 0).

values

List of values corresponding to spikes
? Set each spike to the corresponding value (use parameter 'value' to set each spike to the same value).

plane_wave

Generate plane wave (spikes only)
Requires the definiton of a receiver geometry
0.0 Azimuth [deg].
0.0 Slowness [s/km].
0.0 Reference time [ms]: Time to add to computed delay time.
0.0 Origin X coordinate [m] for delay time computation.
0.0 Origin Y coordinate [m] for delay time computation.

point_source

Generate point source (spikes only)
Requires the definiton of a receiver geometry
0.0 Slowness [s/km].
0.0 Reference time [ms]: Time to add to computed travel time.
0 Geometric spreading 1/r^N.

point_source_xy

Point source location
0.0 Point source X coordinate [m].
0.0 Point source Y coordinate [m].

rec_geom

Receiver geometry definition
Specify ASCII file name containing listing of receiver XY positions
? ASCII file name. Format: rcv rec_x rec_y.

Example:

# Create traces
$INPUT_CREATE
length ? ms
ntraces 1
sample_int ?
value 1.0
noise 1.0
spikes ?
values ?
plane_wave 0.0 0.0 0.0 0.0 0.0
point_source 0.0 0.0 0
point_source_xy 0.0 0.0
rec_geom ?

INPUT_RSF (1.0)

Input data in RSF format.

filename

Input file name
? Input file name.

nsamples

Number of samples to read in
If number of samples in input data set is smaller, traces will be filled with zeros. Set 0 to set number of samples from input data set.
0 Number of samples to read in.

ntraces

Number of traces to read in
Input of traces will stop when all traces have been read in, or if the number of traces specified has been reached. Traces will not be filled up to the specified range
0 Number of traces to read in.

ntraces_buffer

Number of traces to read into buffer at once
Reading in a large number of traces at once may enhance performance, but requires more memory
20 Number of traces to buffer.

reverse_byte_order (List)

Reverse byte order of input file (endian byte swapping)
no
yes Reverse byte order of input file.
no Do not reverse byte order.

Example:

# Input data in RSF format
$INPUT_RSF
filename ?
nsamples 0
ntraces 0
ntraces_buffer 20
reverse_byte_order no

INPUT_SEGD (1.0)

Input SEGD data. Reads SEGD data from disk file.

This module does not have production-type quality. The SEG-D format has been implemented fairly thoroughly, but with a few omissions regarding certain extensions, trailers and others. However, the complexity of the format, and its sometimes unclear definition leads to many variations in the implementation of the format by various vendors. One obvious problem is the lack of a clear definition for the number of samples in a trace. Hence, some vendors generate SEG-D files with N samples, while others create SEG-D data with N+1 samples (where N is the record length divided by the sample interval). Use the user parameter 'nsamples_plus_one' to add 1 to the number of samples in the general header when needed.
By default, INPUT_SEGD only reads in seismic data channels, not auxiliary channels. To read in auxiliary channels, specify user parameter 'read_aux yes'.

filename

Input file name
? Input file name including full path name.

directory

Name of directory to search
? Name of directory. All files in this directory and its subdirectories will be read.
segd File extension. Only files with the given file extension will be read in.
no
no Do not search subdirectories.
yes Also search subdirectories for files.

dump_filename

Dump file name
? Dump file name including full path name.

chan_set

Channel set number to read in
1 Specify channel set number to read in.

nsamples_plus_one

Add 1 to number of samples computed from general header record length?
no
yes Add 1 to number of samples from general header record length. number of samples = record length / sample interval + 1.
no Do not add 1 to number of samples.

ntraces

Number of traces to read in
Input of traces will stop when all traces have been read in, or when the number of traces specified has been reached. Traces will not be filled up to the specified range
0 Number of traces to read in (0: read in all).

nrecords

Number of records to read in
Input of data will stop when the number of records specified has been reached.
0 Number of records to read in (0: read in all).

dump_hdr

Dump header
none
none Do not dump SEGD headers.
all Complete dump of all SEGD headers.
general Dump SEGD general headers.
chanset Dump SEGD chan set headers.
extended Dump SEGD extended header.
external Dump SEGD external header.
external_bird Dump SEGD external bird header.
trace Dump trace headers.

header_ens

Ensemble trace header name
Ensembles are defined by this key header
? Ensemble trace header name.

dump_essential

Dump essential headers
yes
yes Dump essential headers.
no Do not dump essential headers.

hdr_map

Specify header set
standard
standard Standard header set.
obc OBC 4C header set.

rec_system

Recording system ID name/product name
?
seal Sercel SEAL recording system.
geores Geospace GEORES recording system.

nav_header

Navigation header type
The navigation header forms the first part of the external header. If data does not read in correctly, try different nav headers, or 'none'
none
hydronav Hydronav header.
psi PSI header.
labo LABO header.
none SEGD file does not contain any nav header in the external header.

revision_0

Is this a revision 0 file?
no
yes This is a revision 0 file.
no Read revision number from general header 2.

read_aux

Read in auxiliary channels?
no
yes Read in auxiliary channels.
no Do not read in auxiliary channels.

Example:

# Input SEGD data
$INPUT_SEGD
filename ?
directory ? segd no
dump_filename ?
chan_set 1
nsamples_plus_one no
ntraces 0
nrecords 0
dump_hdr none
header_ens ?
dump_essential yes
hdr_map standard
rec_system ?
nav_header none
revision_0 no
read_aux no

INPUT_SEGY (1.0)

Input SEGY/SU data. Reads SEGY/SU data from disk file..

This module reads in disk files in SEGY format or Seismic Unix (SU) format. For SEGY, only revision 0 is fully supported. For revision 1, only some but not all features are supported. For example, there is no support for extended textual header blocks, or varying trace length and sample intervals. SU format is basically read in as SEGY rev 0 except there is no textual and binary header block. SU files are assumed to be in big endian format; if this is not true, manually swap the endian byte order with user parameter 'reverse_byte_order'. SU file data sample format is assumed to be IEEE. To read input data in SU format regardless of the (first) file's extension, specify user parameter 'su_format yes'. To read in additional trace headers named the same as in SU, specify 'hdr_map su_both'. In order to read in trace headers solely with the SU naming convention, specify 'hdr_map su_standard'

filename

Input file name
? Input file name.

directory

Name of directory to search
? Name of directory. All files in this directory and its subdirectories will be read.
segy File extension. Only files with the given file extension will be read in.
no
no Do not search subdirectories.
yes Also search subdirectories for files.

nsamples

Number of samples to read in
If number of samples in input data set is smaller, traces will be filled with zeros. Set 0 to set number of samples from input data set.
0 Number of samples to read in.
no
no Do not override number of samples in SEGY bin header.
yes Override number of samples in SEGY bin header.

sample_int

Sample interval
0.0 Sample interval [ms].

ntraces

Number of traces to read in
Input of traces will stop when all traces have been read in, or if the number of traces specified has been reached. Traces will not be filled up to the specified range
0 Number of traces to read in.

ntraces_buffer

Number of traces to read into buffer at once
Reading in a large number of traces at once may enhance performance, but requires more memory
20 Number of traces to buffer.

print

Print EBCDIC & binary header to log file
no
yes Print EBCDIC & binary header.
no Do not print EBCDIC & binary header.

dump_trchdr

Dump trace header byte block to log file
no
yes Dump trace header.
no Dump trace header.

dump_hdrmap

Dump specified trace header map (=byte locations) to log file
no
yes Dump trace header map.
no Dump trace header map.

hdr_ens

Ensemble trace header name
Ensembles are defined by this key header
? Ensemble trace header name.

hdr_map

Pre-set SEGY trace header mapping
Use option 'none' to avoid decoding any pre-set trace headers. Specify user parameter 'dump_hdrmap yes' to make a printout of the specified pre-set map
standard
standard Standard SEGY header mapping, SEGY revision 1.
none Do not use any pre-set trace header map. All trace headers that shall be extracted are given either by user parameter 'header' (non-standard trace header) or 'filename_hdrmap' (external ASCII file).
obc OBC 4C header mapping. In principle SEGY revision 1, plus additional headers.
send SEND header mapping.
armss ARMSS header mapping.
psegy PSEGY header mapping.
node Node header mapping.
node_old Node header mapping (obsolete).
su Read in Seismic Unix (SU) trace headers in Seaseis standard naming when possible. All trace headers only defined in SU will be read in with standard SU naming.
su_standard Same as option 'su', but read in all trace headers with SU standard names only. NOTE: This may cause problems with other Seaseis modules which assume standard Seaseis header naming.
su_both Read in trace headers in Seismic Unix (SU) standard naming AND in Seaseis standard naming. This means some byte locations are mapped to two identical trace headers but with different names.

filename_hdrmap

File name containing trace header map setup
All trace headers already defined in the specified pre-set trace header map at the same byte locations will be overriden. If no pre-set trace headers are required, specify user parameter 'hdr_map none'
? Input file name containing trace header map definition. File format: NAME BYTELOC TYPE_SEGY TYPE_CEIS DESC, where BYTELOC: Byte location, starting at 1 for first byte, TYPE_SEGY: Header type as stored in SEGY file, see user parameter 'header' for options, TYPE_CSEIS: Header type of Seaseis trace header, see user parameter 'header' for options, NAME: Trace header name, DESC: Description of Seaseis trace header, enclosed in double-quotes..

header

Set user specified header byte location etc
? Trace header name.
1 Byte location (starting at 1).
int
int Integer (4 byte).
short Short (2 byte).
ushort Unsigned short (2 byte).
float Float (4 byte).
4 Integer (4 byte). ...for backward compatibility.
2 Short (2 byte). ...for backward compatibility.
This is the number type in which the trace header is stored/formatted in the input file's trace header.
int
int Integer.
float Single precision floating point.
double Double precision floating point.
This is the number type of the Seaseis output trace header.
? Header description. Descriptive text for Seaseis trace header.

hdr_duplicate

How to treat user specified trace headers (parameter 'header') that are already defined in the chosen trace header map
override
override Write header to user specified byte location only, i.e. override standard byte location.
abort Abort if user specified header is already defined in trace header map.

auto_scale

Automatically scale SEGY headers
Automatically scale SEGY headers using SEGY scalar values found at standard byte positions, e.g. src xy and rcv xy header values
yes
yes Automatically scale header values.
no Do not apply scaler..

reverse_byte_order

Reverse byte order of input file (endian byte swapping)
Setting this to 'yes' means that the input SEGY file is in the wrong byte order
no
yes Reverse byte order of input file for binary and trace headers.
no Do not reverse byte order for binary & trace headers.
no
yes Reverse byte order of input file for data samples.
no Do not reverse byte order for data samples.

data_format

Override SEGY data sample format (given in binary header)
auto
auto Automatically read data sample format from binary header.
ibm 4 byte IBM floating point.
ieee 4 byte IEEE floating point.

charhdr_format

Format of char header
ebcdic
ebcdic EBCDIC.
ascii ASCII.

su_format

Is input data in SU (Seismic Unix) format?
Use this parameter to override the default format which is determined by the (first) file's extension: *.su or *.SU == SU file
no
yes Force input data to be read in as SU format, independent of file extension.
no Force input data to be read in as SEGY format, independent of file extension.

header_select

Name of trace header used for trace selection
Use in combination with user parameter 'select'. NOTE: With the current Seaseis disk data format, selecting traces on input is typically slower than reading in all traces and making the trace selection later on, e.g. by using module 'SELECT'
? Trace header name.

select

Selection of header values
Only traces which fit the trace value selection will be read in. Use in combination with user parameter 'header'
? Selection string. See documentation for more detailed description of selection syntax.

sort

Sort input data traces specified in user parameter 'header' and 'select'?
no
no Do not sort input data traces.
increasing Sort input data traces by specified trace header, in increasing order.
decreasing Sort input data traces by specified trace header, in decreasing order.
simple
simple Simplest sort method. Fastest for small and partially pre-sorted data sets.
tree Tree sorting method. Most efficient for large, totally un-sorted data sets.

Example:

# Input SEGY/SU data
$INPUT_SEGY
filename ?
directory ? segy no
nsamples 0 no
sample_int 0.0
ntraces 0
ntraces_buffer 20
print no
dump_trchdr no
dump_hdrmap no
hdr_ens ?
hdr_map standard
filename_hdrmap ?
header ? 1 int int ?
hdr_duplicate override
auto_scale yes
reverse_byte_order no no
data_format auto
charhdr_format ebcdic
su_format no
header_select ?
select ?
sort no simple

INPUT_SINEWAVE (1.0)

Create traces with sine waves. This module was converted from a publically available ProMAX demo module.

pkeynam

Primary key name
source
source Create shot gathers.
cdp Create CDP gathers.

nens

Number of trace ensembles to generate
1 Number of trace ensembles to generate.

ntraces

Number of traces per ensemble
100 Number of traces per ensemble.

tracelen

Trace length for the sinewaveetic traces [ms]
1000 Trace length for the sinewaveetic traces [ms].

sample_int

Sample interval [ms]
2 Sample interval [ms].

spikes (List)

List of spike times
? List of spike times (spikes of amplitude 1.0).

freq (List)

List of frequencies [Hz]
? List of frequencies [Hz].

phase (List)

List of phases [deg]
? List of phases [deg].

Example:

# Create traces with sine waves
$INPUT_SINEWAVE
pkeynam source
nens 1
ntraces 100
tracelen 1000
sample_int 2
spikes ?
freq ?
phase ?

KILL (1.0)

Kill traces. Kill traces that match specified header selection.

header (List)

Names of trace headers used for trace selection
? Trace header name.

select (List)

Selection of header values
? List of selection strings, one for each specified header. See documentation for more detailed description of selection syntax.

mode

Mode of selection
include
include Kill traces matching the specified selection criteria.
exclude Kill traces NOT matching the specified selection criteria.

zero_traces

Kill zero traces
no
no Do not kill zero traces.
yes Kill zero traces.
one Kill traces that contains at least one zero.

Example:

# Kill traces
$KILL
header ?
select ?
mode include
zero_traces no

KILL_ENS (1.0)

Kill ensembles. Kill ensembles that have the specified number of traces.

select (List)

Selection of number of traces
? Selection string. For example: <4 : Kill ensembles with less than 4 traces. See documentation for more detailed description of selection syntax..

mode

Mode of selection
include
include Kill ensembles matching the specified selection criteria.
exclude Kill ensembles NOT matching the specified selection criteria.

Example:

# Kill ensembles
$KILL_ENS
select ?
mode include

LMO (1.0)

Linear moveout correction (NOT IMPLEMENTED YET). ...in the widest sense (also called HMO as in 'hyperbolic moveout')..

Example:

# Linear moveout correction (NOT IMPLEMENTED YET)
$LMO

MIRROR (1.0)

Perform mirror image binning. Sets trace headers bin_x, bin_y, and bin_z.

NOTE: The input bathymetry table, if specified, must contain three columns giving XYZ coordinates. The bathymetry table must be given as a regular 2D grid, in Seaseis table format: First line must define @x @y depth (two table 'keys' x and y, and one 'value', i.e. depth)

method

Binning method
obs_mirror
obs_mirror OBS mirror image binning: Set bin centre at seabed reflection point of first water bottom multiple..

table

Table containing water depths (bathymetry)
? File name of Seaseis table. The table must have at least three columns, the first two giving X and Y coordinates [m], and the third giving the depth [m]. The bathymetry table must be binned to a regular grid in North-South direction.

const_depth

Use constant water depth
If a constant water depth is specified, all parameters relating to an input bathymetry table are not used
? Constant water depth [m].

resolution

Resolution of 2D bathymetry profile used in 'ray tracing' algorithm
500 Distance between knee points extracted from bathymetry table [m].

target_diff

Termination threshold for 'ray tracing'. Iterative search terminates when a ray is found that hits the target point within the specified accuracy
When not specified, 2x source depth is used as the termination threshold
? Maximum distance to target point [m]. Iteration ends when ray is found that hits the target point within the specified distance.

Example:

# Perform mirror image binning
$MIRROR
method obs_mirror
table ?
const_depth ?
resolution 500
target_diff ?

MUTE (1.0)

Mute trace data.

mode

Front mute or end mute
front
front Front mute. Specify time of first unmuted sample.. Samples are muted from 0ms to specified time.
end End mute. Specify time of last unmuted sample.. Samples are muted from specified time to the end of the trace.

table

Mute table
? Mute table file, full path.. The mute table must have at least two columns, one giving a key and the second giving the mute time in [ms].

time

Mute time [ms]
? Mute time [ms].

taper_len

Taper length [ms]
0 Mute taper length [ms].

taper_type

Type of mute taper
linear
linear Apply linear taper.
cos Apply cosine taper.

kill

Kill zero traces?
no
no Kill zero traces.
yes Do not kill zero traces.

indicate

Do not mute, indicate mute time by setting samples to the given value
Input data will not be muted. Instead, spikes are placed at the mute times, with the given amplitude.
0 Value that mute samples are set to..
1 Width in samples to indicate with given value..

Example:

# Mute trace data
$MUTE
mode front
table ?
time ?
taper_len 0
taper_type linear
kill no
indicate 0 1

NMO (1.0)

Perform NMO (normal moveout) correction.

wave_mode

Mode of wave to model
pp_iso
pp_iso Isotropic PP mode (downgoing P, upgoing P).
ps_iso Isotropic PS mode (downgoing P, upgoing S).

table

Velocity table
? Velocity table file name.. Velocity table format: The first line must contain a header title giving the names of all columns (space separated). The remaining lines give the data values. Key headers are specified in the front with a preceding '@' sign. The column specifying the time in milliseconds must be named 'time'. The last column must contain a velocity in m/s. It doesn't matter what name is chosen for the velocity column, unit is meters/second [m/s]. Example: '@source time velocity'. The table does not need to contain a key trace header name; Example: 'time velocity'..

time (List)

List of time value [ms]
Time knee points at which specified velocities apply
? List of time values [ms]..

velocity (List)

List of velocities [m/s]
Velocities values at specified time knee points. In between time knee points, velocities will be linearly interpolated.
? List of velocities [m/s]....

mode

Mode of NMO application
apply
apply Apply NMO..
remove Remove NMO..

empirical

Empirical 'NMO' function
Empirical NMO is a residual NMO, to be applied after initial NMO or LMO. Best scan for the two parameters to find out their effect on the data
4000 Offset apex [m].
5 Zero-offset damping (High value: high damping, 0: No damping).

horizon_nmo

Apply horizon based NMO?
no
no Do not apply horizon based NMO.
yes Apply horizon based NMO.
linear
linear Use linear interpolation method.
quadratic Use quadratic interpolation method.

Example:

# Perform NMO (normal moveout) correction
$NMO
wave_mode pp_iso
table ?
time ?
velocity ?
mode apply
empirical 4000 5
horizon_nmo no linear

OFF2ANGLE (1.0)

Offset to angle transform (DEFUNCT MODULE). Transform seismic gather to regular trace interval of constant angle of incidence at seabed.

angle

Setup of output angle bands
0 First angle band [deg].
50 Last angle band [deg].
10 Angle band increment [deg].
0 Width of each angle band [deg].

Example:

# Offset to angle transform (DEFUNCT MODULE)
$OFF2ANGLE
angle 0 50 10 0

ORIENT (1.0)

Solve sensor orientation. Derive sensor orientation angles from input XYZ vector, computed by module $HODOGRAM.

input

Input data
Specifies what type of input data is expected in this module
xyz
xyz 3 sequential input traces, containing sensors 3(X), 4(Y) and 5(Z). Sorting of these three may be arbitrary..
xyzp 4 sequential input traces, containing sensors 3(X), 4(Y) and 5(Z), and 4th trace with sensor 1(hydrophone). Sorting of these three may be arbitrary..
ensemble Input whole ensemble (user sorted). Each input ensemble must contain one trace each for sensor 3(X), 4(Y) and 5(Z). Sorting of these three may be arbitrary..

compute_tilt_roll

Compute tilt & roll angles?
no
no Do not compute tilt & roll angles..
yes Compute roll & tilt angles..
an_tilt Output trace header name for tilt angle [deg].
an_roll Output trace header name for roll angle [deg].

compute_tilt_xy

Compute tilt X & tilt Y angles?
no
no Do not compute tilt X and tilt Y angles..
yes Compute tilt X and tilt Y angles..
an_tiltx Output trace header name for tilt X angle [deg].
an_tilty Output trace header name for tilt Y angle [deg].

compute_azim

Compute azimuth angle?
Usually, this is the positive X sensor direction
no
no Do not compute azimuth angle..
yes Compute azimuth angle..
an_azim Output trace header name for azimuth angle [deg].

hdr_azim

Trace header containing azimuth (= positive X direction)
an_azim Trace header name containing azimuth / sensor X direction [deg].

output

Specify what traces shall be output by this module
all
all Output all traces that were input to this module..
last Only output last trace..

inline_dip

Seabed dip in inline direction
0.0 Seabed inline dip [deg].

xline_dip

Seabed dip in xline direction
0.0 Seabed xline dip [deg].

advanced

Advanced options?
no
yes Use advanced options..
no Do not use advanced options..

acquisition_mode

Acquisition mode
obc
obc OBC acquisition mode. Sources are above receivers..
land Land acquisition mode. Sources are beneath receivers..

v1v2_ratio

V1/V2 ratio at seabed (v1: water vel, v2: seabed vel)
1.0 V1/V2 velocity ratio at seabed.

Example:

# Solve sensor orientation
$ORIENT
input xyz
compute_tilt_roll no an_tilt an_roll
compute_tilt_xy no an_tiltx an_tilty
compute_azim no an_azim
hdr_azim an_azim
output all
inline_dip 0.0
xline_dip 0.0
advanced no
acquisition_mode obc
v1v2_ratio 1.0

ORIENT_CONVERT (1.0)

Convert sensor orientation parameters. Applies some process to trace headers dealing with sensor orientation.

input

Input data
Specifies what type of input data is expected in this module
xyz
xyz 3 sequential input traces, containing sensors 3(X), 4(Y) and 5(Z). Sorting of these three may be arbitrary..
xyzp 4 sequential input traces, containing sensors 3(X), 4(Y) and 5(Z), and 4th trace with sensor 1(hydrophone). Sorting of these three may be arbitrary..
ensemble Input whole ensemble (user sorted). Each input ensemble must contain one trace each for sensor 3(X), 4(Y) and 5(Z). Sorting of these three may be arbitrary..

method (List)


Time knee points at which specified scalars apply
?
tiltroll_2_icv Convert roll and tilt angles into ICV inclinometer values.. Required input headers: an_roll, an_tilt.
icv_2_tiltroll Convert ICV inclinometer values into roll and tilt angles.. Required input headers: incl_i, incl_c, incl_v.
armss Convert ARMSS accelerometer values into (ARMSS) roll and tilt angles.. Required input headers: ain1, ain2, ain3.

Example:

# Convert sensor orientation parameters
$ORIENT_CONVERT
input xyz
method ?

OUTPUT (1.0)

Output OpenSeaSeis data. Writes OpenSeaSeis formatted data to disk file, file extension '.cseis'.

filename

Output file name
? Output file name.

ntraces_buffer

Number of traces to buffer before write operation
Writing a large number of traces at once enhances performance, but requires more memory
20 Number of traces to buffer before writing.

overwrite

Overwrite exisiting file?
yes
yes Overwrite file if it already exists.
no Do not overwrite file if it already exists.

compress

Compress data before output?
no
no No compression. Save data samples as 32bit floating point.
32bit No compression. Same as option 'no'.
16bit Compress data samples to 16bit.
8bit Compress data samples to 8bit.

Example:

# Output OpenSeaSeis data
$OUTPUT
filename ?
ntraces_buffer 20
overwrite yes
compress no

OUTPUT_RSF (1.0)

Output data in RSF format.

filename

Output file name
? Output file name.

hdr_dim2

Trace header defining dimension 2
? Name of trace header defining dimension 2.

hdr_dim3

Trace header defining dimension 3
? Name of trace header defining dimension 3.

world_p1

Grid definition: World point 1
? X coordinate.
? Y coordinate.
? Inline number.
? Crossline number.

world_p2

Grid definition: World point 2
? X coordinate.
? Y coordinate.
? Inline number.
? Crossline number.

world_p3

Grid definition: World point 3
? X coordinate.
? Y coordinate.
? Inline number.
? Crossline number.

ild_xld

Grid definition: Bin/cell size
? ild: Bin/cell size in inline/row direction [m].
? xld: Bin/cell size in crossline/col direction [m].

data_format

Outyput format for data samples
native_float
native_float Use native 32-byte floating point format.

ntraces_buffer

Number of traces to buffer before write operation
Writing a large number of traces at once enhances performance, but requires more memory
20 Number of traces to buffer before writing.

reverse_byte_order

Reverse byte order in output file (endian byte swapping)
Setting this to 'yes' means that the output file will be written in Little endian byte order
no
yes Reverse byte order for output file.
no Do not reverse byte order.

tolerance

Tolerance value
The tolerance is used to check dimension 2 and 3 trace header values
1e-5 Any difference between nominal and actual header values above the given tolerance will terminate the program.

output_grid

Output grid definition?
By default, grid definition is only output if three world points have been specified
no
yes Write grid definition to output file.
no Do not output grid definition to output file.

Example:

# Output data in RSF format
$OUTPUT_RSF
filename ?
hdr_dim2 ?
hdr_dim3 ?
world_p1 ? ? ? ?
world_p2 ? ? ? ?
world_p3 ? ? ? ?
ild_xld ? ?
data_format native_float
ntraces_buffer 20
reverse_byte_order no
tolerance 1e-5
output_grid no

OUTPUT_SEGY (1.0)

Output SEGY/SU data. Writes SEGY or Seismic Unix (SU) data to disk file.

filename

Output file name
? Output file name.

auto_scale

Automatically scale SEGY headers. This applies to standard coordinate, elevation, and statics trace headers
Automatically scale SEGY headers and save SEGY scalar values at standard byte positions.
yes
yes Automatically scale trace header values before writing to output file.
no Do not apply any scalars. Coordinates, elevations and statics values are written to output file as-is, scalars are set to 1..

hdr_map

Pre-set SEGY trace header mapping
Use option 'none' to avoid encoding any pre-set trace headers. Specify user parameter 'dump_hdrmap yes' to make a printout of the specified pre-set map
standard
standard Standard SEGY header mapping, SEGY revision 1.
none Do not use any pre-set trace header map. All SEGY trace headers that shall be encoded are given either by user parameter 'header' (non-standard trace header) or 'filename_hdrmap' (external ASCII file).
obc OBC 4C header mapping. In principle SEGY revision 1, plus additional headers.
send SEND header mapping.
armss ARMSS header mapping.
psegy PSEGY header mapping.
node Node header mapping.
node_old Node header mapping (obsolete).
su Seismic Unix (SU) header mapping.
su_standard Same as option 'su', but assume all trace headers exist only with SU standard naming, not Seaseis standard naming.

filename_hdrmap

File name containing trace header map setup
All trace headers already defined in the specified pre-set trace header map at the same byte locations will be overriden. If no pre-set trace headers are required, specify user parameter 'hdr_map none'
? Input file name containing trace header map definition. File format: BYTELOC TYPE_SEGY TYPE_CEIS NAME DESC, where BYTELOC: Byte location, starting at 1 for first byte, TYPE_SEGY: Header type as stored in SEGY file, see user parameter 'header' for options, TYPE_CSEIS: Header type of Seaseis trace header, see user parameter 'header' for options, NAME: Trace header name, DESC: Description of Seaseis trace header, enclosed in double-quotes..

header

Set user specified SEGY trace headers
? Trace header name.
1 Byte location (starting at 1).
int
int Integer (4 byte).
short Short (2 byte).
ushort Unsigned short (2 byte).
4 Integer (4 byte). ...for backward compatibility.
2 Short (2 byte). ...for backward compatibility.
This is the number type in which the trace header is stored/formatted in the output file's trace header.

data_format

Floating point format for data samples
ieee
ieee Use 32-byte IEEE floating point format.
ibm Use 32-byte IBM floating point format.

hdr_mandatory

How to treat mandatory SEGY trace headers
Mandatory SEGY trace headers are: data_type, trc_type, nsamp, sampint_us, scalar_coord, scalar_elev, scalar_stat, fold, fold_vert. Each of these can be set by a) Using a default value, b) Creating an CSEIS header with this name before OUTPUT_SEGY, c) Setting a header manually in one of the user parameters below
default
default Set all mandatory trace headers to default values, except for those that are manually specified in one of the according user parameters below.
header If mandatory trace header exists in input data, use it to override default value. Otherwise use default. Manually specified value overrides all.

scalar_coord

SEGY 'coordinate scalar'. All SEGY standard coordinates will be scaled by this value
Note that the given value will be stored as -value in the SEGY trace header, in accordance to the SEGY definition, in order to enable inverse scaling when reading this file
100 Scalar to be applied to all SEGY standard coordinate headers.

scalar_elev

SEGY 'elevation scalar'. All SEGY standard elevations will be scaled by this value
See scalar_coord for further information.
10 Scalar to be applied to all SEGY standard elevation headers.

scalar_stat

SEGY 'static scalar'. All SEGY standard statics will be scaled by this value
See scalar_coord for further information.
1 Scalar to be applied to all SEGY standard statics headers.

fold

Set SEGY 'fold' trace header for all traces
1 SEGY 'fold' header.

fold_vert

Set SEGY 'vertical fold' trace header for all traces
1 SEGY 'vertical fold' header.

data_type

Set SEGY 'data type' trace header for all traces
1 SEGY 'data type' header.

trc_type

Set SEGY 'trace type' trace header for all traces
1 SEGY 'trace type' header.

hdr_duplicate

How to treat user specified trace headers (parameter 'header') that are already defined in the chosen trace header map
override
override Write header to user specified byte location only, i.e. override standard byte location.
abort Abort if user specified header is already defined in trace header map.

hdr_missing

How to deal with missing SEGY trace headers that are not defined in input data
ignore
ignore Ignore missing trace headers. Set to default value (usually 0).
abort Abort flow when trace headers required by the specified trace header map are missing in input data..

charhdr

80 characters for SEGY 3200-byte character header
Specify up to 40 lines
C00 Line 00 for SEGY 3200-byte character header.

bin_jobid

Job ID, set in binary header
0 Job ID.

bin_linenum

Line number, set in binary header
0 Line number.

bin_reelnum

Reel number, set in binary header
0 Reel number.

bin_ntraces

Number of traces, set in binary header
1 Number of traces.

dump_hdrmap

Dump specified trace header map (=byte locations) to log file
no
yes Dump trace header map.
no Dump trace header map.

ntraces_buffer

Number of traces to buffer before write operation
Writing a large number of traces at once enhances performance, but requires more memory
20 Number of traces to buffer before writing.

reverse_byte_order

Reverse byte order in output file (endian byte swapping)
Setting this to 'yes' means that the output SEGY file will be written in Little endian byte order
no
yes Reverse byte order for output file.
no Do not reverse byte order.

force

Force writing file
no
yes Force writing SEGY output file.
no Abort if output SEGY would become inconsistent.

su_format

Write output data in SU (Seismic Unix) format?
Use this parameter to override the default format which is determined by the (first) file's extension: *.su or *.SU == SU file
no
yes Force output data to be written in SU format, independent of file extension.
no Force output data to be written in SEGY format, independent of file extension.

Example:

# Output SEGY/SU data
$OUTPUT_SEGY
filename ?
auto_scale yes
hdr_map standard
filename_hdrmap ?
header ? 1 int
data_format ieee
hdr_mandatory default
scalar_coord 100
scalar_elev 10
scalar_stat 1
fold 1
fold_vert 1
data_type 1
trc_type 1
hdr_duplicate override
hdr_missing ignore
charhdr C00
bin_jobid 0
bin_linenum 0
bin_reelnum 0
bin_ntraces 1
dump_hdrmap no
ntraces_buffer 20
reverse_byte_order no
force no
su_format no

OVERLAP (1.0)

Create data overlap between adjacent traces. Duplicates data from adjacent traces and pads it at start and end of trace.

overlap

Size of overlap [ms]
? Size of overlap [ms]. Data of length 'overlap'ms from adjacent traces is added to start and end of trace.

absolute_time

Acknowledge absolute time?
yes
yes Absolute time is acknowledged. No overlap will be created from adjacent traces that do not have adjacent absolute time stamps.
no Absolute time is not acknowledged. Overlap will be created for all adjacent traces.

Example:

# Create data overlap between adjacent traces
$OVERLAP
overlap ?
absolute_time yes

PICKING (1.0)

Pick first breaks or other event.

domain

Time or sample domain
time
time Window is specified in time [ms].
sample Window is specified in samples (1 for first sample).

start

Start time/sample
Start time or sample, this depends on the 'domain' setting
0 Start time/sample of picking window.

end

End time/sample
? End time/sample of picking window.

method

Picking method
peak_trough
peak_trough Pick a peak or trough. Search for first sample value that exceeds the specified +/- threshold..
zero_crossing Pick last zero-crossing before specified peak/trough (STILL EXPERIMENTAL).
value Pick sample time at first occurence of specific value. Specify value to be picked with user parameter 'thresh'.

search_mode

Search mode
max
max Pick maximum value in specified time window (honoring the specified polarity)..
first Pick first value in specified time window that exceeds the given threshold (honoring the specified polarity)..

thresh

Threshold value. Peak/trough will only be searched when exceeding threshold
? Threshold value. Can be positive (pick peak) or negative (pick trough).
0 Tolerance (+/-). Only used for method 'value'.

header

Header where picked time is stored
time_pick Name of trace header where picked time is stored.
amp_pick Name of trace header where picked amplitude is stored (only for method 'peak_trough').

force_pick

Enforce user specified start/end window
yes
yes Picked value is forced to be inside the user specified window.
no Picked value may be sligthly outside user specified window. This may happen if the nearest interpolated maximum (or zero crossing..) of the time pick falls outside of the specified window.

xcross

Guide first break picking by cross-correlation of adjacent traces
For this method, input data is read in in ensemble order. In each ensemble, consecutive traces are cross-correlated to guide the time picking
0 Threshold time/sample. Depends on 'domain' setting.
absolute
absolute If the time pick difference between two consecutive traces differs from the time shift determined by cross-correlation by more than the specified threshold, use the cross-correlation value instead.
relative If the time pick difference between two consecutive traces exceeds the specified threshold, use the cross-correlation value instead.

xcross_win

Window for cross-corrrelation
Consecutive traces are cross-correlated in the specified window, to find relative time shift
0 Start time/sample of picking window. Depends on the 'domain' setting. Set to 0 to use same window as for picker.
0 End time/sample of picking window. Depends on the 'domain' setting. Set to 0 to use same window as for picker.

xcross_output

Output cross-correlation function?
no
no Do not output cross-correlation function.
yes Overwrite input data with cross-correlation function. Set unused samples to zero.

Example:

# Pick first breaks or other event
$PICKING
domain time
start 0
end ?
method peak_trough
search_mode max
thresh ? 0
header time_pick amp_pick
force_pick yes
xcross 0 absolute
xcross_win 0 0
xcross_output no

POSCALC (1.0)

Compute receiver position from time picks.

verbose

Print diagnostic output
no
yes yes.
no No.

timedelay

Known time delay on input traces
0 Constant time delay.

num_unknowns

Number of unknowns to solve for
3 Number of unknowns in inversion: X(1), Y(2), Z(3), time shift(4), velocity(5).

velocity

Water velocity
? Water velocity [m/s]. Alternatively, specify trace header name containing water velocity. Velocity will be read in from first input trace.

maxobs

Maximum number of observations (=traces) in ensemble
Required for pre-allocation purposes
? Maximum number of observations (=traces) in ensemble.

sou_z

Source depth [m]
If source depth is not specified it will be read in from trace header 'sou_z'
? Source depth [m].

header

Header where picked time is stored
time_pick Name of trace header where picked time is stored.

hdr_ens

Ensemble header (to be used for printout)
? Ensemble header (to be used for printout).

domain

Specify which side shall be solved: Receiver or source domain
receiver
receiver Solve for receiver XYZ.
source Solve for source XYZ.

Example:

# Compute receiver position from time picks
$POSCALC
verbose no
timedelay 0
num_unknowns 3
velocity ?
maxobs ?
sou_z ?
header time_pick
hdr_ens ?
domain receiver

PZ_SUM (1.0)

PZ combination (STILL EXPERIMENTAL). Combine P and Z trace pair. The combined output trace will keep all trace headers from the P trace.

Required input: Pairs of P and Z traces. Required trace headers in input data: sensor, rec_z

method

PZ combination method
sum
sum Sum P and Z traces in x-t domain, sample by sample..
subtract Subtract P and Z traces in x-t domain, sample by sample..
zero Zero samples of opposite polarity..

window_length

Length of sliding time window [ms]
500.0 Length of sliding time window [ms] in which normalization factor is computed.

start_time

Start time of analysis window [ms]
0.0 Start time of analysis window [ms].

end_time

End time of analysis window [ms]
0.0 End time of analysis window [ms].

percent

Percentage of normalization
0 How much normalization shall be done [%]? 0%: No normalization, 100%: Full normalization, scale Z trace by normalization factor.

equalize

Equalize RMS amplitudes between P & Z trace before summation
yes
yes Perform full trace equalization on Z trace before summation..
no Do not equalize Z trace before summation..

Example:

# PZ combination (STILL EXPERIMENTAL)
$PZ_SUM
method sum
window_length 500.0
start_time 0.0
end_time 0.0
percent 0
equalize yes

RAY2D (1.0)

2D isotropic ray tracer.

This module computes travel times using a 2D isotropic, dynamic ray tracer, and applies travel time corrections to the data, equivalent to a horizon based normal moveout correction. The ray tracer can be supplied with an almost arbitrarily complex 2D model. It is based on Psencik's SEIS88, with 2d wavefront construction on top of it. The module is rather difficult to set up since the code was barely made to work from old Fortran 77 code. The following example should help:

$INPUT_CREATE
ntraces 120
length 5000
sample_int 2
value 0.0

$HDR_MATH
new rec_x
new sou_x
equation rec_x "trcno*50.0"
equation sou_x "0.0"

$RAY2D
seismogram 20 dynamic
gather source
model_type 1d vs
max_offset 8000
dt_ray 40
spread_dist 20
spread_angle 2.3
nrays 400
rec_x rec_x
rec_z 1620
rec_loc 2 2
sou_x sou_x
sou_z 10
sou_loc 1
int1d 1 0
int1d 2 1620
int1d 3 1780
int1d 4 2100
int1d 5 3300
layer 1 1475 1
layer 2 1500 200
layer 3 1670 280
layer 4 2040 600
layer 5 3500 1400
# P-wave ray paths (P-wave: Positive layer numbers, S-wave: Negative layer numbers)
ray_code 1 2 2
ray_code 1 2 3 3 2

$OUTPUT
filename test_ray2d.cseis

gather

Type of input trace gather/ensemble
receiver
receiver Input ensemble is a receiver gather.
source Input ensemble is a source gather.

model_type

Type of model
1d
1d Specify 1D model. Each interface is defined by its depth and layer properties (user parameter 'model1d')..
2d Specify 2D model. Each interface is defined by at least one 2D point (XZ coordinate, user parameter 'int2d'), and local 1D layer properties.
vs
vs Specify model S-wave velocity at the top of the layer (will be converted internally into vp/vs ratio that is constant for this layer).
vpvs Specify model S-wave velocity indirectly as a constant vp/vs ratio.

rec_x

Receiver X coordinate
? Value or trace header name for receiver X coordinate [m].

rec_z

Receiver Z coordinate
? Value or trace header name for receiver Z coordinate [m].

sou_x

Source X coordinate
? Value or trace header name for source X coordinate [m].

sou_z

Source Z coordinate
? Value or trace header name for source Z coordinate [m].

sou_loc

Source location
1 Layer in which source is located.
0 Interface on which source is located (if any).

rec_loc

Receiver location
2 Layer in which receiver is located.
2 Interface on which receiver is located (if any).

apply_nmo

Apply ray-traced normal moveout correction?
no
no Do not apply NMO.
time Apply NMO, output zero-offset time [ms].
depth Apply NMO, output depth [m].

seismogram

Generate seismogram by adding Ricker wavelet to input traces at ray-traced travel times
? Peak frequency [Hz] of Ricker wavelet.
dynamic
dynamic Generate seismogram including amplitude/phase correction.
kinematic Generate seismogram with constant wavelet.

ray_code (List)

Ray code definition
? List of ray codes defining one ray path from source to receiver.

max_offset

Define maximum source-receiver offset for 1D model
10000 Maximum source-receiver offset [m] in case of 1D model.

int1d

Define 1D model interface
Repeat this parameter for each model interface.
1 Number of interface. First interface = 1.
? Depth of interface [m].

int2d

Define one point of one 2D model interface
1 Number of interface. First interface = 1.
? X coordinate [m].
? Z coordinate [m].
0 Optional: Point flag. 0 for continuous interface point, -1 for discontinuous. Corner points are automatically set to -1.

layer

Define local 1D layer properties
Repeat this parameter for each model layer. Layer numbers refer to top interface. The model bottom interface does not require layer properties
1 Number of layer. First layer = 1.
? P-wave velocity at top of layer [m/s].
? Vp/Vs velocity ratio, or S-wave velocity at top of layer [m/s], see user parameter 'model_type'.
1.0 Density (=rho1).
0.0 Density coefficient (=rho2). Density is computed as rho = rho1 + vp*rho2.
0.0 Optional: P-wave velocity at bottom of layer [m/s]. If specified, P-wave velocity function is a vertical gradient. If not specified, layer P-wave velocity is set constant.

dt_ray

Ray propagation time interval
40 Time interval [ms].

spread_dist

Maximum spreading distance between rays before new ray is interpolated
60 Maximum spreading distance [m].

spread_angle

Maximum spreading angle between rays before new ray is interpolated
2.3 Maximum spreading angle [deg].

nrays

Number of rays starting from the source
400

beam

Definition of beam of rays departing from source location
Starting rays are equally spaced inside the beam
0.0 Start angle [deg].
180.0 End angle [deg].

dump_model

Dump model into ASCII file
? Output ASCII file.

Example:

# 2D isotropic ray tracer
$RAY2D
gather receiver
model_type 1d vs
rec_x ?
rec_z ?
sou_x ?
sou_z ?
sou_loc 1 0
rec_loc 2 2
apply_nmo no
seismogram ? dynamic
ray_code ?
max_offset 10000
int1d 1 ?
int2d 1 ? ? 0
layer 1 ? ? 1.0 0.0 0.0
dt_ray 40
spread_dist 60
spread_angle 2.3
nrays 400
beam 0.0 180.0
dump_model ?

READ_ASCII (1.0)

Read trace header values from ASCII file.

filename

Input file name
? Input file name.

method

Method to specify header locations in ASCII file
columns
columns Location of key/header values is given by column number. Columns are separated by white spaces.
positions Location of key/header values is given by character positions from the start of each line. First character in input line is at position 1.

key

Key trace header used to match specified trace header values
? Trace header name of key header.
? Column number/Start position. Depends on setting for user parameter 'method'.
? Length. Only used for method 'positions'.

header

Trace header to be read in
? Trace header name.
? Column number/Start position. Depends on setting for user parameter 'method'.
? Length. Only used for method 'positions'.

ignore_line

Ignore lines starting with specified characters
? Ignore lines starting with specified characters.

select_line

Select lines starting with specified characters
? Select only lines starting with the specified characters.

key_sps_time

Use time (precision = 1s) as the key
Time in the ASCII file is expected in SPS format (dddhhmmss)
? Trace header containing time in UNIX seconds [s] (for example time_samp1).
? Column number/Start position. Depends on setting of user parameter METHOD.
? Length. Only used for method 'positions'.

key_sps_time_us (List)

..to be used in conjunction with parameter 'key_sps_time'. Increase precision of match to microseconds
Time in the ASCII file is expected in EXTENDED SPS format (dddhhmmss.uuuuuu)
? Trace header containing shot time microsecond [us] fraction (for example time_samp1_us).

time_year

Year. Required in case a 'time' key is used.
? Year, e.g. 2009..

warnings

Show warnings?
no
yes Show warnings.
no Do not show warnings.

check

Check input file for consistency?
no
yes Check input file for consistency.
no Do not perform consistency check..

sort

Sort key values from input ASCII file?
yes
yes Sort key values in input ASCII file.
no Do not sort key values. WARNING: This assumes key values are already sorted on input, otherwise the method will not work.

drop_traces

Drop unmatched traces?
no
yes Drop traces for which no match could be found in input ASCII file.
no Do not drop unmatched traces.

Example:

# Read trace header values from ASCII file
$READ_ASCII
filename ?
method columns
key ? ? ?
header ? ? ?
ignore_line ?
select_line ?
key_sps_time ? ? ?
key_sps_time_us ?
time_year ?
warnings no
check no
sort yes
drop_traces no

REPEAT (1.0)

Repeat/duplicate traces. Copy traces and all trace headers. Set new trace header called 'repeat'.

mode

Mode of operation
?
ensemble Repeat whole ensemble.
trace Repeat individual trace.
all Repeat all traces.

repeat

Total number of output traces
2

Example:

# Repeat/duplicate traces
$REPEAT
mode ?
repeat 2

RESAMPLE (1.0)

Resample trace to different sample interval (LIMITED FUNCTIONALITY!).

sample_int

New sample interval [ms]
? Sample interval [ms].

debias

Remove DC bias before resampling?
no
yes Remove DC bias before resampling, reapply afterwards.. This should be done to avoid FFT related artefacts due to DC bias.
no Do not remove DC bias before resampling..

order

Filter 'order'
The filter 'order' defines the steepness of the filter taper. The higher the order, the shorter the taper.
10 Filter order (1-100).

cutoff

Cut-off (-3db) frequency
0.8 Cut-off frequency, given as ratio of Nyquist (0.0-1.0). For example: 0.9 --> cut-off frequency is 90% of Nyquist.

Example:

# Resample trace to different sample interval (LIMITED FUNCTIONALITY!)
$RESAMPLE
sample_int ?
debias no
order 10
cutoff 0.8

RESEQUENCE (1.0)

Resequence trace header. Reset a trace header to increasing (or decreasing) values for each trace group or ensemble.

header

Name of trace header to resequence
? Trace header name.

set

Value to set trace header to.
1 Start value.
1 Value increment. Amount by which value is incremented for each consecutive trace.
0 Group increment. Amount by which value is incremented for each consecutive trace group or ensemble.

mode

Mode of resequencing
all
ensemble Resequence inside each ensemble.
all Resequence all traces.
fixed Resequence fixed number of traces (specified in 'ntraces').

ntraces

Number of consecutive traces to resequence
? Number of traces.

Example:

# Resequence trace header
$RESEQUENCE
header ?
set 1 1 0
mode all
ntraces ?

RMS (1.0)

Compute RMS value in given time window. Computed RMS value is stored in trace header 'rms'.

domain

Time or sample domain
time
time Window is specified in time [ms] (or frequency [Hz]).
sample Window is specified in samples (1 for first sample).

start

Start time/sample
Start time or sample, this depends on the 'domain' setting
0 Start time/sample of cross-correlation window.

end

End time/sample
0 End time/sample of cross-correlation window. = 0 : Until end of trace.

hdr_rms

Name of trace header where RMS value shall be stored
...may be new or existing trace header
rms

Example:

# Compute RMS value in given time window
$RMS
domain time
start 0
end 0
hdr_rms rms

ROTATE (1.0)

Perform 2D/3D rotation to input traces. For 2D rotation (i.e. azimuth), the coordinate system is assumed to be X/East, Y/North.

The values found in the input headers must be in degrees. Rotation is done by this angle. Note that the COORDINATE system is rotated clock-wise by the given rotation angle, not the data VECTOR.

input

Input data
Specifies what type of input data is expected in this module
?
xy 2 sequential input traces, containing sensors 3(X) and 4(Y). Sorting of these two may be arbitrary..
xyz 3 sequential input traces, containing sensors 3(X), 4(Y) and 5/2(Z). Sorting of these three may be arbitrary..
xyzp 4 sequential input traces, containing sensors 3(X), 4(Y) and 5/2(Z), and 4th trace with sensor 1(hydrophone). Sorting of these four may be arbitrary..
ensemble Input whole ensemble (user sorted). Each input ensemble must contain one trace each for sensor 3(X), 4(Y) and 5/2(Z). Sorting of these three may be arbitrary..

method

Rotation method
?
azim Rotate input trace pair XY by azimuth angle.. Required input header: an_azim.
radial Rotate input trace pair XY to radial/transverse.. Required input headers: an_azim, sou_x, sou_y, rec_x, rec_y.
icv Rotate input trace triplet XYZ by inclinometer ICV values.. Required input headers: incl_i, incl_c, incl_v.
tilt_roll Rotate input trace triplet XYZ by roll/tilt angles.. Required input headers: an_roll, an_tilt.
tilt_xy Rotate input trace triplet XYZ by tilt X/Y angles.. Required input headers: an_tiltx, an_tilty.
galperin Rotate to galperin configuration. Geophones point outwards down, first geophone's azimuth is unchanged by rotation.
armss Rotate ARMSS node data: Galperin configuration and 162deg ARMSS azimuth.
armss_tilt_roll Rotate ARMSS node data: Galperin, azimuth and ARMSS roll & tilt. Required input header: an_roll, an_tilt.
trilobit Rotate Trilobit node data from Galperin g123 configuration to XYZ.
from_to Rotate XY trace pair (=XY coordinate system) from angle 'angle_from' to 'angle_to'. Angles usually give X orientation.

orient

Orientation of XYZ/XY components
right
right XYZ components describe a right hand system.
left XYZ components describe a left hand system.
up
up Z component is pointing downwards. For XY input only, the orientation of a 'virtual' Z component defines the relative orientation of XY in the same way.
down Z component is pointing upwards. For XY input only, the orientation of a 'virtual' Z component defines the relative orientation of XY in the same way.

hdr_roll

Trace header containing roll angle
an_roll Trace header name containing roll angle [deg].

hdr_tilt

Trace header containing tilt angle
an_tilt Trace header name containing tilt angle [deg].

hdr_tiltx

Trace header containing tilt X angle
an_tiltx Trace header name containing tilt X angle [deg].

hdr_tilty

Trace header containing tilt Y angle
an_tilty Trace header name containing tilt Y angle [deg].

hdr_azim

Trace header containing azimuth
an_azim Trace header name containing azimuth [deg].

angle_from

Angle that input data is rotated to (usually direction of X component)
Azimuth angle is defined clock-wise from North
? Trace header name containing angle [deg].

angle_to

Angle that data shall be rotated to (usually output direction of X component)
Azimuth angle is defined clock-wise from North
? Trace header name containing angle [deg].

max_tiltxy

Maximum valid tilt value for tilt XY rotation
? Maximum valid tilt value. If tilt exceeds the maximum valid tilt value, it is replaced by the value from previous trace, if available.
yes
yes Write warnings to job log.
no Do not write warnings to job log.

mode

Mode of operation
apply
apply Apply rotation.. For 2D rotation, apply clockwise rotation to coordinate system (X/East and Y/North)..
remove Remove rotation. For field data, specify 'remove' to rotate from as-laid to final coordinate system.. For 2D rotation, apply ANTI-clockwise rotation to coordinate system (X/East and Y/North)..

Example:

# Perform 2D/3D rotation to input traces
$ROTATE
input ?
method ?
orient right up
hdr_roll an_roll
hdr_tilt an_tilt
hdr_tiltx an_tiltx
hdr_tilty an_tilty
hdr_azim an_azim
angle_from ?
angle_to ?
max_tiltxy ? yes
mode apply

SCALING (1.0)

Scale trace data with linear function. Apply time variant linear scaling function to seismic trace data.

option

How is scalar function specified?
list
list Scale function is specified by lists of time and scalar values.

time (List)

List of time value [ms]
Time knee points at which specified scalars apply
? List of time values [ms]....

scalar (List)

List of scalars
Scalar values that apply at specified time knee points. In between time knee points, scalar is linearly interpolated.
? List of scalars....

header

Trace header name containing scalar value
? Trace header name.

Example:

# Scale trace data with linear function
$SCALING
option list
time ?
scalar ?
header ?

SELECT (1.0)

Select traces. Select traces that match specified header selection.

header (List)

Names of trace headers used for trace selection
? Trace header name.

select (List)

Selection of header values
? List of selection strings, one for each specified header. See documentation for more detailed description of selection syntax. Examples: '10,13' '10-13'-->'10,11,12,13' '10-30(10)'-->'10,20,30'. Operators: <,<=,>=,>,!.

Example:

# Select traces
$SELECT
header ?
select ?

SELECT_TIME (1.0)

Select time of interest. Samples outside of the chosen time interval are either set to zero, or removed.

For active data processing, only the relative time is usually of interest. For continuous data processing, absolute time selection is usually required.

domain

Time or sample domain
time
time Window is specified in time [ms].
sample Window is specified in samples (1 for first sample).

mode

Time selection mode
relative
relative Time window(s) are specified in relative time or sample index.
absolute Time window(s) are specified as absolute times.

start

List of start times/samples
Depends on 'domain' parameter
0 Start times/samples.

end

List of end times/samples
? End times/samples.

table

Table with window start/end times or samples
For absolute time mode, columns 'start_time' and 'end_time', given in [ms] since 01-Jan-1970, must be specified
? Full path name of table containing window start/end times.

del_traces

Delete trace if more then specified amount of trace has been de-selected
This option really only makes sense when used in conjunction with an absolute time selection
no
no Do not delete any traces. Set de-selected samples to zero..
yes Delete traces if more than X percent of trace has been de-selected. Otherwise set de-selected samples to zero..
100 Threshold of removed data that triggers trace deletion, given in percent [%]..

free_mem (List)

Free unused data in case output trace is shorter than input trace
This can be used to boost memory performance
no
no By default, the system decides whether to free any unused memory immediately or reuse it for later..
yes Free extra memory..

Example:

# Select time of interest
$SELECT_TIME
domain time
mode relative
start 0
end ?
table ?
del_traces no 100
free_mem no

SEMBLANCE (1.0)

Semblance panel generation.

vel_range

Velocity range to test
0 Time at which specified velocity applies [ms]. Velocity range is interpolated linearly over time.
700 Start stacking velocity [m/s].
2000 End stacking velocity [m/s].

vel_inc

Velocity increment
20 Velocity increment between tests [m/s].

vel_test

Maximum deviation from velocity guide function
0 Maximum deviation to velocity guide function to test [%]. '0' means all velocities will be tested.

window

Window length to use for semblance calculation
100 Window length [ms].

wave_mode

Mode of wave to model
pp_iso
pp_iso Isotropic PP mode (downgoing P, upgoing P).
ps_iso Isotropic PS mode (downgoing P, upgoing S).
p_direct Direct P arrival, straight ray assumption. Essentially to Linear Moveout (LMO). For this option, use parameter 'lmo_refvel' to set up a reference velocity in case the input data is already LMO corrected using a constant velocity.

lmo_refvel

Linear moveout reference velocity
Use this parameter to specify the LMO velocity which is already applied to the input data. If a reference velocity other than 0 is specified, the tested velocities are interpreted as differences to the reference velocity, for example +/-10m/s
0 Velocity [m/s]. = 0: Input data is not LMO corrected. If set != 0, the specified semblance velocity range should be a relative velocity difference..

mute_table

Mute table
? Mute table file.. The mute table must have at least two columns, one giving a key and the second giving the mute time in [ms].

output_hdr

How shall trace header of output trace be determined?
first
first Output trace header values of first input trace to output trace.
last Output trace header values of last input trace to output trace.

Example:

# Semblance panel generation
$SEMBLANCE
vel_range 0 700 2000
vel_inc 20
vel_test 0
window 100
wave_mode pp_iso
lmo_refvel 0
mute_table ?
output_hdr first

SORT (1.0)

Sort traces. Very simple implementation. Requires to hold all traces to be sorted in memory at once..

mode

Sort mode
ensemble
ensemble Sort all traces in input ensemble.

header

Trace header to sort on
? Trace header name.
increasing
increasing Sort in increasing order.
decreasing Sort in decreasing order.

method

Sort method
simple
simple Simplest sort method. Fastest for small and partially pre-sorted data sets.
tree Tree sorting method. Most efficient for large, totally un-sorted data sets.

Example:

# Sort traces
$SORT
mode ensemble
header ? increasing
method simple

SPLIT (1.0)

Split/branch trace flow. Create copy of traces that match specified header selection and process them within SPLIT-ENDSPLIT block.

header (List)

Names of trace headers used for trace selection
? Trace header name.

select (List)

Selection of header values
? List of selection strings, one for each specified header. See documentation for more detailed description of selection syntax.

Example:

# Split/branch trace flow
$SPLIT
header ?
select ?

SPLITTING (1.0)

Shear-wave splitting analysis.

This module generates stacked S1 and S2 traces, for each input ensemble and each test angle specified by the parameters 'num_angles' and 'angle_inc'. Input data must be one ensemble with pairs of XY traces. NMO etc has been applied, so that the result can be stacked A 2D right-handed XY coordinate system is assumed (e.g. X pointing North, and Y pointing East)

layer_strip

Perform layer stripping?
no
no Generate S1/S2 stacks, no layer stripping.
yes Perform layer-stripping. Specify windows for layer stripping, data output option, and cross-correlation parameters.

azim

Sensor azimuth [deg]
Azimuth of X sensor. Y sensor must be 90deg clock-wise (right-hand system)
? Sensor azimuth [deg].

num_angles

Number of angles to test in a 180deg half-circle
The angle increment for S1/S2 analysis is computed as 180deg/num_angles
? .

angle_omit

Width of angle band to omit from S1/S2 stack
Traces with source-receiver azimuth of 90deg +/-angle are omitted from S1 stack, and 180deg +/-angle are omitted from S2 stack
5 [deg].

norm_method

Normalisation method for S1/S2 stacks
ls
ls Least-square normalisation.
ntraces Normalise by number of traces.
isotropic Normalise by number of traces, isotropic S2 scaling. This normalisation enhances isotropic side scatterers on 'S2' stack.

offset_range

Min/max absolute offset range to use for splitting analysis/layer stripping
0 Minimum absolute offset [m].
? Maximum absolute offset [m]. Not specified = No maximum offset limitation.

orient_xy

Orientation of XY components
Required for layer stripping
right
right XY components describe a right hand system.
left XY components describe a left hand system.

corr_maxlag

Parameters for cross-correlation when layer stripping
0 Maximum time lag for cross-correlation.

win_start (List)

List of start times defining layer stripping windows
0 List of times in [ms].

win_end (List)

List of end times defining layer stripping windows
0 List of times in [ms]. 0 = Use full time window of input data.

output

What data shall be output?
s1s2_stacks
s1s2_stacks Write S1/S2 analysis stacks to output traces.
corrected_data Write layer-stripped, corrected input data to output traces.
last_s1s2_stacks Write only last S1/S2 analysis stacks (layer-stripped, corrected) to output traces.

output_hdr

How shall trace header of output trace be determined?
first
first Write trace header values of first input trace to output trace.
last Write trace header values of last input trace to output trace.
average Take average over all input trace headers for output trace.

write_info

Write layer stripping results to ASCII output file
? Name of trace header that serves as unique identifier for each analysed gather.
? File name of output ASCII file. Output format:
id_value win_start[ms] win_end[ms] s1az[deg] s2lag[ms].

stretch_top_half

Apply time stretch from top to centre of analysis window?
no
no No, apply time stretch over while analysis window.
yes Yes, only apply time stretch over top half of analysis window.

Example:

# Shear-wave splitting analysis
$SPLITTING
layer_strip no
azim ?
num_angles ?
angle_omit 5
norm_method ls
offset_range 0 ?
orient_xy right
corr_maxlag 0
win_start 0
win_end 0
output s1s2_stacks
output_hdr first
write_info ? ?
stretch_top_half no

STACK (1.0)

Ensemble stack. Stack all traces in ensemble.

output_hdr

How shall trace headers of output trace be determined?
first
first Use trace header values from first input trace.
last Use trace header values from last input trace.
average Take average of all input trace headers.

mode

Mode of operation
?
ensemble Stack each input ensemble..
all Stack all incoming traces..
sorted Input data have already been pre-sorted by header(s) specified in parameter 'header'..
unsorted Input data have NOT been pre-sorted.. This means that the stack module waits until all traces have been input before outputting the first trace. Note that output traces may not be sorted in (increasing,decreasing) order of the stack header..

header

Stack header
? Trace 'stack' header name. Stack all traces with same stack header value..

norm

Normalisation factor
0 Output stack value is normalised by number of stacked traces to the power of the 'norm' factor.. Specify 0.5 for sqrt(N) normalization, 0 for no normalization.

norm_time_variant

Time variant normalisation?
no
no Do not apply time variant normalisation. Apply constant normalisation for each sample value.
yes Apply time variant normalisation according to stacked non-zero samples..
stack_trace
stack_trace Do not output normalisation trace - output stacked trace.
norm_trace Output normalisation trace instead of stacked data.

Example:

# Ensemble stack
$STACK
output_hdr first
mode ?
header ?
norm 0
norm_time_variant no stack_trace

STATICS (1.0)

Apply trace statics.

bulk_shift

Apply static bulk shift to all traces
0.0 Static shift [ms]. Positive value shifts samples downwards.

header

Apply static shift from trace header
? Name of trace header containing static shift [ms]. Positive value shifts samples downwards.

mode

Mode of application
apply
apply Apply all specified statics.
remove Remove all specified statics. Apply inverse/negative statics.

ncoef

Number of interpolation coefficients
8 Number of interpolation coefficients.

Example:

# Apply trace statics
$STATICS
bulk_shift 0.0
header ?
mode apply
ncoef 8

SUMODULE (1.0)

Generic wrapper for Seismic Unix (SU) module (EXPERIMENTAL). Assumes available SU installation. This module is not guaranteed to work for all SU modules. Only one instance of $SUMODULE can be used in each Seaseis flow.

command

SU command to run
This version only supports running a single SU module
"sugain scale=2.0" SU command, including space separated argument list.

endian_format

Endian format of data passed to SU
Depends on whether local SU installation was compiled with BIG or LITTLE endian format
big
big Pass data in big endian format..
little Pass data in little endian format..

cwproot

SU root directory
By default, the environment variable $CWPROOT will be queried
? SU root directory, full path name.

Example:

# Generic wrapper for Seismic Unix (SU) module (EXPERIMENTAL)
$SUMODULE
command "sugain scale=2.0"
endian_format big
cwproot ?

TEST (1.0)

Demonstration single trace module. Extra description....

skip

Number of traces to skip
0 Number of traces to skip.

Example:

# Demonstration single trace module
$TEST
skip 0

TEST_MULTI_ENSEMBLE (1.0)

Test module - multi-trace, ensemble module.

skip

Number of times to skip processing and drop all input traces
0 Number of times to skip processing and drop all input traces.

ntraces_roll

Number of traces to roll
0 Number of traces to roll.

ntraces_add

Number of traces to add
0 Number of traces to add each time module is called.

repeat

Number of times to repeat
0 Number of times to repeat each processing.

Example:

# Test module - multi-trace, ensemble module
$TEST_MULTI_ENSEMBLE
skip 0
ntraces_roll 0
ntraces_add 0
repeat 0

TEST_MULTI_FIXED (1.0)

Test module - multi-trace, fixed number of input traces.

ntraces_in

Number of input traces
1 Number of input traces.

skip

Number of times to skip processing and drop all input traces
0 Number of times to skip processing and drop all input traces.

ntraces_roll

Number of traces to roll
0 Number of traces to roll.

ntraces_add

Number of traces to add
0 Number of traces to add each time module is called.

repeat

Number of times to repeat
0 Number of times to repeat each processing.

Example:

# Test module - multi-trace, fixed number of input traces
$TEST_MULTI_FIXED
ntraces_in 1
skip 0
ntraces_roll 0
ntraces_add 0
repeat 0

TIME_SLICE (1.0)

Extract time slice(s) from input data, write to trace header field or output data.

mode

Time slice mode
header
header Place amplitudes of time slice in trace header only. Specify user parameter 'slice'.
data Write time slices to output data traces.

slice

Time slice (store in trace header)
? Time [ms] / frequency [Hz] or sample at which time slice shall be extracted.
? Trace header name where time slice amplitude will be stored.

data_slice

Time slice (output data trace & store in trace header)
? Trace header name where slice time will be stored.
? Time/depth of first slice. ..in given units of trace (typically milliseconds, meters or Hertz).
? Time/depth of last slice (optional).
? Increment (optional).

data_dim1

Definition of first dimension (vertical axis) of output time slice
? Trace header name for first dimension (vertical axis on output trace).
? Start value.
? End value.
? Increment.

data_dim2

Definition of second dimension (horizontal axis) of output time slice
? Trace header name for first dimension (horizontal axis on output trace).
? Start value.
? End value.
? Increment.

domain

Time or sample domain
time
time Window is specified in time [ms] (or frequency [Hz]).
sample Window is specified in samples (1 for first sample).

Example:

# Extract time slice(s) from input data, write to trace header field or output data
$TIME_SLICE
mode header
slice ? ?
data_slice ? ? ? ?
data_dim1 ? ? ? ?
data_dim2 ? ? ? ?
domain time

TIME_STRETCH (1.0)

Stretch/squeeze data trace.

To set up this module, specify either pairs of horizon input/output times, or otherwise the input horizon times and a stretch factor for each layer. Values can be specified either as

value_type

Type of data provided to define stretch
This value is provided by the usr parameter 'value', or through the trace header specified in 'hdr_stretch'
stretch
stretch Provide stretch factor for each layer.
time Provide output horizon time for each layer.

time (List)

List of horizon times [ms]
For a model with N layers, specify N+1 time values. First value gives top of first layer, each subsequent value defines the bottom of one layer and the top of the next layer
? List of horizon times [ms]..

value (List)

List of stretch factors (or horizon output times) [ms]
Number of stretch factors must be one less than number of times, one for each model layer. Number of output times must be the same as the number of input horizon times.
? Stretch factor or output horizon time [ms]. Polarity for stretch factor: Stretch(+) or squeeze(-).

hdr_stretch

Trace header containing stretch value
This is an alternative to providing a list of values. This only applies to a single layer
? Name of trace header containing stretch value in [ms] (or [Hz]).

mode

Mode of application
apply
apply Apply.
remove Remove.

Example:

# Stretch/squeeze data trace
$TIME_STRETCH
value_type stretch
time ?
value ?
hdr_stretch ?
mode apply

TRC_ADD_ENS (1.0)

Ensemble trace adding.

method

Method for trace adding
ntraces
ntraces Add specified number of traces at beginning and end of ensemble.
pad Pad traces as specified by trace header name and padding values.

ntraces

Number of traces to add at end of each ensemble
1

value

Initialize trace samples to the given value
0

header

Trace header name for trace padding
? Trace header name.

pad

Pad traces following the specified trace header values
? First value.
? Last value.

pad_inc

Pad traces with the specified increment between trace header values
? Increment.

delete

Delete inconsistent traces (when trace padding)?
yes
yes Delete inconsistent traces.
no Do not delete inconsistent traces.

Example:

# Ensemble trace adding
$TRC_ADD_ENS
method ntraces
ntraces 1
value 0
header ?
pad ? ?
pad_inc ?
delete yes

TRC_INTERPOL (1.0)

Interpolate traces (EXPERIMENTAL MODULE). Interpolate 1 trace between every two adjacent traces, e.g. if 10 traces are input, 19 traces will be output.

method

?
simple_average Interpolate new trace by simply averaging adjacent traces. Header values are averaged..

Example:

# Interpolate traces (EXPERIMENTAL MODULE)
$TRC_INTERPOL
method ?

TRC_MATH (1.0)

Trace sample computation. Perform mathematical computations on trace sample values..

If more than one user parameter is specified, operations are applied in the order they are defined in this help document, NOT in the order they are supplied in the flow file

equation

Mathematical equation
? Arbitrary mathematical equation to apply to each individual trace sample. Use 'x' to reference original sample value.. Constants: pi,e. Functions: abs,acos,asin,atan,atan2,ceil,cos,cosh,exp,floor,log,log10,max,min,mod,pow,int,round,sin,sinh,sqrt,tan,tanh,todegrees,toradians,sign.

add

Add constant value to sample value
0 Constant value to add to trace sample value.

db

Convert (power) to dB )
0 Added noise. Set to other than zero to prevent taking logarithm of zero.
power
power Apply power dB equation: (10*log10(x+noise).
amp Apply amplitude dB equation: (20*log10(x+noise).

flip

Flip trace upside down?
no
no Do not flip trace.
yes Flip trace upside down: Reverse the order of the sample values.

Example:

# Trace sample computation
$TRC_MATH
equation ?
add 0
db 0 power
flip no

TRC_MATH_ENS (1.0)

Multi-trace sample computation. Apply multi-trace mathematical equation to sample values.

method

?
debias Debias trace samples: For each sample time, compute mean value across all traces and remove it from trace sample values.
mean Rolling mean filter, applied on a sample-by-sample basis.

roll_ens

? Header.
? Number of traces to roll.

roll_dim2

? Header.
? Number of traces to roll.

Example:

# Multi-trace sample computation
$TRC_MATH_ENS
method ?
roll_ens ? ?
roll_dim2 ? ?

TRC_PRINT (1.0)

Print trace samples. Print trace samples to log file.

filename

Output file name
? Output file name.

header

Trace header to print
? Trace header name.

format

Specify floating point format (C style)
%10.2f Format for sample time/frequency.
%16.10e Format for sample value.

Example:

# Print trace samples
$TRC_PRINT
filename ?
header ?
format %10.2f %16.10e

TRC_SPLIT (1.0)

Trace split. Split trace into N traces of equal length.

mode

Mode
trace
trace Split one trace after the other....
ensemble Input ensemble, N traces. Output split trace 1 from input trace 1-N, then split trace 2 etc..

ref_time

Use reference time (1-Jan-1970 00:00:00)
Start times of output traces are offset by integer multiple of trace lengths relative to reference time
no
no Do not use reference time..
yes Make sure that trace start time is offset from reference start time by an integer multiple of trace lengths.

start_times (List)

Give start times of new traces in list
When this parameter is selected, the output trace length must be specified in parameter 'length'
? List of absolute start times in full UNIX seconds [s].

ntraces

Number of traces to split into
? Number of new traces.

length

Length of new traces
? Length of new traces [ms]. ...must be smaller than the current trace length.

Example:

# Trace split
$TRC_SPLIT
mode trace
ref_time no
start_times ?
ntraces ?
length ?

Standard Header Definitions

List of trace headers defined in OpenSeaSeis.
#1 an_azim float Azimuth angle from North [deg]
#2 an_inci float Incidence angle from vertical [deg]
#3 an_roll float Roll angle [deg]
#4 an_tilt float Tilt angle [deg]
#5 an_tiltx float Tilt angle (X direction) [deg]
#6 an_tilty float Tilt angle (Y direction) [deg]
#7 aoffset float Absolute source-receiver offset [m]
#8 bin_x double Bin X coordinate [m]
#9 bin_y double Bin Y coordinate [m]
#10 cbl_azim float Cable azimuth form North [deg]
#11 ccp int Common conversion number
#12 chan int Channel number
#13 chan_ens int Trace/channel number within ensemble
#14 cmp int CMP number
#15 cmp_x double CMP X coordinate [m]
#16 cmp_y double CMP Y coordinate [m]
#17 cmp_z float CMP Z coordinate [m]
#18 col int Column/crossline number
#19 data_type int Data type
#20 dc float DC bias
#21 delay_time float Delay time [ms]
#22 ffid int Field file ID number
#23 fileno int Sequential input file number
#24 filt_high_db int High-cut filter [dB/oct]
#25 filt_high_freq int High-cut filter [Hz]
#26 filt_low_db int Low-cut filter [dB/oct]
#27 filt_low_freq int Low-cut filter [Hz]
#28 fold int Trace fold
#29 fold_vert int Trace fold (vertically stacked)
#30 gain int Gain constant [dB]
#31 gain_type int Gain type (1=fixed, 2=binary, 3=float, 4-N=optional)
#32 gun_seq int Gun sequence number
#33 heading float Heading [deg]
#34 incl_c float Inclinometer crossline component
#35 incl_i float Inclinometer inline component
#36 incl_v float Inclinometer vertical component
#37 mute_end float End time of mute [ms]
#38 mute_start float Start time of mute [ms]
#39 node int Node ID
#40 nsamp int Number of live samples
#41 offset float Source-receiver offset (signed) [m]
#42 orient_c float Sensor orientation 'C' value
#43 orient_i float Sensor orientation 'I' value
#44 orient_v float Sensor orientation 'V' value
#45 rcv int Receiver station number
#46 rec_datum float Datum elevation/tide at receiver [m]
#47 rec_elev float Receiver elevation [m]
#48 rec_index int Receiver station index
#49 rec_line int Receiver line number
#50 rec_wdep float Water depth at receiver [m]
#51 rec_x double Receiver X coordinate [m]
#52 rec_y double Receiver Y coordinate [m]
#53 rec_z float Receiver Z coordinate [m]
#54 row int Row/inline number
#55 sail_line int Sail line number
#56 sampint_us int Sample interval [us]
#57 scalar_coord float Coordinate scalar [SEGY]
#58 scalar_elev float Elevation scalar [SEGY]
#59 scalar_stat float Static header scalar [SEGY]
#60 sensor int Sensor number
#61 seq int Sequence number
#62 serial int Sensor serial number
#63 sou_datum float Datum elevation/tide at source [m]
#64 sou_elev float Source elevation [m]
#65 sou_index int Source station/Shot point index
#66 sou_line int Source line number
#67 sou_wdep float Water depth at source [m]
#68 sou_x double Source X coordinate [m]
#69 sou_y double Source Y coordinate [m]
#70 sou_z float Source Z coordinate [m]
#71 source int Source station/Shot point number
#72 sr_azim float Source-receiver azimuth from North [deg]
#73 stat_rec float Receiver statics [ms]
#74 stat_res float Residual statics [ms]
#75 stat_sou float Source statics [ms]
#76 stat_tot float Total statics [ms]
#77 tapeno int Tape number
#78 time_code int Time code (1: local, 2: GMT, 3: Other, 4: UTC)
#79 time_day int Julian day of shot/record
#80 time_hour int Hour of shot/record
#81 time_min int Minute of shot/record
#82 time_msec int Millisecond shot/record time fraction [ms]
#83 time_nano int Nanosecond shot/record time fraction [ns]
#84 time_samp1 int Absolute time of first sample [s], seconds since 01-Jan-1970
#85 time_samp1_us int Absolute time of first sample [us], fraction
#86 time_sec int Second of shot/record
#87 time_usec int Microsecond shot/record time fraction [us]
#88 time_year int Year of shot/record
#89 trc_edit int Trace edit code
#90 trc_type int Trace type
#91 trcno int Trace number
#92 unit_coord int Coordinate unit (1: length, 2: arc sec, 3: decimal deg, 4: deg, min, sec)
#93 wdep float Water depth [m]