DOCUMENTATION

SYNOPSIS

PERL PROGRAM NAME:su_spectral_analysis.pm
Purpose: Spectral analysis 
         of spectral_analysised  waveforms in su format 
AUTHOR:  Juan M. Lorenzo
DEPENDS: Seismic Unix modules from CSM 
DATE:    July 8 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

Create

hash of shared variables and
subroutine to clear them

Do not clear: absclip_phase or absclip_freq

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 XT data  

sub absclip_phase

set absclip  for phase  

sub absclip_freq

set absclip  for phase  

sub inbound

set _inbound seismic-unix 
-formatted file name
including directory path as well

sub Step

Selection of waveform

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

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

Set

suxwigb parameters 
for Frequency spectrum

Set

suxwigb parameters 
for phase spectrum

fft

extract f spectra

extract phase spectra

DEFINE FLOW(S)

place 1; at end of a package

cpanm App::SeismicUnixGui

perl -MCPAN -e shell
install App::SeismicUnixGui