Set or Return Wavelet Options

DESCRIPTION:
Provides a means to control some of the default behavior of the wavelet analysis. The options contained here can also, in general, be used as arguments to other high-level wavelet and cosine analysis functions.

USAGE:
wavelet.options(..., type="wp")

OPTIONAL ARGUMENTS:
...:
a list may be given as the only argument, or a vector of character strings given as the only argument, or any number of arguments may be in the name=value form, or no argument at all may be given.
type:
one of "wp", "wp.2d", "cp", "cp.2d".


WP OPTION NAMES:
wavelet:
a character string giving the name of the wavelet. Available wavelets are:

"c6", c12", "c18", "c24", "c30"; "d2", "d4", "d6", "d8", "d10", "d12", "d14", "d16", "d18", "d20"; "s4", "s6", "s8", "s10", "s12", "s14", "s16", "s18", "s20". "bs1.1", "bs1.3", "bs1.5", "bs2.2", "bs2.4", "bs2.6", "bs2.8", "bs3.1", "bs3.3", "bs3.5", "bs3.7", "bs3.9"; "vs1", "vs2", "vs3".

The default value is "s8".

n.levels:
The default value is 6.
boundary:
a character string giving the boundary rules. Available boundary rules are "periodic", "polynomial", "poly0", "poly1", "poly2", "zero", "reflection", "interval", "infinite". The default value is NULL and is set based on sample size, filter length in the following way:

if n.levels (supplied by user or default value) can be achieved by "periodic" boundary rule (i.e. sample size is divisible by 2^n.levels), then the boundary is set to be "periodic"; otherwise, the boundary is set to be either "reflection" (if the filters are symmetric/anti-symmetric, e.g. B-spline), or "zero".

precondition:
logical flag, The default value is FALSE. For boundary="interval" only.
pdeg:
degree of polynomial. The default value is 0. For boundary="polynomial" or "infinite" only.
pfrac:
a real number between 0 and 1 representing the fraction of data used to fit the polynomial. The default value is 0. Non-zero value is for boundary="infinite" only.
dual:
logical flag indicating if dual filter is used as analysis filter.
name.style:
The default value is "pretty". If name.style="pretty", the crystal names will be either in the form of "s.X", "d.X" (for DWT related objects), where X is the level number; or "wX.Y" where X is the level number and Y is the block number. Otherwise, the crystal names will be combinations of "L"s and "H"s.


WP.2D OPTION NAMES:
wavelet:
a character vector of length one or two, giving the name(s) of the wavelet(s). If length(wavelet)=2, the first one is the rows and the second one is the columns; else the rows and the columns use the same wavelet. See above for all available wavelets. The default value is "s8".
n.levels:
The default value is 4.
boundary:
a character string giving the boundary rules. Available boundary rules are "periodic", "poly0", "poly1", "poly2", "zero", "reflection", "interval". The default value is 4.
precondition:
logical flag, The default value is FALSE. For boundary="interval" only.
dual:
logical flag indicating if dual filter is used as analysis filter.
name.style:
The default value is "pretty". Two dimensional crystal names are of the form: "1D.name-1D.name", and name.style="pretty" causes the 1D crystal names to be "pretty". See above for details.


CP OPTION NAMES:
n.levels:
The default value is 6.
dct.type:
one of 2 or 4 indicating which of DCT-II or DCT-IV should be used. The default value is 2.
taper:
a character string, indicating the taper function: "boxcar", "poly1", "poly2", "poly3", "poly4", "poly5", or "trig". The default value is "poly2".
boundary:
a character string, available boundary rules: "cp.reflect", "periodic" and "zero". The default value is "periodic".
n.taper:
number of values to be tapered. The default value is NULL, will be computed from sample size n and n.levels in the following way: n.taper = n/2^(n.levels+1).


CP.2D OPTION NAMES:
n.levels:
The default value is 4.
dct.type:
one of 2 or 4 indicating which of DCT-II or DCT-IV should be used. The default value is 2.
taper:
a character string, indicating the taper function: "boxcar", "poly1", "poly2", "poly3", "poly4", "poly5", or "trig". The default value is "poly2".
boundary:
a character string, available boundary rules: "cp.reflect", "periodic" and "zero". The default value is "periodic".
n.taper:
number of values to be tapered. The default value is NULL, will be computed from dimensions of the image x n = min(dim(x)) and n.levels in the following way: n.taper = n/2^(n.levels+1).

SIDE EFFECTS:
The default behavior of the high level functions is modified. This function also changes the value of the data set .Wp.Options, .Wp.2d.Options, .Cp.Options, or .Cp.2d.Options on frame 0.

SEE ALSO:
cp.dict , cp.dict.2d , max.level , wp.dict , wp.dict.2d .

EXAMPLES:
wavelet.options(wavelet="d4")  # set the default wavelet to d4