pest Class


Properties Properties of the class
Methods All Methods of the class ordered by category.
Examples Some constructor examples

Back to Class descriptions Back to Class descriptions

Properties

The LTPDA toolbox restrict access of the properties.

The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).

For example:

val = obj.prop(2).prop;
The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
For example:
obj2 = obj1.setName('my name') % This command creates a copy of obj1 (obj1 ~= obj2)
obj.setName('my name');        % This command applies to obj    

Properties Description Defined in class

dy

standard errors of the parameters.

pest

y

best fit parameters

pest

names

names of the parameters, if any

pest

yunits

the units of each parameter

pest

pdf

posterior probability distribution of the parameters

pest

cov

covariance matrix of the parameters

pest

corr

correlation matrix of the parameters

pest

chi2

reduced chi^2 of the final fit

pest

dof

degrees of freedom

pest

chain

monte carlo markov chain

pest

models

models that were fit

pest

hist

history of the object (history object)

ltpda_uoh

procinfo

plist with additional information for an object.

ltpda_uoh

plotinfo

plist with the plot information

ltpda_uoh

name

name of the object

ltpda_uo

description

description of the object

ltpda_uo

mdlfile

model xml file of the LTPDAworkbench

ltpda_uo

UUID

Universally Unique Identifier of 128-bit

ltpda_uo

Back to Top Back to Top

Methods

Constructor Constructor of this class
Helper Helper methods only for internal usage
Internal Internal methods only for internal usage
Output Output methods
Relational Operator Relational operator methods
Signal Processing Signal processing methods

Back to Top Back to Top

Constructor

Methods Description Defined in class

rebuild

REBUILD rebuilds the input objects using the history.

ltpda_uoh

pest

PEST constructor for parameter estimates (pest) class.

pest

Back to Top of Section Back to Top of Section

Helper

Methods Description Defined in class

get

GET get a property of a object.

ltpda_obj

created

CREATED Returns a time object of the last modification.

ltpda_uoh

creator

CREATOR Extract the creator(s) from the history.

ltpda_uoh

csvexport

CSVEXPORT Exports the data of an object to a csv file.

ltpda_uoh

index

INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.

ltpda_uoh

requirements

REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.

ltpda_uoh

setDescription

SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.

ltpda_uoh

setMdlfile

SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.

ltpda_uoh

setName

SETNAME Sets the property 'name' of an ltpda_uoh object.

ltpda_uoh

setPlotinfo

SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.

ltpda_uoh

setProcinfo

SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.

ltpda_uoh

combineExps

combineExps combine the results of different parameter estimation

pest

comparePests

comparePests compares two parameter estimates.

pest

find

FIND Creates analysis objects from the selected parameter(s).

pest

setChain

SETCHI2 Set the property 'chain'

pest

setChi2

SETCHI2 Set the property 'chi2'

pest

setCorr

SETCORR Set the property 'corr'

pest

setCov

SETCOV Set the property 'cov'

pest

setDof

SETDOF Set the property 'dof'

pest

setDy

SETDY Set the property 'dy'

pest

setDyForParameter

SETDYFORPARAMETER Sets the according dy-error for the specified parameter.

pest

setModels

SETMODELS Set the property 'models'

pest

setNames

SETNAMES Set the property 'names'

pest

setPdf

SETPDF Set the property 'pdf'

pest

setY

SETY Set the property 'y'

pest

setYforParameter

SETYFORPARAMETER Sets the according y-value for the specified parameter.

pest

setYunits

SETYUNITS Set the property 'yunits'

pest

setYunitsForParameter

SETYUNITSFORPARAMETER Sets the according y-unit for the specified parameter.

pest

tdChi2

tdChi2 computes the chi-square for a parameter estimate.

pest

Back to Top of Section Back to Top of Section

Internal

Methods Description Defined in class

isprop

ISPROP tests if the given field is one of the object properties.

ltpda_obj

bsubmit

BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository

ltpda_uo

submit

SUBMIT Submits the given objects to an LTPDA repository

ltpda_uo

update

UPDATE Updates the given object in an LTPDA repository

ltpda_uo

string

STRING writes a command string that can be used to recreate the input object(s).

ltpda_uoh

type

TYPE converts the input objects to MATLAB functions.

ltpda_uoh

generateConstructorPlist

GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

pest

Back to Top of Section Back to Top of Section

Output

Methods Description Defined in class

save

SAVE overloads save operator for ltpda objects.

ltpda_uo

report

REPORT generates an HTML report about the input objects.

ltpda_uoh

viewHistory

VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.

ltpda_uoh

char

CHAR convert a pest object into a string.

pest

display

DISPLAY overloads display functionality for pest objects.

pest

Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defined in class

eq

EQ overloads the == operator for ltpda objects.

ltpda_obj

ne

NE overloads the ~= operator for ltpda objects.

ltpda_obj

Back to Top of Section Back to Top of Section

Signal Processing

Methods Description Defined in class

eval

EVAL evaluate a pest object

pest

Back to Top of Section Back to Top of Section




©LTP Team