1 |
%DIWASP Version 1.1 help file |
---|
2 |
%This describes the three structures used in DIWASP functions |
---|
3 |
% |
---|
4 |
%The input data structure(ID) contains fields: |
---|
5 |
% ID.data measured wave data matrix - data in columns, one column per sensor |
---|
6 |
% ID.layout layout of the sensors - x,y,z in each column. |
---|
7 |
% x and y from arbitrary origin and z measured upwards from seabed (m) |
---|
8 |
% ID.datatypes sensor type. Enter as cell list: e.g. {'elev' 'pres'}. Currently supported: |
---|
9 |
% 'elev' surface elevation |
---|
10 |
% 'pres' pressure |
---|
11 |
% 'velx' x component velocity |
---|
12 |
% 'vely' y component velocity |
---|
13 |
% 'velz' z component velocity |
---|
14 |
% 'vels' vertical velocity of surface |
---|
15 |
% 'accs' vertical acceleration of surface |
---|
16 |
% 'slpx' x component surface slope |
---|
17 |
% 'slpy' y component surface slope |
---|
18 |
% ID.depth mean overall depth of measurement area (m) |
---|
19 |
% ID.fs sampling frequency of instruments - must be single figure for all (Hz) |
---|
20 |
% |
---|
21 |
%The spectral matrix structure(SM) contains fields: |
---|
22 |
% SM.freqs vector of length nf defining the bin centres of the spectral matrix frequency axis |
---|
23 |
% SM.dirs vector of length nd defining the bin centres of the spectral matrix direction axis |
---|
24 |
% SM.S matrix of size [nf,nd] containing the actual spectral density |
---|
25 |
% SM.xaxisdir compass direction of the x axis. |
---|
26 |
% |
---|
27 |
%The estimation parameter(EP) structure contains the fields: |
---|
28 |
% EP.method estimation method used. Currently supported: |
---|
29 |
% 'DFTM' Direct Fourier transform method |
---|
30 |
% 'EMLM' Extended maximum likelihood method |
---|
31 |
% 'IMLM' Iterated maximum likelihood method |
---|
32 |
% 'EMEP' Extended maximum entropy principle |
---|
33 |
% 'BDM' Bayesian direct method |
---|
34 |
% EP.nfft number of DFTs used to calculate the frequency spectra: frequency resolution is (EP.nfft)/2 |
---|
35 |
% EP.dres directional resolution of calculation itself specified as the number of directional bins |
---|
36 |
% which cover the whole circle. Note that the actual output resolution is determined by SM.dirs |
---|
37 |
% EP.iter number of iterations: this has various effects for different methods |
---|
38 |
% EP.smooth smoothing applied: 'ON' or 'OFF' |
---|
39 |
% |
---|
40 |
|
---|
41 |
|
---|
42 |
|
---|
43 |
%%Note that the name of the structures are arbitrary but the field names must not be changed. |
---|
44 |
|
---|
45 |
%This file is only a help file |
---|