| LTPDA Toolbox™ | contents | ![]() |
DISPERSION computes the dispersion function
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DESCRIPTION: dipersionLoop computes the dispersion function in loop
CALL: bs = dipersion(in,pl)
INPUTS: in - matrix objects with input signals to the system
model - symbolic models containing the transfer function model
pl - parameter list
OUTPUTS: bs - dispersion function AO
Parameters Description
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
| Method Details | |
|---|---|
| Access | public |
| Defining Class | matrix |
| Sealed | 0 |
| Static | 0 |
| Sets for this method … |
|---|
| Default |
Default |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| dispersionLoop | |||
| WIN | 'Hanning' |
|
The window to be applied to the data to remove the discontinuities at edges of segments. [default: taken from user prefs] Only the design parameters of the window object are used. Enter a string value containing the window name e.g. plist('Win', 'Kaiser', 'psll', 200) plist('Win', 'BH92') |
| PSLL | 200 | none | The peak sidelobe level for Kaiser windows. Note: it is ignored for all other windows |
| OLAP | -1 | none | The segment percent overlap [-1 == take from window function] |
| ORDER, N | 0 |
|
The order of segment detrending:
|
| DROP WINDOW SAMPLES | 1 |
|
Drop the recommended (by the window) number of samples of the final computed spectral series. |
| TIMES, SPLIT | [] | none | The time range to analyze. If not empty, sets the time interval to operate on. As in ao/split, the interval can be specified by:
|
| MASK | [] | none | Mask out segments in the averaging process. The mask should be a vector of logical values, one value per segment being averaged. The plist method [psdSegments] can be used to generate a default mask for your PSD settings. If empty, all segments will be included in the average. |
| KDES | 100 | none | The desired number of averages. |
| JDES | 1000 | none | The desired number of spectral frequencies to compute. |
| LMIN | 0 | none | The minimum segment length. |
| NAVS | 1 | none | |
| F1 | [] | none | Initial frequency for the analysis |
| F2 | [] | none | Final frequency for the analysis |
| FITPARAMS | '' | none | Parameters of the model |
| MODEL | '' | none | An array of matrix models |
| NOISE | '' | none | An array of matrices with the cross-spectrum matrices |
| BUILT-IN | '' | none | Symbolic models of the system as a string of built-in models |
| FREQUENCIES | '' | none | Array of start/sop frequencies where the analysis is performed |
| PINV | 1 |
|
Use the Penrose-Moore pseudoinverse |
| TOL | [] | none | Tolerance for the Penrose-Moore pseudoinverse |
| DIFFSTEP | [] | none | Numerical differentiation step for ssm models |
| INNAMES | [] | none | The input names for the SSM. |
| OUTNAMES | [] | none | The output names for the SSM. |
| PARAMSVALUES | [] | none | The numerical parameter values. |
| ITERATIONS | [] | none | The total number of iterations. |
Example |
|---|
| plist('WIN', 'Hanning', 'PSLL', [200], 'OLAP', [-1], 'ORDER', [0], 'DROP WINDOW SAMPLES', [true], 'TIMES', [[]], 'MASK', [[]], 'KDES', [100], 'JDES', [1000], 'LMIN', [0], 'NAVS', [1], 'F1', [[]], 'F2', [[]], 'FITPARAMS', '', 'MODEL', '', 'NOISE', '', 'BUILT-IN', '', 'FREQUENCIES', '', 'PINV', [true], 'TOL', [[]], 'DIFFSTEP', [[]], 'INNAMES', [[]], 'OUTNAMES', [[]], 'PARAMSVALUES', [[]], 'ITERATIONS', [[]]) |
back to top
| Some information of the method matrix/dispersionLoop are listed below: | |
|---|---|
| Class name | matrix |
| Method name | dispersionLoop |
| Category | Signal Processing |
| Package name | ltpda |
| Can be used as modifier | 1 |
| Supported numeric types | {'double'} |
|
Method: matrix/dispersion | Method: matrix/downsample | ![]() |
©LTP Team