Mercurial > hg > ltpda
diff m-toolbox/html_help/help/ug/class_desc_pest.html @ 0:f0afece42f48
Import.
author | Daniele Nicolodi <nicolodi@science.unitn.it> |
---|---|
date | Wed, 23 Nov 2011 19:22:13 +0100 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/html_help/help/ug/class_desc_pest.html Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,1145 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" + "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"> + +<html lang="en"> +<head> + <meta name="generator" content= + "HTML Tidy for Mac OS X (vers 1st December 2004), see www.w3.org"> + <meta http-equiv="Content-Type" content= + "text/html; charset=us-ascii"> + + <title>pest Class (LTPDA Toolbox)</title> + <link rel="stylesheet" href="docstyle.css" type="text/css"> + <meta name="generator" content="DocBook XSL Stylesheets V1.52.2"> + <meta name="description" content= + "Presents an overview of the features, system requirements, and starting the toolbox."> + </head> + +<body> + <a name="top_of_page" id="top_of_page"></a> + + <p style="font-size:1px;"> </p> + + <table class="nav" summary="Navigation aid" border="0" width= + "100%" cellpadding="0" cellspacing="0"> + <tr> + <td valign="baseline"><b>LTPDA Toolbox</b></td><td><a href="../helptoc.html">contents</a></td> + + <td valign="baseline" align="right"><a href= + "class_desc_parfrac.html"><img src="b_prev.gif" border="0" align= + "bottom" alt="parfrac Class"></a> <a href= + "class_desc_plist.html"><img src="b_next.gif" border="0" align= + "bottom" alt="plist Class"></a></td> + </tr> + </table> + + <h1 class="title"><a name="f3-12899" id="f3-12899"></a>pest Class</h1> + <hr> + + <p> + + <!-- ================================================== --> + <!-- BEGIN CONTENT FILE --> + <!-- ================================================== --> + <!-- ===== link box: Begin ===== --> + <p> + <table border="1" width="80%"> + <tr> + <td> + <table border="0" cellpadding="5" class="categorylist" width="100%"> + <colgroup> + <col width="37%"/> + <col width="63%"/> + </colgroup> + <tbody> + <tr valign="top"> + <td> + <a href="class_desc_pest.html#top_properties">Properties</a> + </td> + <td>Properties of the class</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_pest.html#top_methods">Methods</a> + </td> + <td>All Methods of the class ordered by category.</td> + </tr> + <tr valign="top"> + <td> + <a href="constructor_examples_pest.html">Examples</a> + </td> + <td>Some constructor examples</td> + </tr> + </tbody> + </table> + </td> + </tr> + </table> + </p> + <!-- ===== link box: End ====== --> + + <!-- ===== Back to Class descriptions ===== --> + <a href="class_desc_main.html"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Class descriptions"/> + Back to Class descriptions + </a> + + <h2 class="title"><a name="top_properties"/>Properties</h2> + <p> + The LTPDA toolbox restrict access of the properties.<br></br> + The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).<br></br> + <pre class="programlisting">For example:<br></br>val = obj.prop(2).prop;</pre> + The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method. + <pre class="programlisting"> +For example: +obj2 = obj1.setName(<span class="string">'my name'</span>) <span class="comment">% This command creates a copy of obj1 (obj1 ~= obj2)</span> +obj.setName(<span class="string">'my name'</span>); <span class="comment">% This command applies to obj</span> </pre> + </p> + <!-- ===== Properties ===== --> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Properties</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- Property: 'dy' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest.dy')">dy</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>standard errors of the parameters.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- Property: 'y' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest.y')">y</a></p> + </td> + <td> + <p>best fit parameters</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- Property: 'names' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest.names')">names</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>names of the parameters, if any</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- Property: 'yunits' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest.yunits')">yunits</a></p> + </td> + <td> + <p>the units of each parameter</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- Property: 'pdf' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest.pdf')">pdf</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>posterior probability distribution of the parameters</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- Property: 'cov' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest.cov')">cov</a></p> + </td> + <td> + <p>covariance matrix of the parameters</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- Property: 'corr' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest.corr')">corr</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>correlation matrix of the parameters</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- Property: 'chi2' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest.chi2')">chi2</a></p> + </td> + <td> + <p>reduced chi^2 of the final fit</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- Property: 'dof' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest.dof')">dof</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>degrees of freedom</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- Property: 'chain' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest.chain')">chain</a></p> + </td> + <td> + <p>monte carlo markov chain</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- Property: 'models' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest.models')">models</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>models that were fit</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- Property: 'hist' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest.hist')">hist</a></p> + </td> + <td> + <p>history of the object (history object)</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- Property: 'procinfo' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest.procinfo')">procinfo</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>plist with additional information for an object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- Property: 'plotinfo' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest.plotinfo')">plotinfo</a></p> + </td> + <td> + <p>plist with the plot information</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- Property: 'name' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest.name')">name</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>name of the object</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- Property: 'description' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest.description')">description</a></p> + </td> + <td> + <p>description of the object</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- Property: 'mdlfile' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest.mdlfile')">mdlfile</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>model xml file of the LTPDAworkbench</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- Property: 'UUID' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest.UUID')">UUID</a></p> + </td> + <td> + <p>Universally Unique Identifier of 128-bit</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + </tbody> + </table> + </p> + + <!-- ===== Top of page ===== --> + <a href="#top_of_page"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/> + Back to Top + </a> + + <h2 class="title"><a name="top_methods"/>Methods</h2> + <!-- ===== link box: Begin ===== --> + <p> + <table border="1" width="80%"> + <tr> + <td> + <table border="0" cellpadding="5" class="subcategorylist" width="100%"> + <colgroup> + <col width="37%"/> + <col width="63%"/> + </colgroup> + <tbody> + <tr valign="top"> + <td> + <a href="class_desc_pest.html#constructor">Constructor</a> + </td> + <td>Constructor of this class</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_pest.html#helper">Helper</a> + </td> + <td>Helper methods only for internal usage</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_pest.html#internal">Internal</a> + </td> + <td>Internal methods only for internal usage</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_pest.html#output">Output</a> + </td> + <td>Output methods</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_pest.html#relational_operator">Relational Operator</a> + </td> + <td>Relational operator methods</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_pest.html#signal_processing">Signal Processing</a> + </td> + <td>Signal processing methods</td> + </tr> + </tbody> + </table> + </td> + </tr> + </table> + </p> + <!-- ===== link box: End ====== --> + + <!-- ===== Top of page ===== --> + <a href="#top_of_page"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/> + Back to Top + </a> + + <!-- ===== Methods Category: Constructor ===== --> + <h3 class="title"><a name="constructor"/>Constructor</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_uoh/rebuild --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/rebuild')">rebuild</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>REBUILD rebuilds the input objects using the history.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- pest/pest --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest')">pest</a></p> + </td> + <td> + <p>PEST constructor for parameter estimates (pest) class.</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Helper ===== --> + <h3 class="title"><a name="helper"/>Helper</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_obj/get --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/get')">get</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>GET get a property of a object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_obj</p> + </td> + </tr> + <!-- ltpda_uoh/created --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/created')">created</a></p> + </td> + <td> + <p>CREATED Returns a time object of the last modification.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/creator --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/creator')">creator</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>CREATOR Extract the creator(s) from the history.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/csvexport --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/csvexport')">csvexport</a></p> + </td> + <td> + <p>CSVEXPORT Exports the data of an object to a csv file.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/index --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/index')">index</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/requirements --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/requirements')">requirements</a></p> + </td> + <td> + <p>REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setDescription --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setDescription')">setDescription</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setMdlfile --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/setMdlfile')">setMdlfile</a></p> + </td> + <td> + <p>SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setName --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setName')">setName</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETNAME Sets the property 'name' of an ltpda_uoh object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setPlotinfo --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/setPlotinfo')">setPlotinfo</a></p> + </td> + <td> + <p>SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setProcinfo --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setProcinfo')">setProcinfo</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- pest/combineExps --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/combineExps')">combineExps</a></p> + </td> + <td> + <p>combineExps combine the results of different parameter estimation</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/comparePests --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/comparePests')">comparePests</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>comparePests compares two parameter estimates.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- pest/find --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/find')">find</a></p> + </td> + <td> + <p>FIND Creates analysis objects from the selected parameter(s).</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/setChain --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setChain')">setChain</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETCHI2 Set the property 'chain'</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- pest/setChi2 --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/setChi2')">setChi2</a></p> + </td> + <td> + <p>SETCHI2 Set the property 'chi2'</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/setCorr --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setCorr')">setCorr</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETCORR Set the property 'corr'</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- pest/setCov --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/setCov')">setCov</a></p> + </td> + <td> + <p>SETCOV Set the property 'cov'</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/setDof --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setDof')">setDof</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETDOF Set the property 'dof'</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- pest/setDy --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/setDy')">setDy</a></p> + </td> + <td> + <p>SETDY Set the property 'dy'</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/setDyForParameter --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setDyForParameter')">setDyForParameter</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETDYFORPARAMETER Sets the according dy-error for the specified parameter.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- pest/setModels --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/setModels')">setModels</a></p> + </td> + <td> + <p>SETMODELS Set the property 'models'</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/setNames --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setNames')">setNames</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETNAMES Set the property 'names'</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- pest/setPdf --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/setPdf')">setPdf</a></p> + </td> + <td> + <p>SETPDF Set the property 'pdf'</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/setY --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setY')">setY</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETY Set the property 'y'</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- pest/setYforParameter --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/setYforParameter')">setYforParameter</a></p> + </td> + <td> + <p>SETYFORPARAMETER Sets the according y-value for the specified parameter.</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/setYunits --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/setYunits')">setYunits</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETYUNITS Set the property 'yunits'</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + <!-- pest/setYunitsForParameter --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/setYunitsForParameter')">setYunitsForParameter</a></p> + </td> + <td> + <p>SETYUNITSFORPARAMETER Sets the according y-unit for the specified parameter.</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/tdChi2 --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/tdChi2')">tdChi2</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>tdChi2 computes the chi-square for a parameter estimate.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Internal ===== --> + <h3 class="title"><a name="internal"/>Internal</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_obj/isprop --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/isprop')">isprop</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>ISPROP tests if the given field is one of the object properties.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_obj</p> + </td> + </tr> + <!-- ltpda_uo/bsubmit --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/bsubmit')">bsubmit</a></p> + </td> + <td> + <p>BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uo/submit --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/submit')">submit</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SUBMIT Submits the given objects to an LTPDA repository</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uo/update --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/update')">update</a></p> + </td> + <td> + <p>UPDATE Updates the given object in an LTPDA repository</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uoh/string --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/string')">string</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>STRING writes a command string that can be used to recreate the input object(s).</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/type --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/type')">type</a></p> + </td> + <td> + <p>TYPE converts the input objects to MATLAB functions.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- pest/generateConstructorPlist --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/generateConstructorPlist')">generateConstructorPlist</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Output ===== --> + <h3 class="title"><a name="output"/>Output</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_uo/save --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/save')">save</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SAVE overloads save operator for ltpda objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uoh/report --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/report')">report</a></p> + </td> + <td> + <p>REPORT generates an HTML report about the input objects.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/viewHistory --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/viewHistory')">viewHistory</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- pest/char --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/char')">char</a></p> + </td> + <td> + <p>CHAR convert a pest object into a string.</p> + </td> + <td> + <p>pest</p> + </td> + </tr> + <!-- pest/display --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/display')">display</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>DISPLAY overloads display functionality for pest objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Relational_Operator ===== --> + <h3 class="title"><a name="relational_operator"/>Relational Operator</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_obj/eq --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/eq')">eq</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>EQ overloads the == operator for ltpda objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_obj</p> + </td> + </tr> + <!-- ltpda_obj/ne --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('pest/ne')">ne</a></p> + </td> + <td> + <p>NE overloads the ~= operator for ltpda objects.</p> + </td> + <td> + <p>ltpda_obj</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Signal_Processing ===== --> + <h3 class="title"><a name="signal_processing"/>Signal Processing</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- pest/eval --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('pest/eval')">eval</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>EVAL evaluate a pest object</p> + </td> + <td bgcolor="#f3f4f5"> + <p>pest</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ================================================== --> + <!-- END CONTENT FILE --> + <!-- ================================================== --> + + </p> + + <br> + <br> + <table class="nav" summary="Navigation aid" border="0" width= + "100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td align="left" width="20"><a href="class_desc_parfrac.html"><img src= + "b_prev.gif" border="0" align="bottom" alt= + "parfrac Class"></a> </td> + + <td align="left">parfrac Class</td> + + <td> </td> + + <td align="right">plist Class</td> + + <td align="right" width="20"><a href= + "class_desc_plist.html"><img src="b_next.gif" border="0" align= + "bottom" alt="plist Class"></a></td> + </tr> + </table><br> + + <p class="copy">©LTP Team</p> +</body> +</html>