Method pest/pest


  PEST constructor for parameter estimates (pest) class.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: PEST constructor for parameter estimates (pest) class.
 
  CONSTRUCTOR:
 
        pe = pest()
        pe = pest(filename)
        pe = pest(plist-object)
        pe = pest(y, paramNames)
        pe = pest(y, paramNames, dy)
        pe = pest(y, paramNames, dy, cov)
        pe = pest(y, paramNames, dy, cov, chi2)
        pe = pest(y, paramNames, dy, cov, chi2, dof)
 
  INPUTS:
 
        y          - best fit parameters
        paramNames - names of the parameters
        dy         - standard errors of the parameters
        cov        - covariance matrix of the parameters
        chi2       - reduced chi^2 of the final fit
        dof        - degrees of freedom
 
  Parameters Description
 
  VERSION:     $Id: pest.m,v 1.38 2012/02/29 07:52:26 hewitson Exp $
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class pest
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
back to top back to top

From MAT File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
FILENAME '' none MAT filename.
back to top back to top

From XML File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
FILENAME '' none XML filename.
back to top back to top

From Repository

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
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 [] none Password to use when connecting to the database. Leave blank to be prompted.
ID [] none A vector of object IDs.
CID [] none A vector of collection IDs.
BINARY 1
  • 1
  • 0
Use binary representation (not always available).
back to top back to top

From Built-in Model

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
BUILT-IN '' none Choose one of the built-in models. (use class.getBuiltInModels to get a list for a particular user class)
back to top back to top

From Values

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
Y [] none Best fit parameters
PARAMNAMES {} [0x0] none Names of the parameters
DY [] none Standard errors of the parameters
COV [] none Covariance matrix of the parameters
CHI2 [] none Reduced chi^2 of the final fit
DOF [] none Degrees of freedom
MODELS smodel() none Models used for the fit in which the coefficients were calculated
Please notice that the models need to be stored in a smodel object!
PDF [] none Probability density function, as output by MCMC methods
YUNITS {} [0x0] none A cell-array of units for the parameters.
back to top back to top

Some information of the method pest/pest are listed below:
Class name pest
Method name pest
Category Constructor
CVS Version $Id: pest.m,v 1.38 2012/02/29 07:52:26 hewitson Exp $
Min input args 0
Max input args -1
Min output args 1
Max output args 1




©LTP Team