Method ao/ao


  check if the caller was a user of another method
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From MAT File

no description
Key Default Value Options Description
ltpda_uo.buildplist
FILENAME '' none MAT filename.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('FILENAME', '', 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From XML File

no description
Key Default Value Options Description
ltpda_uo.buildplist
FILENAME '' none XML filename.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('FILENAME', '', 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Repository

no description
Key Default Value Options Description
ltpda_uo.buildplist
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.
UUID, UUIDS {} [0x0] none A cell array of UUIDs.
BINARY 1
  • 1
  • 0
Use binary representation (not always available).
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('HOSTNAME', '', 'DATABASE', '', 'USERNAME', '', 'PASSWORD', cell(0,0), 'CONN', [[]], 'ID', [[]], 'CID', [[]], 'UUID', cell(0,0), 'BINARY', [true], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Built-in Model

no description
Key Default Value Options Description
ltpda_uo.buildplist
BUILT-IN '' none Choose one of the built-in models. (use class.getBuiltInModels to get a list for a particular user class)
VERSION [] none Version of the built in model. The default version is used for the case that no 'Version' is defined.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('BUILT-IN', '', 'VERSION', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From MAT Data File

no description
Key Default Value Options Description
ao.buildplist
FILENAME '' none MAT data filename.
FILEPATH '' none Path to the data file in case the filename is a relative path.
TYPE 'cdata'
  • 'tsdata'
  • 'fsdata'
  • 'xydata'
  • '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.
FS [] none If this value is set, the x-axes is computed from the fs value.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('FILENAME', '', 'FILEPATH', '', 'TYPE', 'cdata', 'COLUMNS', [[]], 'XUNITS', [ unit(' s ') ], 'FS', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From ASCII File

no description
Key Default Value Options Description
ao.buildplist
FILENAME '' none ASCII filename.
FILEPATH '' none Path to the data file in case the filename is a relative path.
TYPE 'cdata'
  • 'tsdata'
  • 'fsdata'
  • 'xydata'
  • '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.
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.
DELIMITER '' none Field delimiter character(s).
T0 '1970-01-01 00:00:00.000 UTC' 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.
HEADERLINES 0 none Use the first N lines for the description. Reading numeric data starting from line HeaderLines + 1.
ROBUST 0
  • 1
  • 0
Set this to 'true' to use (slow) data reading.
All values must be numbers and separated by blanks.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('FILENAME', '', 'FILEPATH', '', 'TYPE', 'cdata', 'COLUMNS', [[]], 'XUNITS', [[]], 'COMMENT_CHAR', '', 'MAXLINES', [[]], 'FS', [[]], 'DELIMITER', '', 'T0', '1970-01-01 00:00:00.000 UTC', 'IGNORELINES', [0], 'HEADERLINES', [0], 'ROBUST', [false], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Complex ASCII File

no description
Key Default Value Options Description
ao.buildplist
FILENAME '' none ASCII filename.
FILEPATH '' none Path to the data file in case the filename is a relative path.
COMPLEX_TYPE 'real/imag'
  • 'real/imag'
  • 'abs/deg'
  • 'dB/deg'
  • 'abs/rad'
  • 'dB/rad'
String defining the format of the complex data.
TYPE 'fsdata'
  • 'tsdata'
  • 'fsdata'
  • 'xydata'
  • 'cdata'
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.
COMMENT_CHAR '' none The comment character in the file.
T0 '1970-01-01 00:00:00.000 UTC' none The UTC time of the first sample.
For data types other than tsdata, this is ignored.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('FILENAME', '', 'FILEPATH', '', 'COMPLEX_TYPE', 'real/imag', 'TYPE', 'fsdata', 'COLUMNS', [[1 2 3]], 'XUNITS', [ unit(' Hz ') ], 'COMMENT_CHAR', '', 'T0', '1970-01-01 00:00:00.000 UTC', 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Function

no description
Key Default Value Options Description
ao.buildplist
FCN '' none Any valid MATLAB function. [e.g. 'randn(100,1)']
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
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('FCN', '', 'DY', [[]], 'RAND_STREAM', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Values

no description
Key Default Value Options Description
ao.buildplist
VALS [] none A set of values.
DY [] none A set of errors values for y.
AXIS 'y'
  • 'x'
  • 'y'
  • 'z'
If an AO is input in 'vals', this key specifies which axis we get the data from.
N 1 none Repeat 'N' times.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('VALS', [[]], 'DY', [[]], 'AXIS', 'y', 'N', [1], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From XY Values

no description
Key Default Value Options Description
ao.buildplist
TYPE ''
  • ''
  • 'tsdata'
  • 'fsdata'
  • 'xydata'
  • 'cdata'
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 UTC' none The 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.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('TYPE', '', 'FS', [[]], 'T0', '1970-01-01 00:00:00.000 UTC', 'TOFFSET', [0], 'XVALS', [[]], 'YVALS', [[]], 'DX', [[]], 'DY', [[]], 'XUNITS', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From XYZ Values

no description
Key Default Value Options Description
ao.buildplist
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.
ZUNITS [] none Unit on Z axis
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('XVALS', [[]], 'YVALS', [[]], 'ZVALS', [[]], 'DX', [[]], 'DY', [[]], 'DZ', [[]], 'XUNITS', [[]], 'ZUNITS', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Time-series Function

no description
Key Default Value Options Description
ao.buildplist
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 UTC' none The UTC time of the first sample. [for all]
TOFFSET 0 none The offset between the first x sample and t0.
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
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('TSFCN', 't', 'FS', [[]], 'NSECS', [[]], 'XUNITS', [ unit(' s ') ], 'T0', '1970-01-01 00:00:00.000 UTC', 'TOFFSET', [0], 'DY', [[]], 'RAND_STREAM', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From XY Function

no description
Key Default Value Options Description
ao.buildplist
XYFCN 'x' none Specify a function of x. (e.g. x.^2)
X [] none The x values.
XUNITS [] none Unit on X 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
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('XYFCN', 'x', 'X', [[]], 'XUNITS', [[]], 'DX', [[]], 'DY', [[]], 'RAND_STREAM', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Frequency-series Function

no description
Key Default Value Options Description
ao.buildplist
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'
  • 'lin'
  • '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.
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
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('FSFCN', 'f', 'F1', [1.0000000000000001e-09], 'F2', [10000], 'NF', [1000], 'SCALE', 'log', 'F', [[]], 'DY', [[]], 'XUNITS', [ unit(' Hz ') ], 'RAND_STREAM', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Window

no description
Key Default Value Options Description
ao.buildplist
WIN 'BH92'
  • 'Rectangular'
  • 'Welch'
  • 'Bartlett'
  • 'Hanning'
  • 'Hamming'
  • 'Nuttall3'
  • 'Nuttall4'
  • 'Nuttall3a'
  • 'Nuttall3b'
  • 'Nuttall4a'
  • 'Nuttall4b'
  • 'Nuttall4c'
  • 'BH92'
  • 'SFT3F'
  • 'SFT3M'
  • 'FTNI'
  • 'SFT4F'
  • 'SFT5F'
  • 'SFT4M'
  • 'FTHP'
  • 'HFT70'
  • 'FTSRS'
  • 'SFT5M'
  • 'HFT90D'
  • 'HFT95'
  • 'HFT116D'
  • 'HFT144D'
  • 'HFT169D'
  • 'HFT196D'
  • 'HFT223D'
  • 'HFT248D'
  • 'Kaiser'
  • 'levelledHanning'
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.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('WIN', 'BH92', 'LENGTH', [100], 'PSLL', [150], 'LEVELORDER', [2], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Waveform

no description
Key Default Value Options Description
ao.buildplist
WAVEFORM 'sine wave'
  • 'sine wave'
  • 'noise'
  • 'chirp'
  • 'gaussian pulse'
  • 'square wave'
  • 'sawtooth'
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']
  • a vector of seconds
  • a cell array with the offsets as a string
  • a vector time objects
Remark: If t0 is not specified then it will be set to the first value of Toff.

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'
  • 'Normal'
  • 'Uniform'
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 UTC' none The UTC time of the first sample. [for all]
TOFFSET 0 none The offset between the first x sample and t0.
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
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('WAVEFORM', 'sine wave', 'A', [1], 'F', [1], 'PHI', [0], 'TOFF', [0], 'GAPS', [[]], 'TYPE', 'Normal', 'SIGMA', [1], 'F0', [1], 'F1', [[]], 'T1', [[]], 'BW', [[]], 'DUTY', [50], 'WIDTH', [0.5], 'OFFSET', [0], 'FS', [[]], 'NSECS', [[]], 'XUNITS', [ unit(' s ') ], 'T0', '1970-01-01 00:00:00.000 UTC', 'TOFFSET', [0], 'RAND_STREAM', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Polynomial

no description
Key Default Value Options Description
ao.buildplist
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 UTC' 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 ''
  • ''
  • 'tsdata'
  • 'fsdata'
  • 'xydata'
  • 'cdata'
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.
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('POLYVAL', [[]], 'FS', [[]], 'NSECS', [[]], 'T0', '1970-01-01 00:00:00.000 UTC', 'TOFFSET', [0], 'T', [[]], 'X', [[]], 'F', [[]], 'TYPE', '', 'XUNITS', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Pzmodel

no description
Key Default Value Options Description
ao.buildplist
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 UTC' none The UTC time of the first sample. [for all]
TOFFSET 0 none The offset between the first x sample and t0.
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
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('PZMODEL', [pzmodel()], 'NDIGITS', [32], 'FS', [[]], 'NSECS', [[]], 'XUNITS', [ unit(' s ') ], 'T0', '1970-01-01 00:00:00.000 UTC', 'TOFFSET', [0], 'STATE', [[]], 'RAND_STREAM', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Smodel

no description
Key Default Value Options Description
ao.buildplist
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'
  • 'tsdata'
  • 'fsdata'
  • 'xydata'
  • 'cdata'
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
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('MODEL', smodel([plist('NAME', '', 'DESCRIPTION', '')]), 'X', [[]], 'XUNITS', [ unit(' s ') ], 'TYPE', 'tsdata', 'RAND_STREAM', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Pest

no description
Key Default Value Options Description
ao.buildplist
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
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('PEST', [[]], 'PARAMETER', '', 'RAND_STREAM', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top back to top

From Parameter

no description
Key Default Value Options Description
ao.buildplist
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
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ao.addGlobalKeys
YUNITS [] none Unit on Y axis
TIMESPAN [] none Give a timespan object which will be used to split the data before returning the new object. This only works for tsdata AOs.

Example

plist('PARAMETER', '', 'KEY', '', 'RAND_STREAM', [[]], 'NAME', '', 'DESCRIPTION', '', 'YUNITS', [[]], 'TIMESPAN', [[]])

back to top 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 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 0
Max input args -1
Min output args 1
Max output args 1
Can be used as modifier 0
Supported numeric types {'double'}




©LTP Team