GISMO - a seismic data analysis toolbox for MATLAB.zip

% Author: Michael West, Geophysical Institute, Univ. of Alaska Fairbanks % $Date$ % $Revision$ ############################ NewCorrelation now takes over the functionality of Correlation, but is implemented as modern matlab classes - Celso - Instead of correlation('cookbook'), use NewCorrelation.cookbook() Contents - Install notes - Disclaimer - Release notes - To do list ############################ # Install notes # ############################ [ *** Most of the install notes have been superceded by including the correlation toolbox in the GISMO suite. If the GISMO suite if tools is being installed, then the correlation toolbox should install automatically. *** ] Uncompress the distribution into a directory where you keep matlab codes. The correlation toolbox is written according to the protocols of a matlab object. In order to use a matlab object, all directories beginning with "@" must be in the matlab path. This can be done one of three ways: (1) select the FILE pulldown menu and then SET PATH; (2) edit your startup.m files; or (3) use the addpath command to include the path for just a single matlab session. You can test whether the correct path is set by entering HELP CORRELATION. If you see the correlation help page then the path has been set correctly. If you have downloaded the waveform suite as well, it is important to first consult the waveform toolbox documentation (and test dat importing directly) to ensure that you have set up the necessary components to interface with your desired data source. The cookbook in @correlation/html/correlation_cookbook.html (or .pdf) provides an overview of basic features. Detailed useage information can be obtained from the help pages. I have made considerable effort to include good documentation. However I am sure it is incomplete and/or lacking. Please let me know what problems you find or if you have trouble getting started with the correlation toolbox. I would be happy to help if I can and I will certainly use any comments to improve the future generations of the code. ############################ # Disclaimer # ############################ This is beta software. There ARE bugs. This software was written initially for in-house use in the Alaska Volcano Observatory and the Geophysical Institute at the University of Alaska Fairbanks. There was enough interest as it developed to warrant packaging it for distribution to other researchers pursuing similar topics. To get the full use of this toolbox, it is important to understand something about how the underlying waveform object operates. It is advisable to get a feel for how the waveform objects "thinks" before moving on to correlation objects, as the correlation toolbox is built on top of waveform. If you write interesting extensions to this code (really quite easy) let me know and I will integrate them into the toolbox. Use at your own risk. The author assumes no liability for code that is confusing, misleading, or just plain wrong though reports of bugs are always welcomed. This software may be distributed freely and edited at will. For any productive uses, I would appreciate if the code is cited. Michael West November 2007 ############################ # Release notes v2.0 + # ############################ For code modifications since 2009, see the SVN repository change log: https://code.google.com/p/gismotools/source/list June 2009 Note that future updates to correlation will not be tracked through a formal release number. Following 2.0, changes in the correlation toolbox will be tracked by SVN revision number. This is a more honest accounting of how the correlation toolbox is actually maintained. GETCLUSTERSTAT function added to extract relevent parameters from the CLUSTER field. (January 2, 2009) This release warrants 2.0 because there have been substantial improvements to the correlation data calls and the actual CORRELATION constructor itself. Most of these changes have been made to make use of the new DATASOURCE and SCNLOBJECT objects and WAVEFORM version 1.8 which makes use of them. This allows much more flexible loading of waveforms and in many cases, vastly improved speed. Users are strongly encouraged to invest a few minutes to understand these tools. While these my appear to be more work on the surface, the power they bring justifies the code changes. Older function calls to CORRELATION work. However they are unlikely to be maintained in the future. New WAVEFORM function and CORRELATION uageage to allow waveforms to be quickly extracted from a correlation obejct and replaced, presumeably after manipulation. See HELP CORRELATION/WAVEFORM. Demo dataset upgraded to use scnlobjects. See CORRELATION('DEMO') Default iterferogram plotting no longering normalizes by trace amplitudes. If this is important, use the NORM command before plotting. New TAPER, SIGN, HILBERT, DETREND, INTEGRATE and DIFF functions added. These are mostly wrappers around the WAVEFORM versions of the same. CORRELATION_COOKBOOK was moved outside of the toolbox and into GISMO/contributed. ############################ # Release notes v1.6 # ############################ November 2008 An option in ADJUSTTRIG which makes use of event clusters is included by not completed, nor ready for use. In the works ... Revised the interferogram plotting options such that plots invoking the 'LAG' style use a shaded coloring scheme to show the lag and correlation value concurrently. A red-yellow-blue hus represents the lag time relative to the reference trace. These colors are progressively faded to represent the correlation value. Bug fix in ADJUSTTRIG when using the timeshift feature. ############################ # Release notes v1.5 # ############################ March 2008 revised LINKAGE, CLUSTER and dendrogram plotting routines to minimize references to the obscure concept of dissimilarity. Since clusters in the correlation toolbox are almost always based on the idea of correlation, these functions were revised to operate directly on correlation values. This is a hack because the underlying Matlab routines deal with dissimilarity. The LINK field still stores values as dissimilarity. However the two main (only?) uses of the linkage field (to create clusters and to plot dendrogram) now work natively with correlation values. the CLUSTER routine was modified so that when used as CLUSTER(c,CUTOFF), CUTOFF is now given as an inter-cluster correlation vlaue instead of dissimilarity. In practice, CUTOFF has become 1-CUTOFF. THIS IS A BREAK (THOUGH MINOR) IN BACKWARD COMPATIBILITY. added a default use for the most common LINKAGE method (average). Now c=LINKAGE(c) is the same as c=LINKAGE(c,'average'). the dendrogram plotting routine was modified to display "inter-cluster correlation" instead of dissimilarity. All that was really changed in xais labels, the orientation of the x axis and the xlabel. The change is important, but hopefully it is a shift toward a more intuitive concept. If the CLUST field is filled, then the cluster number is now included on the dendrogram plot Y-axis. ############################ # Release notes v1.4 # ############################ October 30, 2007 fixed bug in align and stack routines that could introduce traces of different lengths. ############################ # Release notes v1.3 # ############################ August 30, 2007 Added direct access to the correlation README and COOKBOOK texts from the correlation function. Changed PLOT so that station names and channels are displayed on the Y-axis when multiple stations are present. PLOT makes some attempt to determine whether the data represent an "event gather" or a "receiver gather". Revised XCORR routine to adds polynomial interpolation of lag and correlation values to estimate lag times with sub-samp