DOCUMENTATION

SYNOPSIS

PERL PROGRAM NAME:  SUFILTER - applies a zero-phase, sine-squared tapered filter		
AUTHOR: Juan Lorenzo (Perl module only)
DATE:   Nov 1 2012,July 27 2015
DESCRIPTION: sufilter a lists of header words
or an single value
Version: 0.0.1
		  0.0.2 updated to Moose
		  0.0.3	genearated by sudoc2pm.pl Sept 7 2018

USE

NOTES

Examples

SEISMIC UNIX NOTESuse L_SU_global_constants();

 SUFILTER - applies a zero-phase, sine-squared tapered filter		

 sufilter <stdin >stdout [optional parameters]         		

 Required parameters:                                         		
       if dt is not set in header, then dt is mandatory        	

 Optional parameters:							
       f=f1,f2,...             array of filter frequencies(HZ) 	
       amps=a1,a2,...          array of filter amplitudes		
       dt = (from header)      time sampling interval (sec)        	
	verbose=0		=1 for advisory messages		

 Defaults:f=.10*(nyquist),.15*(nyquist),.45*(nyquist),.50*(nyquist)	
                        (nyquist calculated internally)		
          amps=0.,1.,...,1.,0.  trapezoid-like bandpass filter		

 Examples of filters:							
 Bandpass:   sufilter <data f=10,20,40,50 | ...			
 Bandreject: sufilter <data f=10,20,30,40 amps=1.,0.,0.,1. | ..	
 Lowpass:    sufilter <data f=10,20,40,50 amps=1.,1.,0.,0. | ...	
 Highpass:   sufilter <data f=10,20,40,50 amps=0.,0.,1.,1. | ...	
 Notch:      sufilter <data f=10,12.5,35,50,60 amps=1.,.5,0.,.5,1. |..	

 Credits:
      CWP: John Stockwell, Jack Cohen
	CENPET: Werner M. Heigl - added well log support

 Possible optimization: Do assignments instead of crmuls where
 filter is 0.0.

 Trace header fields accessed: ns, dt, d1

CHANGES and their DATES

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 amps

sub amplitude

sub dt

sub f

sub freq

sub verbose

sub get_max_index

max index = number of input variables -1