## Rechercher une page de manuel

Chercher une autre page de manuel:

# trend1d.1gmt

Langue: en

Autres versions - même langue

Version: 333890 (ubuntu - 24/10/10)

Section: 1 (Commandes utilisateur)

# Sommaire

## NAME

trend1d - Fit a [weighted] [robust] polynomial [or Fourier] model for y = f(x) to xy[w] data.

## SYNOPSIS

trend1d -Fxymrw -N[f]n_model[r] [ xy[w]file ] [ -Ccondition_number ] [ -H[i][nrec] ] [ -I[confidence_level] ] [ -V ] [ -W ] [ -:[i|o] ] [ -b[i|o][s|S|d|D[ncol]|c[var1/...]] ] [ -f[i|o]colinfo ]

## DESCRIPTION

trend1d reads x,y [and w] values from the first two [three] columns on standard input [or xy[w]file] and fits a regression model y = f(x) + e by [weighted] least squares. The functional form of f(x) may be chosen as polynomial or Fourier, and the fit may be made robust by iterative reweighting of the data. The user may also search for the number of terms in f(x) which significantly reduce the variance in y.

## REQUIRED ARGUMENTS

-F
Specify up to five letters from the set {x y m r w} in any order to create columns of ASCII [or binary] output. x = x, y = y, m = model f(x), r = residual y - m, w = weight used in fitting.
-N
Specify the number of terms in the model, n_model, whether to fit a Fourier (-Nf) or polynomial [Default] model, and append r to do a robust fit. E.g., a robust quadratic model is -N3r.

## OPTIONS

xy[w]file
ASCII [or binary, see -b] file containing x,y [w] values in the first 2 [3] columns. If no file is specified, trend1d will read from standard input.
-C
Set the maximum allowed condition number for the matrix solution. trend1d fits a damped least squares model, retaining only that part of the eigenvalue spectrum such that the ratio of the largest eigenvalue to the smallest eigenvalue is condition_#. [Default: condition_# = 1.0e06. ].
-H
Input file(s) has header record(s). If used, the default number of header records is N_HEADER_RECS. Use -Hi if only input data should have header records [Default will write out header records if the input data have them]. Blank lines and lines starting with # are always skipped.
-I
Iteratively increase the number of model parameters, starting at one, until n_model is reached or the reduction in variance of the model is not significant at the confidence_level level. You may set -I only, without an attached number; in this case the fit will be iterative with a default confidence level of 0.51. Or choose your own level between 0 and 1. See remarks section.
-V
Selects verbose mode, which will send progress reports to stderr [Default runs "silently"].
-W
Weights are supplied in input column 3. Do a weighted least squares fit [or start with these weights when doing the iterative robust fit]. [Default reads only the first 2 columns.]
-:
Toggles between (longitude,latitude) and (latitude,longitude) input and/or output. [Default is (longitude,latitude)]. Append i to select input only or o to select output only. [Default affects both].
-bi
Selects binary input. Append s for single precision [Default is d (double)]. Uppercase S or D will force byte-swapping. Optionally, append ncol, the number of columns in your binary input file if it exceeds the columns needed by the program. Or append c if the input file is netCDF. Optionally, append var1/var2/... to specify the variables to be read. [Default is 2 (or 3 if -W is set) columns].
-bo
Selects binary output. Append s for single precision [Default is d (double)]. Uppercase S or D will force byte-swapping. Optionally, append ncol, the number of desired columns in your binary output file. [Default is 1-5 columns as given by -F].
-f
Special formatting of input and/or output columns (time or geographical data). Specify i or o 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 T (absolute calendar time), t (relative time in chosen TIME_UNIT since TIME_EPOCH), x (longitude), y (latitude), or f (floating point) to each column or column range item. Shorthand -f[i|o]g means -f[i|o]0x,1y (geographic coordinates).

## 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 OUTPUT_DEGREE_FORMAT, whereas other values are formatted according to D_FORMAT. 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 (-bo if available) or specify more decimals using the D_FORMAT setting.

## REMARKS

If a Fourier model is selected, the domain of x will be shifted and scaled to [-pi, pi] and the basis functions used will be 1, cos(x), sin(x), cos(2x), sin(2x), ... If a polynomial model is selected, the domain of x will be shifted and scaled to [-1, 1] and the basis functions will be Chebyshev polynomials. These have a numerical advantage in the form of the matrix which must be inverted and allow more accurate solutions. The Chebyshev polynomial of degree n has n+1 extrema in [-1, 1], at all of which its value is either -1 or +1. Therefore the magnitude of the polynomial model coefficients can be directly compared. NOTE: The stable model coefficients are Chebyshev coefficients. The corresponding polynomial coefficients in a + bx + cxx + ... are also given in Verbose mode but users must realize that they are NOT stable beyond degree 7 or 8. See Numerical Recipes for more discussion. For evaluating Chebyshev polynomials, see gmtmath.

The -Nr (robust) and -I (iterative) options evaluate the significance of the improvement in model misfit Chi-Squared by an F test. The default confidence limit is set at 0.51; it can be changed with the -I option. The user may be surprised to find that in most cases the reduction in variance achieved by increasing the number of terms in a model is not significant at a very high degree of confidence. For example, with 120 degrees of freedom, Chi-Squared must decrease by 26% or more to be significant at the 95% confidence level. If you want to keep iterating as long as Chi-Squared is decreasing, set confidence_level to zero.

A low confidence limit (such as the default value of 0.51) is needed to make the robust method work. This method iteratively reweights the data to reduce the influence of outliers. The weight is based on the Median Absolute Deviation and a formula from Huber [1964], and is 95% efficient when the model residuals have an outlier-free normal distribution. This means that the influence of outliers is reduced only slightly at each iteration; consequently the reduction in Chi-Squared is not very significant. If the procedure needs a few iterations to successfully attenuate their effect, the significance level of the F test must be kept low.

## EXAMPLES

To remove a linear trend from data.xy by ordinary least squares, use:

trend1d data.xy -Fxr -N2 > detrended_data.xy

To make the above linear trend robust with respect to outliers, use:

trend1d data.xy -Fxr -N2r > detrended_data.xy

To find out how many terms (up to 20, say) in a robust Fourier interpolant are significant in fitting data.xy, use:

trend1d data.xy -Nf20r -I -V