DOCUMENTATION

SYNOPSIS

 PERL PROGRAM NAME: iSelect_tr_Sumute.pm
 AUTHOR: Juan Lorenzo
 DATE:   January 29, 2017 
       
	 Based on iSelect_tr_Sumute_top3.pm
         from  August 2016, V 3.1 

 DESCRIPTION:
 plot data to select mute values
 top or bottom

USE

NOTES

Examples

Instantiate

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:

Establish

just the localally scoped variables

hash array

of important variables used within
 this package

sub clear

to blank out hash array values

sub file_in

Required file name
on which to pick  mute values
print("$iSelect_tr_Sumute->{_inbound}\n\n");

subroutine gather

sets gather number to consider  

sub gather_header

define the message family to use

sub purpose

define the type of mute to use 

sub gather_type

define the message family to use

sub offset_type

define the message family to use

sub freq

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

sub min_amplitude

minumum amplitude to plot 

sub max_amplitude

maximum amplitude to plot 

sub number_of_tries

keep track of the number of attempts
at picking top mute

sub suxwigb_defaults

selecting if there are appropriate suxwigb defaults

subroutine calcNdisplay

main processing flow
 calculate mute and display results 

GAIN

DATA

DISPLAY

DATA

Set wiggle plot

	for tau-p data
        if num_tries > 0 then you can save the mute picks
        to a picking file

DEFINE FLOW(S)

in interactive mode:
first time you see the image, number_of_tries =0
second, third, etc. times number_of_tries >0
The pick file can be saved

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