/ 
App-SeismicUnixGui-0.87.1
River stage zero No dependents
/ App::SeismicUnixGui::big_streams::iApply_top_mute

DOCUMENTATION

SYNOPSIS

PERL PROGRAM NAME: iApply_top_mute
AUTHOR: Juan Lorenzo

DESCRIPTION:
Purpose: Linear Top Mute of Data 
        Sept. 23, 2015: added oop functinality

	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

USE

NOTES

TODO replace iApply_top_mute with iApply_mute with an adidtional method='purpse'

needed packages

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_top_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

subroutine minumum amplitude to plot 

subroutine maximum amplitude to plot

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_top_mute->{_file_in}

MUTE  DATA by  

WINDOW  DATA   

set filtering parameters 

GAIN DATA

DISPLAY DATA (SUXIMAGE)

DISPLAY DATA (SUXWIGB) 

DEFINE FLOW(S) - for both suximage AND suxwigb 

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