DOCUMENTATION =head2 SYNOPSIS

PERL PROGRAM NAME: iBottomMute.pm 
AUTHOR: Juan Lorenzo
DATE:  Sept. 14 2015 
DATE:  June 12, 2017 adapted from iTop_Mute3.pm 
        

DESCRIPTION: 
Package used for interactive bottom mute 

USE

NOTES

Examples

SEISMIC UNIX NOTES

CHANGES and their DATES

STEPS

1. define the types of variables you are using
   these would be the values you enter into 
   each of the Seismic Unix programs  each of the 
   Seismic Unix programs

2. build a list or hash with all the possible variable
   names you may use and you can even change them

set defaults

VELAN DATA m/s

Import

packages
directory definitions

establish private hash of shared variables

instantiate

programs

declare variables types
establish just the locally scoped variables

subroutine clear

sets all variable strings to '' 

subroutine gather_header

define which values  to use in the xaxis 

subroutine offset_type

define which values  to use in the xaxis 

subroutine gather_type

define which family of messages to use

subroutine iBM_Select_tr_Sumute_bottom_ Select mute points in traces provide file name

subroutine iBM_Apply_bottom_mute

 Mute the data using selected parameters 

subroutine iPicks2par

convert format of pick files for use later
into "par" format 

subroutine iBM_Save_bottom_mute_picks

save pick files for later use

sub set_message

define the message family (type) to use
also set the gather nuimber (TODO: move option elsewhere)

update gather number for messages

subroutine iBM_message

instructions 

update gather number for messages

look for old data

Are there old picks to read?
These old picks are of a type e.g. velan or gather

subroutine gather_num

sets gather number to consider  

subroutine file_in
Required file name
on which to pick bottom mute values

subroutine data_scale 
Required data plotting scale 

subroutine freq
 creates the bandpass frequencies to filter data before
 conducting amplitude analysis
 e.g., "3,6,40,50"

subroutine maximum amplitude to plot 

subroutine minumum amplitude to plot 

subroutine number_of_tries 
required count of the number of attempts
at estimating the velocity

subroutine icp_sorted_2_old_picks
When user wants to recheck the data 
this subroutine will allow the user to 
recheck  using an old sorted file
Juan M. Lorenzo
Jan 10 2010

   input file is ivpicks_sorted
   output pick file 
   text file out: ivpicks_old 

DEFINE FLOW(S)

RUN FLOW(S)

LOG FLOW(S)TO SCREEN AND FILE