DOCUMENTATION

SYNOPSIS

PERL PROGRAM NAME:select_waveform.pm
Purpose: Simple viewing of an su file 
         to select  waveforms  
         waveforms are xtracted at a later stage
AUTHOR:  Juan M. Lorenzo
DEPENDS: Seismic Unix modules from CSM 
DATE:    July 7 2016 V0.1
DESCRIPTION:  

(for subroutines) 
    manage_files_by 
    System_Variables (for subroutines)

    (for variable definitions)
    SeismicUnix (Seismic Unix modules)

NOTES

We are using moose 
moose already declares that you need debuggers turned on
so you don't need a line like the following:

use warnings;

USES

(for subroutines) 
    manage_files_by 
    System_Variables (for subroutines)

    (for variable definitions)
    SeismicUnix (Seismic Unix modules)


use App::SeismicUnixGui::misc::SeismicUnix qw($in $out $on $go $to $suffix_ascii $off $suffix_su) ;
 

STEPS IN THE PROGRAM

declare common variables

Create

hash of shared variables and
subroutine to clear them

Do not clear: absclip

sub picks_file

set picks_file 
  waveform file   

sub agc_gain_width

set agc_gain_width 
  waveform file   

sub filter_freq

set filter_freq 
  waveform file   

sub window_title

set window_title  for suxwigb  

sub title

set title  for suxwigb  

sub absclip

set absclip  for suxwigb  

sub inbound

set _inbound seismic-unix 
-formatted file name

sub Step

Selection of waveform

needed packages

1. Instantiate classes 
     Create a new version of the package
     Personalize to give it a new name if you wish
   Use classes:
   flow
   log
   message
   sufilter
   sugain
   suxwigb
   suximage
   readfiles 

3. Declare local variables 

Declare

file names 

 5. sugain 

this is how to use a subroutine from the sugain 'package' 
$on =1
$width is the width of the window in seconds
$sugain-> Step() generates the instructions to run this single module with 
the correct syntax for perl

$sugain     -> agc($on);
$sugain     -> width_s(2.6);
$sugain[2]   = $sugain->Step();

Set

filtering parameters 

Set

5. set suxwigb parameters 
In the perl module for suxwigb we should
have (but we do not yet) an explanation of each  of  these parameters

5. set suximage parameters 
In the perl module for suxmage we should
have (but we do not yet) an explanation of each of
these parameters

Standard:
1. DEFINE FLOW(S)

3. LOG FLOW(S)TO SCREEN AND FILE

cpanm App::SeismicUnixGui

perl -MCPAN -e shell
install App::SeismicUnixGui