DOCUMENTATION

SYNOPSIS

PERL PROGRAM NAME: iApply_mute
AUTHOR: Juan Lorenzo

DESCRIPTION:
Purpose: Mute of Data 

USE

NOTES Derives from iApply_top_mute.pm V3 Sept. 23, 2015:

Examples

inherit other packages
  1. Instantiate classes 
      Create a new version of the package
      Personalize to give it a new name if you wish
    Use the following classes:

Import file-name  and directory definitions

establish just the locally scoped variables

hash array of important variables used within
this package
Assume that the parameter file already exists
Assume that the name of this parameter file is:
   $itemp_top_mute_picks_sorted_par_.$iApply_mute->{_file_in}

subroutine clear
        to blank out hash array values

subroutine gather_header

define the header for the xmute values
binheader type value helps define the xmute values
e.g. if gather_header = 'gather'
the the xmute values are 'offset'

subroutine offset_type

define the header for the xmute values
offset type value helps define the xmute values
e.g. if offset_type = 'gather'
the the xmute values are 'offset'

subroutine gather

sets gather number to consider  

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

subroutine file_in
Required file name
on which to apply top mute values
print(" iApply inbound is $iApply_mute->{_inbound}\n\n");

subroutine gather_type

sets gather type to consider 
e.g., 'ep', 'cdp', etc. 

subroutine minumum amplitude to plot 

subroutine maximum amplitude to plot 

subroutine purpose

are the picks for a future top mute
or a future bottom mute ? 
e.g.= _bottom_mute

subroutine calcNdisplay

main processing flow
calculate mute and display results 

Assume that the parameter file already exists
Assume that the name of this parameter file is:
   $itemp_top_mute_picks_sorted_par_.$iApply_mute->{_file_in}

MUTE  DATA by  

set filtering parameters 

GAIN DATA

DISPLAY DATA

Set wiggle plot

for tau-p data

DEFINE FLOW(S)

RUN FLOW(S)
output copy of picked data points
only occurs after the number of tries
is updated

LOG FLOW(S)TO SCREEN AND FILE