DOCUMENTATION

SYNOPSIS

PERL PROGRAM NAME:  SEGYCLEAN - zero out unassigned portion of header		
AUTHOR: Juan Lorenzo (Perl module only)
DATE:   
DESCRIPTION:
Version: 

USE

NOTES

Examples

SEISMIC UNIX NOTES

 SEGYCLEAN - zero out unassigned portion of header		

 segyclean <stdin >stdout 					

 Since "foreign" SEG-Y tapes may use the unassigned portion	
 of the trace headers and since SU now uses it too, this	
 program zeros out the fields meaningful to SU.		

  Example:							
  	segyread trmax=200 | segyclean | suximage		

 Credits:
	CWP: Jack Cohen

CHANGES and their DATES

SUG Version 0.0.02 allows a list of files to be cleaned

09.02.2025 - added list and su_base_file_name parameters to allow processing of a list of files (Juan Lorenzo)

NOTES

Version 0.0.02

Normally, segyclean acts on only one file at a time

In V0.0.2 wraps an extension to process an arbitrary
list of trace numbers. The automatic iteration includes
two additional parameters: list and su_base_file_name

The parameter "list" is the name of a text file.
The file is automatically bound to the SEIMICS_DATA_TXT 
directory path.

"list" is the name of a file containing a numeric list
of trace numbers of type "key" that are to be deleted:

An example list
file contains values, one per line.
   1 
   3 
   5

 "list" = a file name (in directory path: DATA_SEISMICS_TXT)
 "list" carries a ".txt" suffix automatically within the directory path,
 but the user does not enter it in the GUI.

 Neither does the user enter the ".su" suffix in the GUI.
 su_base_file_name =   e.g., 1001, which by defaults lies
 in directory path: DATA_SEISMIC_SU.

 A bare file name: '1001' will automatically be given an  ".su" suffix,
 that is, file name on the disk will be '1001.su'

 Within code, the imported "list" includes path and name;
 hence its name: _inbound_list. User enters a list name in 
 GUI using the mouse <MB3>.

Import packages

instantiation of packages

sub Step

collects switches and assembles bash instructions by adding the program name

sub note

collects switches and assembles bash instructions by adding the program name

sub clear

sub _get_inbound4base_file_names

sub _get_outbound4base_file_names

sub list

list array

sub trmax

maximum number of traces that are expected in the file

sub get_max_index max index = number of input variables - 1