| LTPDA Toolbox™ | contents | ![]() |
check if the caller was a user of another method
| Method Details | |
|---|---|
| Access | public |
| Defining Class | ao |
| Sealed | 0 |
| Static | 0 |
Default |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From MAT File |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| FILENAME | '' | none | MAT filename. |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From XML File |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| FILENAME | '' | none | XML filename. |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Repository |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| HOSTNAME | '' | none | Database server hostname. |
| DATABASE | '' | none | Database name. |
| USERNAME | '' | none | User name to use when connecting to the database. Leave blank to be prompted. |
| PASSWORD | {} [0x0] | none | Password to use when connecting to the database. Leave blank to be prompted. |
| CONN | [] | none | Java mysql object. |
| ID, IDS | [] | none | A vector of object IDs. |
| CID | [] | none | A vector of collection IDs. |
| BINARY | 1 |
|
Use binary representation (not always available). |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Built-in Model |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| BUILT-IN | '' | none | Choose one of the built-in models. (use class.getBuiltInModels to get a list for a particular user class) |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From MAT Data File |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| FILENAME | '' | none | MAT data filename. |
| FILEPATH | '' | none | Path to the data file in case the filename is a relative path. |
| TYPE | 'cdata' |
|
Choose the data type. |
| COLUMNS | [] | none | Specify column pairs for the x-y variables, e.g. [1 2 1 4]. Each column pair creates an analysis object. If the value 'fs' is set then each column represents only the y-axes. |
| XUNITS | [s] | none | Unit on X axis. |
| YUNITS | '' | none | Unit on Y axis. |
| FS | [] | none | If this value is set, the x-axes is computed from the fs value. |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From ASCII File |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| FILENAME | '' | none | ASCII filename. |
| FILEPATH | '' | none | Path to the data file in case the filename is a relative path. |
| TYPE | 'cdata' |
|
Choose the data type. |
| COLUMNS | [] | none | Specify column pairs for the x-y variables, e.g. [1 2 1 4]. Each column pair creates an analysis object. If the value 'fs' is set then each column represents only the y-axes. |
| XUNITS | '' | none | Unit on X axis. |
| YUNITS | '' | none | Unit on Y axis. |
| COMMENT_CHAR | '' | none | The comment character in the file. |
| MAXLINES | [] | none | Maximum number of lines which should be read. |
| FS | [] | none | If this value is set, the x-axes is computed from the fs value. |
| ROBUST | 0 |
|
Set this to 'true' to use (slow) robust data reading. Useful for complicated file formats. |
| DELIMITER | '' | none | Field delimiter character(s). |
| T0 | '1970-01-01 00:00:00.000' | none | The UTC time of the first sample. For data types other than tsdata, this is ignored. |
| IGNORELINES | 0 | none | Ignore the first few lines. Reading numeric data starting from line ignoreLines+1. |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Complex ASCII File |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| FILENAME | '' | none | ASCII filename. |
| FILEPATH | '' | none | Path to the data file in case the filename is a relative path. |
| COMPLEX_TYPE | 'real/imag' |
|
String defining the format of the complex data. |
| TYPE | 'fsdata' |
|
String defining the data type |
| COLUMNS | [1 2 3] | none | Colums to consider inside the file. It must be 3 or a multiple: the first column defines the x-axis and the next two columns the complex y-axis. If a multiple of 3 columns are specified, the constructor will output multiple aos. (e.g. [1 2 3]) |
| XUNITS | [Hz] | none | Unit on X axis. |
| YUNITS | '' | none | Unit on Y axis. |
| COMMENT_CHAR | '' | none | The comment character in the file. |
| T0 | '1970-01-01 00:00:00.000' | none | The UTC time of the first sample. For data types other than tsdata, this is ignored. |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Function |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| FCN | '' | none | Any valid MATLAB function. [e.g. 'randn(100,1)'] |
| YUNITS | '' | none | Unit on Y axis. |
| DY | [] | none | A set of errors values for y. |
| RAND_STREAM | [] | none | Internal MATLAB state of the pseudorandom number generator. You can set the state with a structure which should contain all properties of the MATLAB class RandStream |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Values |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| VALS | [] | none | A set of values. |
| DY | [] | none | A set of errors values for y. |
| AXIS | 'y' |
|
If an AO is input in 'vals', this key specifies which axis we get the data from. |
| N | 1 | none | Repeat 'N' times. |
| YUNITS | '' | none | Unit on Y axis |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From XY Values |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| TYPE | '' |
|
The data type. |
| FS | [] | none | Frequency: if this is set, xvals (if passed) will be ignored and the resulting tsdata will contain an X vector sampled according to fs. For data types other than tsdata, this is ignored. |
| T0 | '1970-01-01 00:00:00.000' | none | The UTC time of the first sample. For data types other than tsdata, this is ignored. |
| TOFFSET | 0 | none | The offset between the first x sample and t0. For data types other than tsdata, this is ignored. |
| XVALS | [] | none | A set of x values. |
| YVALS | [] | none | A set of y values. |
| DX | [] | none | A set of errors values for x. |
| DY | [] | none | A set of errors values for y. |
| XUNITS | '' | none | Unit on X axis. |
| YUNITS | '' | none | Unit on Y axis |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From XYZ Values |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| XVALS | [] | none | A set of x values. |
| YVALS | [] | none | A set of y values. |
| ZVALS | [] | none | A set of z values. |
| DX | [] | none | A set of errors values for x. |
| DY | [] | none | A set of errors values for y. |
| DZ | [] | none | A set of errors values for z. |
| XUNITS | '' | none | Unit on X axis. |
| YUNITS | '' | none | Unit on Y axis |
| ZUNITS | '' | none | Unit on Z axis |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Time-series Function |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| TSFCN | 't' | none | A function of time. |
| FS | [] | none | The sampling frequency of the signal. [for all] |
| NSECS | [] | none | The number of seconds of data. [for all] |
| XUNITS | [s] | none | Unit on X axis. |
| T0 | '1970-01-01 00:00:00.000' | none | The UTC time of the first sample. [for all] |
| TOFFSET | 0 | none | The offset between the first x sample and t0. |
| YUNITS | '' | none | Unit on Y axis. |
| DY | [] | none | A set of errors values for y. |
| RAND_STREAM | [] | none | Internal MATLAB state of the pseudorandom number generator. You can set the state with a structure which should contain all properties of the MATLAB class RandStream |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From XY Function |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| XYFCN | 'x' | none | Specify a function of x. (e.g. x.^2) |
| X | [] | none | The x values. |
| XUNITS | '' | none | Unit on X axis. |
| YUNITS | '' | none | Unit on Y axis. |
| DX | [] | none | A set of errors values for x. |
| DY | [] | none | A set of errors values for y. |
| RAND_STREAM | [] | none | Internal MATLAB state of the pseudorandom number generator. You can set the state with a structure which should contain all properties of the MATLAB class RandStream |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Frequency-series Function |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| FSFCN | 'f' | none | A function of frequency. |
| F1 | 1.0000000000000001e-09 | none | The initial frequency. |
| F2 | 10000 | none | The final frequency. |
| NF | 1000 | none | The number of frequency samples. |
| SCALE | 'log' |
|
Choose the frequency spacing. |
| F | [] | none | a vector of frequencies on which to evaluate the function. |
| DY | [] | none | A set of errors values for y. |
| XUNITS | [Hz] | none | Unit on X axis. |
| YUNITS | '' | none | Unit on Y axis. |
| RAND_STREAM | [] | none | Internal MATLAB state of the pseudorandom number generator. You can set the state with a structure which should contain all properties of the MATLAB class RandStream |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Window |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| WIN | 'Hanning' |
|
A Spectral window name. |
| LENGTH | 100 | none | The length of the window (number of samples). |
| PSLL | 150 | none | If you choose a 'kaiser' window, you can also specify the peak-sidelobe-level. |
| LEVELORDER | 2 | none | If you choose a 'levelledHanning' window, you can also specify the order of the contraction. |
| YUNITS | '' | none | Unit on Y axis. |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Waveform |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| WAVEFORM | 'sine wave' |
|
A waveform description. A special case is the 'sine wave' because you can create more sinewaves which are summed. For this case you can add several values for 'A', 'f', 'phi', 'nsecs' and/or 'Toff' |
| A | 1 | none | Amplitude of the signal. [for 'sine wave']. |
| F | 1 | none | Frequency of the signal, in Hz. [for 'sine wave', 'square wave', 'sawtooth']. |
| PHI | 0 | none | Phase of the signal, in rad. [for 'sine wave'] The phase is lag, i.e. y = sin(2*pi*f*t + phi) |
| TOFF | 0 | none | Offset of the different sine waves, as [for 'sine wave']
Offset of the signal, in seconds. [for all other] |
| GAPS | [] | none | Instead of defining an offset it is possible to define a gap before the sine wave. [for 'sine wave'] |
| TYPE | 'Normal' |
|
Noise type. [for 'noise'] |
| SIGMA | 1 | none | The standard deviation of the noise. [for 'noise'] |
| F0 | 1 | none | A fundamental/start frequency of the signal. [for 'chirp', 'gaussian pulse'] |
| F1 | [] | none | The end frequency of the signal. [for 'chirp'] |
| T1 | [] | none | The end time of the signal. [for 'chirp'] |
| BW | [] | none | The bandwidth of the signal. [for 'gaussian pulse'] |
| DUTY | 50 | none | The duty-cycle of the signal (in %). [for 'square wave'] |
| WIDTH | 0.5 | none | The width of the signal. [0-1] [for 'sawtooth'] |
| OFFSET | 0 | none | Offset to be added to the signal. |
| FS | [] | none | The sampling frequency of the signal. [for all] |
| NSECS | [] | none | The number of seconds of data. [for all] |
| XUNITS | [s] | none | Unit on X axis. |
| T0 | '1970-01-01 00:00:00.000' | none | The UTC time of the first sample. [for all] |
| TOFFSET | 0 | none | The offset between the first x sample and t0. |
| YUNITS | '' | none | Unit on Y axis. [for all] |
| RAND_STREAM | [] | none | Internal MATLAB state of the pseudorandom number generator. You can set the state with a structure which should contain all properties of the MATLAB class RandStream |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Polynomial |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| POLYVAL | [] | none | A set of polynomial coefficients. This can also be an AO, in which case the Y values from the AO are used. |
| FS | [] | none | The sampling frequency of the signal. [for all] |
| NSECS | [] | none | The number of seconds of data. [for all] |
| T0 | '1970-01-01 00:00:00.000' | none | The UTC time of the first sample. [for all] |
| TOFFSET | 0 | none | The offset between the first x sample and t0. |
| T | [] | none | Vector of time vertices for tsdata type. The value can also be an AO, in which case the X vector is used. |
| X | [] | none | Vector of X values for xydata type. |
| F | [] | none | Vector of frequency values for fsdata type. |
| TYPE | '' |
|
The data type. If this is empty, the constructor will attempt to determine the type from the other parameters. |
| XUNITS | '' | none | Unit on X axis. |
| YUNITS | '' | none | Unit on Y axis. |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Pzmodel |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| PZMODEL | pzmodel(g:no gain p:no pole z:no zero) | none | A pole/zero model which builds the time-series AO. |
| NDIGITS | 32 | none | Set the number of digits of precision to be used when calculating the noise generation coefficients. |
| FS | [] | none | The sampling frequency of the signal. [for all] |
| NSECS | [] | none | The number of seconds of data. [for all] |
| XUNITS | [s] | none | Unit on X axis. |
| T0 | '1970-01-01 00:00:00.000' | none | The UTC time of the first sample. [for all] |
| TOFFSET | 0 | none | The offset between the first x sample and t0. |
| YUNITS | '' | none | Unit on Y axis. |
| STATE | [] | none | Initial state vector. If empty, and initial state will be calculated. The final state of a noise generation will be stored in the procinfo of the resulting AO. |
| RAND_STREAM | [] | none | Internal MATLAB state of the pseudorandom number generator. You can set the state with a structure which should contain all properties of the MATLAB class RandStream |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Smodel |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| MODEL | smodel() | none | The smodel to evaluate and convert to an AO. |
| X | [] | none | Values for X axis. |
| XUNITS | [s] | none | Unit on X axis. |
| TYPE | 'tsdata' |
|
Choose the data type. |
| RAND_STREAM | [] | none | Internal MATLAB state of the pseudorandom number generator. You can set the state with a structure which should contain all properties of the MATLAB class RandStream |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Pest |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| PEST | [] | none | The pest object to extract the AO from. |
| PARAMETER | '' | none | Name of the parameter(s) to be extracted. If empty, all parameters will be extracted into a vector ao AOs. |
| RAND_STREAM | [] | none | Internal MATLAB state of the pseudorandom number generator. You can set the state with a structure which should contain all properties of the MATLAB class RandStream |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
From Parameter |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| PARAMETER | '' | none | The parameter or plist to make an AO from. If the plist is a built-in one, it is also possible just to input its name. |
| KEY | '' | none | The parameter name to extract from the plist. |
| RAND_STREAM | [] | none | Internal MATLAB state of the pseudorandom number generator. You can set the state with a structure which should contain all properties of the MATLAB class RandStream |
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
back to top
| Some information of the method ao/ao are listed below: | |
|---|---|
| Class name | ao |
| Method name | ao |
| Category | Constructor |
| Package name | ltpda |
| VCS Version | 8ab8cbbc4bccf7543491a24448f4aae0b1be1c43 |
| Min input args | 0 |
| Max input args | -1 |
| Min output args | 1 |
| Max output args | 1 |
|
Method: ao/times | Method: ao/rebuild | ![]() |
©LTP Team