DOCUMENTATION

SYNOPSIS

 PERL PROGRAM NAME: iSelect_tr_Sumute_top.pm
 AUTHOR: Juan Lorenzo
 DATE:   April 2 2009 V1.
         Aug 9, 2011 V1.2
         Sept. 2015, V 3
	     August 2016, V 3.1 

 DESCRIPTION:
 plot data to select top mute values

 ***Modification: plotting functionality added with suxwigb 
 Modifier: Nathan Benton 
 Date: 07/09/2017
 Purpose: viewing both image and wiggle plots for muting purposes 
 helps facilitate better muting of the surface wave - note that 
 the wiggle plotting was added for this very reason - viewing the 
 wiggle plot of each shotgather (or cmp) can sometimes be better than
 just viewing the image plot, especially when a good or bad gain has 
 been applied (note that this exact comment is also present in 'iApply..top'

USE

NOTES

Examples

needed packages

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

subroutine gather

sets gather number to consider  

sub gather_header

define the message family to use

sub gather_type

define the message family to use

sub offset_type

define the message family to use

sub file_in

Required file name
on which to pick top mute values

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

subroutine calcNdisplay

main processing flow
 calculate mute and display results 

GAIN

DATA

WINDOW DATA

by  

Set

filtering parameters 

DISPLAY (For Both Suximage and Suxwigb)

DATA

Set suxwigb

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