Thread: Fix for the missing equation in the help file of 'envelope'

Started: 2008-08-29 00:40:24
Last activity: 2008-08-29 00:40:24
Topics: SAC Developers
Hi,

An equation is missing from the help file of 'envelope': sqrt(x(n)^2 + y(n)^2).

Here is the fix (I've formatted the paragraph after inserting the
missing equation):

$ diff -u aux/help/envelope.old aux/help/envelope
--- aux/help/envelope.old 2008-08-28 17:33:18.000000000 -0400
+++ aux/help/envelope 2008-08-28 17:34:10.000000000 -0400
@@ -9,9 +9,9 @@

DESCRIPTION:
This command computes the envelope function of the data in memory. The
-envelope is defined by: where x(n) is the original signal and y(n) its
-Hilbert transform (see HILBERT.) As with HILBERT, very long period data
-should be decimated (see DECIMATE) prior to processing.
+envelope is defined by: sqrt(x(n)^2 + y(n)^2), where x(n) is the original
+signal and y(n) its Hilbert transform (see HILBERT.) As with HILBERT, very
+long period data should be decimated (see DECIMATE) prior to processing.

HEADER CHANGES:
DEPMIN, DEPMAX, DEPMEN


Best regards,

--
Kuang He
Department of Physics
University of Connecticut
Storrs, CT 06269-3046

Tel: +1.860.486.4919
Web: http://www.phys.uconn.edu/~he/

Page built 06:26:26 | v.090361a2