DOCUMENTATION
SYNOPSIS
PERL PROGRAM NAME: iShowNselect_picks
AUTHOR: Juan Lorenzo
DESCRIPTION:
Purpose: display selected picks ontop of data
USE
NOTES
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_picks_sorted_par_.$iShowNselect_picks->{_file_in}
subroutine clear
to blank out hash array values
sub _inbound_curve_file
Required text file with x,t pairs
subroutine gather_header
define the header for the x values
binheader type value helps define the x values
e.g. if gather_header = 'gather'
the x values are 'offset'
subroutine calcNdisplay
main processing flow
display picks on top of results
WINDOW DATA
Filter parameters
GAIN DATA
DISPLAY DATA (SUXIMAGE)
DISPLAY DATA (SUXWIGB)
conditions
when number_of_tries is >=2
there should be a pre-exisiting digitized
overlay curve to plot as well
DEFINE FLOW(S) - for both suximage AND suxwigb
remove gain $to, $sugain[1],
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
sub file_in
Required sunix file name
on which to pick mute values
print("$iShowNselect_picks->{_inbound}\n\n");
subroutine freq
creates the bandpass frequencies to filter data
e.g., "3,6,40,50"
subroutine gather
sets gather number to consider
subroutine maximum amplitude to plot
subroutine minumum amplitude to plot
sub max_x1
maximum time/Hz to plot
sub min_x1
minumum time/Hz to plot
sub number_of_tries
keep track of the number of attempts
at picking top mute
subroutine offset_type
define the header for the x values
offset type value helps define the x values
e.g. if offset_type = 'gather'
the x values are 'offset'
sub set_purpose
define where the data will need to go
define the type of behavior
4 POD Errors
The following errors were encountered while parsing the POD:
- Around line 353:
'=item' outside of any '=over'
- Around line 371:
You forgot a '=back' before '=head2'
- Around line 436:
'=item' outside of any '=over'
- Around line 454:
You forgot a '=back' before '=head2'