Method pest/eval


  EVAL evaluate a pest object
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: EVAL evaluate a pest model.
 
  CALL:        b = eval(p, pl)
               b = eval(p, x, pl)
               b = eval(p, x1, ... , xN, pl)
               b = eval(p, [x1 ... xN], pl)
 
  INPUTS:      p  - input pest(s) containing parameter values.
               xi - input ao(s) containing x values (as x or y fields, depending on the 'xfield' parameter)
               pl - parameter list (see below)
 
  OUTPUTs:     b  - an AO containing the model evaluated at the given X
                    values, with the given parameter values.
 
  Parameters Description
 
  EXAMPLES:
 
  % 1)
  % Prepare the symbolic model
  mdl = smodel(plist('expression', 'a1.*x + a2.*x.^2 + a0', 'xvar', 'x', 'yunits', 'V'));
 
  % Prepare the pest object
 
  p = pest(plist('paramnames', {'a0','a1','a2'}, 'y', [1 2 3], 'models', mdl));
 
  % Evaluate the object
  a1 = eval(p, plist('xdata', ao([1:10])))
  a2 = eval(p, ao([1:10]))
 
  % 2)
  % Prepare the symbolic model
  mdl = smodel(plist('expression', 'a1.*x1 + a2.*x2 + a0', 'xvar', {'x1', 'x2'}, 'yunits', 'm', 'xunits', {'T', 'K'}));
 
  % Prepare the pest object
 
  p = pest(plist('paramnames', {'a0','a1','a2'}, 'y', [1 2 3], 'yunits', {'m', 'T/m', 'K/m'}, 'models', mdl));
 
  % Evaluate the object
  x1 = ao(plist('yvals', [1:10], 'fs', 1, 'yunits', 'T'));
  x2 = ao(plist('yvals', [1:10], 'fs', 1, 'yunits', 'K'));
  a1 = eval(p, plist('xdata', [x1 x2]))
  a2 = eval(p, [x1 x2])
  a3 = eval(p, x1, x2)
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class pest
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
INDEX 1 none Select which model must be evaluated if more than one.
XDATA [] none The X values to evaluate the model at. This can be:
  • a double vector
  • a cell array of double vectors
  • a single AO (from which the Y data will be extracted)
  • a cell array of AOs (from which the Y data will be extracted)
XFIELD 'y'
  • 'x'
  • 'y'
Choose the field to extract the x values from when inputting AOs for parameter 'xdata'.
TYPE ''
  • ''
  • 'tsdata'
  • 'fsdata'
  • 'xydata'
  • 'cdata'
Choose the data type for the output ao.
If empty, and if the user input AOs as 'XDATA', the type will be inherited.
YUNITS '' none Unit on Y axis.
XUNITS '' none Unit on X axis.
ERRORS 1
  • 1
  • 0
Estimate the uncertainty of the output values based
on the parameters covariance matrix
back to top back to top

Some information of the method pest/eval are listed below:
Class name pest
Method name eval
Category Signal Processing
Package name ltpda
VCS Version 3542afe99dea25c636b7ac3b82a9f6f8be9d447d
Min input args 1
Max input args -1
Min output args 1
Max output args -1




©LTP Team