GENERAL COMMENTS

Congratulations, you must have downloaded and decompressed the archive
Swave.tar.z if you got to that point and you can read this file.

Swave is a library of Splus functions which provide an
environment for the Time-Frequency analysis of 1-D signals (and
especially for the wavelet and Gabor transforms of noisy signals.) 
It was written by Rene Carmona, Bruno Torresani, and Wen L. Hwang,
first at the University of California at Irvine and then at Princeton
University. Credit should also be given to Andrea Wang whose functions
on the dyadic wavelet transform are included.  Swave was developed for
Splus to appeal to the statistics community. Swave is based on the book:

"PRACTICAL TIME-FREQUENCY ANALYSIS: Gabor and Wavelet Transforms with
                     an Implementation in S"
         by Rene Carmona,  Wen L. Hwang and Bruno Torresani
                      Academic Press (1998)

For suggestions, complains, .... to report a bug, .... write to

                    rcarmona@princeton.edu


INSTALLATION OF THE SWAVE PACKAGE

Swave should run with any version of Splus. Unfortunately, since many
of the Swave S-functions are calling compiled C-code. hardware
configuration is necessarily a factor, whether we like it or not.
The following list of suggestions is intended to help the first time
Swave users compile and load the Swave library on an SGI platform.
We suspect that similar procedures will work on most other UNIX
platforms. We will test Swave for the Window NT version of Splus and
we will include instructions in the next release of this README file.
 
To compile and run Swave on a SGI platform, type:

$$ Splus SHLIB -o swave.so *.c

at the UNIX prompt. Then, enter Splus by typing 

$$ Splus. 

You will see the error message :

> Error: couldn't find function ".First"

This means that you need to load the
S functions provided by the Swave package. 
To do so, you just type

> source(".First")

After this is done you leave Splus the usual way by typing:

> q()
 
Next you re-enter Splus and wait for the motif window (if
you have X-window environment.)
At this point you should be able to use the functions contained in the
Swave package.


CONTENTS OF THE ARCHIVE

All the signals used as illustrations in the book

" PRACTICAL TIME-FREQUENCY ANALYSIS: Gabor and Wavelet Transforms with
an Implementation in S"

are included in this archive. Most of them are provided as ASCII files
to be scanned in Splus. They are found in the subdirectory signals.
A small number of files are provided in binary format in the .Data directory.

List of S commands:
The Swave library contains all the functions used in the book together
with a set of utilities. All of them have an on-line help file (whose
text is  reproduced in the book.)
These functions and utilities are listed below.

A.  The Swave S commands:
cfamily
cgt
cleanph
corona
coronoid
crc
crcrec
cwt
cwtp
cwtsquiz
DOG
dwinverse
ext
gabor
gcrcrec
gregrec
gridrec
hurst.est
icm
mbtrim
mntrim
morlet
mrecons
mw
scrcrec
regrec
regrec2
ridrec
skeleton
skeleton2
snake
snakoid
sridrec
tfgmax
tflmax
tfmean
tfpct
tfvar
vgt
vDOG
vwt
zeroskeleton
zeroskeleton2

B. Swave S utilities commands:
adjust.length
check.maxresoln
crfview
cwtimage
cwtpolar
epl
fastgkernel
fastkernel
gkernel
gsampleone
gwave
gwave2
kernel
morwave
morwave2
npl
plot.result
plotwt
RidgeSampling
rkernel
smoothts
smoothwt
snakeview
SVD
vecgabor
vecmorlet
wpl
wRidgeSampling
zerokernel

