]> Creatis software - CreaPhase.git/blob - octave_packages/data-smoothing-1.3.0/doc-cache
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / data-smoothing-1.3.0 / doc-cache
1 # Created by Octave 3.6.1, Thu Mar 22 19:35:12 2012 UTC <root@brouzouf>
2 # name: cache
3 # type: cell
4 # rows: 3
5 # columns: 4
6 # name: <cell-element>
7 # type: sq_string
8 # elements: 1
9 # length: 5
10 ddmat
11
12
13 # name: <cell-element>
14 # type: sq_string
15 # elements: 1
16 # length: 352
17  -- Function File: D = ddmat (X, O)
18      Compute divided differencing matrix of order O
19
20           Input
21                X:  vector of sampling positions
22
23                O:  order of diffferences
24
25           Output
26                D:  the matrix; D * Y gives divided differences of order
27                O
28
29      References:  Anal. Chem. (2003) 75, 3631.
30
31
32
33
34
35 # name: <cell-element>
36 # type: sq_string
37 # elements: 1
38 # length: 47
39 Compute divided differencing matrix of order O
40
41
42
43
44 # name: <cell-element>
45 # type: sq_string
46 # elements: 1
47 # length: 13
48 regdatasmooth
49
50
51 # name: <cell-element>
52 # type: sq_string
53 # elements: 1
54 # length: 1939
55  -- Function File: [YHAT, LAMBDA] = regdatasmooth (X, Y, [OPTIONS])
56      Smooths the Y vs. X values of 1D data by Tikhonov regularization.
57      The smooth y-values are returned as YHAT. The regularization
58      parameter LAMBDA that was used for the smoothing may also be
59      returned.
60
61      Note:  the options have changed!  Currently supported input
62      options are (multiple options are allowed):
63
64     `"d", VALUE'
65           the smoothing derivative to use (default = 2)
66
67     `"lambda", VALUE'
68           the regularization paramater to use
69
70     `"stdev", VALUE'
71           the standard deviation of the measurement of Y; an optimal
72           value for lambda will be determined by matching the provided
73           VALUE with the standard devation of YHAT-Y; if the option
74           "relative" is also used, then a relative standard deviation
75           is inferred
76
77     `"gcv"'
78           use generalized cross-validation to determine the optimal
79           value for lambda; if neither "lambda" nor "stdev" options are
80           given, this option is implied
81
82     `"lguess", VALUE'
83           the initial value for lambda to use in the iterative
84           minimization algorithm to find the optimal value (default = 1)
85
86     `"xhat", VECTOR'
87           A vector of x-values to use for the smooth curve; must be
88           monotonically increasing and must at least span the data
89
90     `"weights", VECTOR'
91           A vector of weighting values for fitting each point in the
92           data.
93
94     `"relative"'
95           use relative differences for the goodnes of fit term.
96           Conflicts  with the "weights" option.
97
98     `"midpointrule"'
99           use the midpoint rule for the integration terms rather than a
100           direct sum; this option conflicts with the option "xhat"
101
102      Please run the demos for example usage.
103
104      References:  Anal. Chem. (2003) 75, 3631; AIChE J. (2006) 52, 325
105
106      See also: rgdtsmcorewrap, rgdtsmcore
107
108
109
110
111
112 # name: <cell-element>
113 # type: sq_string
114 # elements: 1
115 # length: 17
116 Smooths the Y vs.
117
118
119
120 # name: <cell-element>
121 # type: sq_string
122 # elements: 1
123 # length: 10
124 rgdtsmcore
125
126
127 # name: <cell-element>
128 # type: sq_string
129 # elements: 1
130 # length: 1279
131  -- Function File: [YHAT, V] = rgdtsmcore (X, Y, D, LAMBDA, [OPTIONS])
132      Smooths Y vs. X values by Tikhonov regularization.  Although this
133      function can be used directly, the more feature rich function
134      "regdatasmooth" should be used instead.  In addition to X and Y,
135      required input includes the smoothing derivative D and the
136      regularization parameter LAMBDA.  The smooth y-values are returned
137      as YHAT.  The generalized cross validation variance V may also be
138      returned.
139
140      Note:  the options have changed!  Currently supported input
141      options are (multiple options are allowed):
142
143     `"xhat", VECTOR'
144           A vector of x-values to use for the smooth curve; must be
145           monotonically increasing and must at least span the data
146
147     `"weights", VECTOR'
148           A vector of weighting values for fitting each point in the
149           data.
150
151     `"relative"'
152           use relative differences for the goodnes of fit term.
153           Conflicts  with the "weights" option.
154
155     `"midpointrule"'
156           use the midpoint rule for the integration terms rather than a
157           direct  sum; this option conflicts with the option "xhat"
158
159      References:  Anal. Chem. (2003) 75, 3631; AIChE J. (2006) 52, 325
160
161      See also: regdatasmooth
162
163
164
165
166
167 # name: <cell-element>
168 # type: sq_string
169 # elements: 1
170 # length: 13
171 Smooths Y vs.
172
173
174
175 # name: <cell-element>
176 # type: sq_string
177 # elements: 1
178 # length: 14
179 rgdtsmcorewrap
180
181
182 # name: <cell-element>
183 # type: sq_string
184 # elements: 1
185 # length: 485
186  -- Function File: CVE = rgdtsmcorewrap (LOG10LAMBDA, X, Y, D, MINCELL,
187           OPTIONS)
188  -- Function File: STDEVDIF = rgdtsmcorewrap (LOG10LAMBDA, X, Y, D,
189           MINCELL, OPTIONS)
190      Wrapper function for rgdtsmcore in order to minimize over  LAMBDA
191      w.r.t. cross-validation error OR the squared difference  between
192      the standard deviation of (Y-YHAT) and the given  standard
193      deviation.  This function is called from regdatasmooth.
194
195      See also: regdatasmooth
196
197
198
199
200
201 # name: <cell-element>
202 # type: sq_string
203 # elements: 1
204 # length: 68
205 Wrapper function for rgdtsmcore in order to minimize over  LAMBDA
206 w.
207
208
209
210
211