| LTPDA Toolbox™ | contents | ![]() |
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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
| Method Details | |
|---|---|
| Access | public |
| Defining Class | pest |
| Sealed | 0 |
| Static | 0 |
| Sets for this method … |
|---|
| Default |
| From MAT File |
| From XML File |
| From Repository |
| From Built-in Model |
| From Values |
Default |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| ltpda_uoh.addGlobalKeys | |||
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
Example |
|---|
| plist('NAME', '', 'DESCRIPTION', '') |
back to top
From MAT File |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| ltpda_uoh.addGlobalKeys | |||
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
| ltpda_uo.buildplist | |||
| FILENAME | '' | none | MAT filename. |
Example |
|---|
| plist('NAME', '', 'DESCRIPTION', '', 'FILENAME', '') |
back to top
From XML File |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| ltpda_uoh.addGlobalKeys | |||
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
| ltpda_uo.buildplist | |||
| FILENAME | '' | none | XML filename. |
Example |
|---|
| plist('NAME', '', 'DESCRIPTION', '', 'FILENAME', '') |
back to top
From Repository |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| ltpda_uoh.addGlobalKeys | |||
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
| ltpda_uo.buildplist | |||
| 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 | {} [0x0] | none | Password to use when connecting to the database. Leave blank to be prompted. |
| CONN | [] | none | Java mysql object. |
| ID, IDS | [] | none | A vector of object IDs. |
| CID | [] | none | A vector of collection IDs. |
| UUID, UUIDS | {} [0x0] | none | A cell array of UUIDs. |
| BINARY | 1 |
|
Use binary representation (not always available). |
Example |
|---|
| plist('NAME', '', 'DESCRIPTION', '', 'HOSTNAME', '', 'DATABASE', '', 'USERNAME', '', 'PASSWORD', cell(0,0), 'CONN', [[]], 'ID', [[]], 'CID', [[]], 'UUID', cell(0,0), 'BINARY', [true]) |
back to top
From Built-in Model |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| ltpda_uoh.addGlobalKeys | |||
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
| ltpda_uo.buildplist | |||
| BUILT-IN | '' | none | Choose one of the built-in models. (use class.getBuiltInModels to get a list for a particular user class) |
| VERSION | [] | none | Version of the built in model. The default version is used for the case that no 'Version' is defined. |
Example |
|---|
| plist('NAME', '', 'DESCRIPTION', '', 'BUILT-IN', '', 'VERSION', [[]]) |
back to top
From Values |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| ltpda_uoh.addGlobalKeys | |||
| NAME | '' | none | The name of the constructed object. |
| DESCRIPTION | '' | none | The description of the constructed object. |
| pest.buildplist | |||
| Y | [] | none | Best fit parameters |
| PARAMNAMES, NAMES, PARAMS | {} [0x0] | none | Names of the parameters |
| DY | [] | none | Standard errors of the parameters |
| COV | [] | none | Covariance matrix of the parameters |
| CORR | [] | none | Correlation matrix of the parameters |
| CHI2 | [] | none | Reduced chi^2 of the final fit |
| CHAIN | [] | none | Monte carlo markov chain |
| 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! |
| [] | none | Probability density function, as output by MCMC methods | |
| YUNITS | {} [0x0] | none | A cell-array of units for the parameters. |
Example |
|---|
| plist('NAME', '', 'DESCRIPTION', '', 'Y', [[]], 'PARAMNAMES', cell(0,0), 'DY', [[]], 'COV', [[]], 'CORR', [[]], 'CHI2', [[]], 'CHAIN', [[]], 'DOF', [[]], 'MODELS', smodel([plist('NAME', '', 'DESCRIPTION', '')]), 'PDF', [[]], 'YUNITS', cell(0,0)) |
back to top
| Some information of the method pest/pest are listed below: | |
|---|---|
| Class name | pest |
| Method name | pest |
| Category | Constructor |
| Package name | ltpda |
| VCS Version | 967b0eec0dece803a81af8ef54ad2f8c784b20b2 |
| Min input args | 0 |
| Max input args | -1 |
| Min output args | 1 |
| Max output args | 1 |
| Can be used as modifier | 0 |
| Supported numeric types | {'double'} |
|
Method: parfrac/retrieve | Method: pest/rebuild | ![]() |
©LTP Team