.TH SPECTRUM1D 1gmt "15 Jul 2011" "GMT 4.5.7" "Generic Mapping Tools"
.SH NAME
spectrum1d \- compute auto\- [and cross\- ] spectra from one [or two] timeseries.
.SH SYNOPSIS
\fBspectrum1d\fP [ \fIx[y]file\fP ] \fB\-S\fP\fIsegment_size\fP] 
[ \fB\-C\fP[\fBxycnpago\fP] ] [ \fB\-D\fP\fIdt\fP ] 
[ \fB\-N\fP\fIname_stem\fP ] [ \fB\-V\fP ] [ \fB\-W\fP ] 
[ \fB\-b\fP[\fBi\fP|\fBo\fP][\fBs\fP|\fBS\fP|\fBd\fP|\fBD\fP[\fIncol\fP]|\fBc\fP[\fIvar1\fP\fB/\fP\fI...\fP]] ] [ \fB\-f\fP[\fBi\fP|\fBo\fP]\fIcolinfo\fP ]
.SH DESCRIPTION
\fBspectrum1d\fP reads X [and Y] values from the first [and second] columns on standard input 
[or \fIx[y]file\fP].  These values are treated as timeseries X(t) [Y(t)] sampled at equal intervals 
spaced \fIdt\fP units apart.  There may be any number of lines of input.  \fBspectrum1d\fP will create 
file[s] containing auto\- [and cross\- ] spectral density estimates by Welch's method of ensemble\"'
averaging of multiple overlapped windows, using standard error estimates from Bendat and Piersol.
.sp
The output files have 3 columns: f or w, p, and e.  f or w is the frequency or wavelength, p is the 
spectral density estimate, and e is the one standard deviation error bar size.  These files are named 
based on \fIname_stem\fP.  If the \fB\-C\fP option is used, up to eight files are created; otherwise only one 
(xpower) is written.  The files (which are ASCII unless \fB\-bo\fP is set) are as follows:
.TP
\fIname_stem\fP.xpower
Power spectral density of X(t).  Units of X * X * \fIdt\fP.
.TP
\fIname_stem\fP.ypower
Power spectral density of Y(t).  Units of Y * Y * \fIdt\fP.
.TP
\fIname_stem\fP.cpower
Power spectral density of the coherent output.  Units same as ypower.
.TP
\fIname_stem\fP.npower
Power spectral density of the noise output.  Units same as ypower.
.TP
\fIname_stem\fP.gain
Gain spectrum, or modulus of the transfer function.  Units of (Y / X).
.TP
\fIname_stem\fP.phase
Phase spectrum, or phase of the transfer function.  Units are radians.
.TP
\fIname_stem\fP.admit
Admittance spectrum, or real part of the transfer function.  Units of (Y / X).
.TP
\fIname_stem\fP.coh
(Squared) coherency spectrum, or linear correlation coefficient as a function of frequency.  
Dimensionless number in [0, 1].  The Signal-to-Noise-Ratio (SNR) is coh / (1 - coh).  SNR = 1 when coh = 0.5.
.SH REQUIRED ARGUMENTS
.TP
\fIx[y]file\fP
ASCII (or binary, see \fB\-bi\fP) file holding X(t) [Y(t)] samples in the first 1 [or 2] columns.
If no file is specified, \fBspectrum1d\fP will read from standard input.
.TP
\fB\-S\fP
\fIsegment_size\fP is a radix-2 number of samples per window for ensemble averaging.  The smallest frequency 
estimated is 1.0/(\fIsegment_size\fP * \fIdt\fP), while the largest is 1.0/(2 * \fIdt\fP).  One standard error 
in power spectral density is approximately 1.0 / sqrt(\fIn_data\fP / \fIsegment_size\fP), so if \fIsegment_size\fP 
= 256, you need 25,600 data to get a one standard error bar of 10%.  Cross-spectral error bars are larger and more 
complicated, being a function also of the coherency. 
.SH OPTIONS
.sp
.TP
\fB\-C\fP
Read the first two columns of input as samples of two timeseries, X(t) and Y(t).
Consider Y(t) to be the output and X(t) the input in a linear system with noise.
Estimate the optimum frequency response function by least squares, such that the
noise output is minimized and the coherent output and the noise output are
uncorrelated.
Optionally specify up to 8 letters from the set { \fBx y c n p a g o\fP }
in any order to create only those output files instead of the default [all].
\fBx\fP = xpower, \fBy\fP = ypower, \fBc\fP = cpower, \fBn\fP = npower,
\fBp\fP = phase, \fBa\fP = admit, \fBg\fP = gain, \fBo\fP = coh.
.TP
\fB\-D\fP
\fIdt\fP  Set the spacing between samples in the timeseries [Default = 1].
.TP
\fB\-N\fP
\fIname_stem\fP  Supply the name stem to be used for output files [Default = "spectrum"].
.TP
\fB\-V\fP
Selects verbose mode, which will send progress reports to stderr [Default runs "silently"].
.TP
\fB\-W\fP
Write Wavelength rather than frequency in column 1 of the output file[s] [Default = frequency, (cycles / \fIdt\fP)].
.TP
\fB\-bi\fP
Selects binary input.
Append \fBs\fP for single precision [Default is \fBd\fP (double)].
Uppercase \fBS\fP or \fBD\fP will force byte-swapping.
Optionally, append \fIncol\fP, the number of columns in your binary input file
if it exceeds the columns needed by the program.
Or append \fBc\fP if the input file is netCDF. Optionally, append \fIvar1\fP\fB/\fP\fIvar2\fP\fB/\fP\fI...\fP to
specify the variables to be read.
[Default is 2 input columns].
.TP
\fB\-bo\fP
Selects binary output.
Append \fBs\fP for single precision [Default is \fBd\fP (double)].
Uppercase \fBS\fP or \fBD\fP will force byte-swapping.
Optionally, append \fIncol\fP, the number of desired columns in your binary output file.
[Default is 2 output columns].
.TP
\fB\-f\fP
Special formatting of input and/or output columns (time or geographical data).
Specify \fBi\fP or \fBo\fP to make this apply only to input or output [Default applies to both].
Give one or more columns (or column ranges) separated by commas.
Append \fBT\fP (absolute calendar time), \fBt\fP (relative time in chosen \fBTIME_UNIT\fP since \fBTIME_EPOCH\fP),
\fBx\fP (longitude), \fBy\fP (latitude), or \fBf\fP (floating point) to each column
or column range item.  Shorthand \fB\-f\fP[\fBi\fP|\fBo\fP]\fBg\fP means \fB\-f\fP[\fBi\fP|\fBo\fP]0\fBx\fP,1\fBy\fP
(geographic coordinates).
.SH ASCII FORMAT PRECISION
The ASCII output formats of numerical data are controlled by parameters in
your \.gmtdefaults4 file.  Longitude and latitude are formatted according to
\fBOUTPUT_DEGREE_FORMAT\fP, whereas other values are formatted according
to \fBD_FORMAT\fP.  Be aware that the format in effect can lead to loss of
precision in the output, which can lead to various problems downstream.  If
you find the output is not written with enough precision, consider switching
to binary output (\fB\-bo\fP if available) or specify more decimals using
the \fBD_FORMAT\fP setting.
.SH EXAMPLES
Suppose data.g is gravity data in mGal, sampled every 1.5 km.  To write its power spectrum, in mGal**2-km, 
to the file data.xpower, use  
.sp
\fBspectrum1d\fP data.g \fB\-S\fP256 \fB\-D\fP1.5 \fB\-N\fPdata
.sp
Suppose in addition to data.g you have data.t, which is topography in meters sampled at the same points as 
data.g.  To estimate various features of the transfer function, considering data.t as input and data.g as 
output, use
.sp
paste data.t data.g | \fBspectrum1d\fP \fB\-S\fP256 \fB\-D\fP1.5 \fB\-N\fPdata \fB\-C\fP
.SH "SEE ALSO"
.IR GMT (1),
.IR grdfft (1)
.SH REFERENCES
Bendat, J. S., and A. G. Piersol, 1986, Random Data, 2nd revised ed., John Wiley & Sons.
.br
Welch, P. D., 1967, The use of Fast Fourier Transform for the estimation of power spectra:  a method 
based on time averaging over short, modified periodograms, IEEE Transactions on Audio and Electroacoustics, 
Vol AU-15, No 2.