Wavelet

This command performs a wavelet analysis on a contiguous data set.

 

Syntax

Wavelet [options];

Menu Equivalent

Analysis→Contiguous Data→Wavelet→Wavelets

Button Equivalent

Wavelet.png

Available Options

Description of options

Function = Haar | FTH | MexHat | Morlet | Sine | TTH | STH | Boater | Sombrero | WSW | MSW | NSW

The Function parameter specifies the wavelet template or kernel used in the analysis. WSW, MSW, and NSW imply three-dimensional analysis three-dimensional analysis and require the matrices specified by Data1 and Data2 to be three-dimensional. TTH, STH, Boater and Sombrero imply two-dimensional analysis, while the remaining methods all imply one-dimensional analysis. A method must be specified; there is no default.

Wrap = Yes | No

If Function refers to a one-dimensional analysis, this parameter controls whether the ends of the data transect will be wrapped or remain linear. The default is No.

MaxScale = Number

This specifies the maximum scale (as a percent of the size of the data matrix) over which to calculate the wavelet. This value can generally range from 0 to 50. The default is 10.

ScaleFactor = Number

This value is used to indicate the scale of the data quadrats. For example, if each quadrat is 10cm in size and you wish the results to be presented in meters, ScaleFactor should equal 0.1. On the other hand if you wish the results to be presented in cm, ScaleFactor should equal 10. It has no direct impact on the analysis; it only affects the units of the output. The default is 1.0.

Permute = Yes | No

Specifies whether a randomization tests is being performed to estimate null distributions. Permutation parameters include Permutations, Interval, PermScale, PermPos, and PermW.

Permutations = Number

When Permute = Yes, this controls the number of permutations that are being performed in the permutation test. The default is 999 (the minimum is 49).

Interval = Number

When Permute = Yes, specifies the width of the null distribution interval to be determined by the permutation test. The default is 0.95.

PermScale = Yes | No

When Permute = Yes, specifies whether a permutation test should be used to set a null distribution for the scale variance. The default is Yes.

PermPos = Yes | No

When Permute = Yes, specifies whether a permutation test should be used to set a null distribution for the positional variance. The default is No.

PermW = Yes | No

When Permute = Yes, specifies whether a permutation test should be used to set a null distribution for the scale × positional variance. The default is No.

Save = Yes | No

Controls whether the output is saved into independent matrices. The default is No.

ScaleName = Name

When Save = Yes, this specifies the name of the output matrix for the scale variance. This name cannot be identical to the names of any other matrices already in memory.

PosName = Name

When Save = Yes, this specifies the name of the output matrix for the positional variance. This name cannot be identical to the names of any other matrices already in memory.

WName = Name

When Save = Yes, this specifies the name of the output matrix for the scale × positional variance. This name cannot be identical to the names of any other matrices already in memory.

Data = Name | #Number

Specifies the data matrix. This can be rectangular or a 3D data matrix.

 

The following options apply when Data refers to a two-dimensional data matrix and Function refers to a one-dimensional analysis.

 

Column, Row = Name | #Number

This specifies the column or row in the matrix containing the one-dimensional data array to perform the wavelet analysis on. Only one of Column and Row may be specified.

 

The following options apply when Data refers to three-dimensional data matrix and Function refers to a one-dimensional analysis.

 

XCol = [Name | #Number, Name | #Number]

YCol = [Name | #Number, Name | #Number]

ZCol = [Name | #Number, Name | #Number]

For three-dimensional data matrices and one-dimensional analyses, these specify the specific column to be analyzed by the specified Function. Only one of these parameters can be used.

 

The following options apply when Data refers to a three-dimensional data matrix and Function refers to a two-dimensional analysis.

 

XYPlane = Name | #Number

XZPlane = Name | #Number

YZPlane = Name | #Number

For three-dimensional data matrices and two-dimensional analyses, these specify which plane is to be analyzed by the specified Function. Only a single of these parameters can be used.