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 Defining Class
dy standard errors of the parameters. pest
y input pest objects as - input pest objects array OUTPUTS: val - matrix with 'y', one column for each input object Parameters Description %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 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 plotinfo object ltpda_uoh
name name of the object ltpda_uo
description description of the object ltpda_uo
UUID Universally Unique Identifier of 128-bit ltpda_uo
Back to Top Back to Top

Methods

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

Back to Top Back to Top

Constructor

Methods Description Defining Class
rebuild Rebuilds the input objects using the history. ltpda_uoh
pest Constructor for parameter estimates (pest) class. pest
Back to Top of Section Back to Top of Section

Converter

Methods Description Defining Class
double Overloads double() function for pest objects. pest
y Get the data property 'y'. pest
Back to Top of Section Back to Top of Section

Helper

Methods Description Defining Class
get Get a property of a object. ltpda_obj
search Select objects that match the given name. ltpda_uo
setDescription Sets the 'description' property of a ltpda_uo object. ltpda_uo
setName Sets the property 'name' of an ltpda_uoh object. ltpda_uo
created Returns a time object of the last modification. ltpda_uoh
creator Extract the creator(s) from the history. ltpda_uoh
csvexport Exports the data of an object to a csv file. ltpda_uoh
index Index into a 'ltpda_uoh' object array or matrix. This properly captures the history. ltpda_uoh
requirements Returns a list of LTPDA extension requirements for a given object. ltpda_uoh
setPlotAxes Sets the 'axes' property of a the object's plotinfo. ltpda_uoh
setPlotColor Sets the color of a the object's plotinfo. ltpda_uoh
setPlotFigure Sets the 'figure' property of a the object's plotinfo. ltpda_uoh
setPlotFillmarker Defines if the plot function fill the marker or not. ltpda_uoh
setPlotLineStyle Sets the linestyle of a the object's plotinfo. ltpda_uoh
setPlotLinewidth Sets the linewidth of a the object's plotinfo. ltpda_uoh
setPlotMarker Sets the marker of a the object's plotinfo. ltpda_uoh
setPlotMarkerEdgeColor Sets the color of a the object's marker edge. ltpda_uoh
setPlotMarkerFaceColor Sets the color of a the object's marker face. ltpda_uoh
setPlotMarkersize Sets the markersize of a the object's plotinfo. ltpda_uoh
setPlotinfo Sets the 'plotinfo' property of a ltpda_uoh object. ltpda_uoh
setPlottingStyle Sets the style property of a the object's plotinfo. ltpda_uoh
setProcinfo Sets the 'procinfo' property of a ltpda_uoh object. ltpda_uoh
setShowsErrors Sets the 'showErrors' property of a the object's plotinfo. ltpda_uoh
combineExps Combine the results of different parameter estimation pest
computePdf Computes Probability Density Function from a pest object pest
find Creates analysis objects from the selected parameter(s). pest
mcmcPlot M - Tool to visualise results of a MCMC sampling. pest
setChain SETCHI2 Set the property 'chain' pest
setChi2 Set the property 'chi2' pest
setCorr Set the property 'corr' pest
setCov Set the property 'cov' pest
setDof Set the property 'dof' pest
setDy Set the property 'dy' pest
setDyForParameter Sets the according dy-error for the specified parameter. pest
setModels Set the property 'models' pest
setNames Set the property 'names' pest
setPdf Set the property 'pdf' pest
setXvals Sets the 'xvals' property of the underlying smodel object. pest
setY Set the property 'y' pest
setYforParameter Sets the according y-value for the specified parameter. pest
setYunits Set the property 'yunits' pest
setYunitsForParameter Sets the according y-unit for the specified parameter. pest
simplifyYunits Simplifies the units of parameters in a pest pest
tdChi2 Computes the chi-square for a parameter estimate. pest
viewResults Displays the content of the pest object as an html report. pest
Back to Top of Section Back to Top of Section

Internal

Methods Description Defining Class
isprop Tests if the given field is one of the object properties. ltpda_obj
bsubmit Submits the given collection of objects in binary form to an LTPDA repository ltpda_uo
submit Submits the given collection of objects to an LTPDA repository ltpda_uo
update Updates the given object in an LTPDA repository ltpda_uo
string Writes a command string that can be used to recreate the input object(s). ltpda_uoh
type Converts the input objects to MATLAB functions. ltpda_uoh
generateConstructorPlist Generates a PLIST from the properties which can rebuild the object. pest
plot The pest objects on the given axes. pest
Back to Top of Section Back to Top of Section

Operator

Methods Description Defining Class
mve Minimum Volume Ellipsoid estimator pest
Back to Top of Section Back to Top of Section

Output

Methods Description Defining Class
save Overloads save operator for ltpda objects. ltpda_uo
report Generates an HTML report about the input objects. ltpda_uoh
viewHistory Displays the history of an object as a dot-view or a MATLAB figure. ltpda_uoh
char Convert a pest object into a string. pest
display Overloads display functionality for pest objects. pest
jtable Display the parameters from PEST objects in a java table. pest
table Display the parameters from PEST objects in a java table. pest
Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defining Class
isequal Overloads the isequal operator for ltpda objects. ltpda_obj
Back to Top of Section Back to Top of Section

Signal Processing

Methods Description Defining Class
eval Evaluate a pest object pest
Back to Top of Section Back to Top of Section



©LTP Team