High Level Functions - Revision history

Dean Whittaker at 15:15, 20 March 2008

2008-03-20T15:15:51Z

Dean Whittaker at 14:57, 18 March 2008

2008-03-18T14:57:53Z

Dean Whittaker at 14:57, 18 March 2008

2008-03-18T14:57:05Z

Dean Whittaker at 14:35, 18 March 2008

2008-03-18T14:35:10Z

Dean Whittaker at 14:34, 18 March 2008

2008-03-18T14:34:26Z

Dean Whittaker at 14:22, 18 March 2008

2008-03-18T14:22:32Z

Dean Whittaker: /* Optional Inputs */

2008-03-18T14:04:47Z

Optional Inputs

Dean Whittaker: /* Optional Inputs */

2008-03-18T12:29:16Z

Optional Inputs

Dean Whittaker: /* Optional Inputs */

2008-03-18T12:13:38Z

Optional Inputs

Dean Whittaker at 12:11, 18 March 2008

2008-03-18T12:11:39Z

@@ Line 270: / Line 270: @@
 * wout.signal will be the calculated dependent variable values from the function func
 * arg1, arg2, etc. are the arguments used by the function func and will usually consist of a single numerical array
 The function func must be called in one of the following two ways (depending on whether an [[IXTdataset_1d]] or [[IXTdataset_2d]] is being evaluated)

@@ Line 86: / Line 86: @@
 * '''filter:''' May be 'box', 'gaussian', or the handle to a function that defines how the smoothing should occur. ''Default:'' 'box'
-* '''size:''' A vector indicating the size of the convolution kernel. '''Default:''' [3,3]
+* '''size:''' A vector indicating the size of the convolution kernel. ''Default:'' [3,3]
 * '''pars:''' are arguments required by filter if a function is given
 * ''''nonorm:'''' turns off the normalisation in the kernel shell if filter is a user defined function

@@ Line 178: / Line 178: @@
 The function used in the fitting must have a format compatable with the fitting algorithm, this means that to call the function the following syntax is used
 '''For one dimensional fitting'''
 <pre>>> y = func(x, pin, optional)   OR
 >> [y, name, pnames, pin] = func(x, pin, optional) </pre>
 '''For two dimensional fitting'''
@@ Line 196: / Line 198: @@
 '''''EXAMPLE:'''''
 The following would be a suitable function to use with fit, where the fit is a simple polynomial one
@@ Line 223: / Line 226: @@
 * '''pfree:''' A binary array the same size indicating which parameters are allowed to vary. For instance, if pin is [1, 2, 3, 4, 5] then pfree may be [0, 0, 1, 1, 1] meaning that the first two parameters are fixed at 1 and 2 respectively while the others will be varied to find the best fit.
 '''Properties that can be set:'''

← Older revision		Revision as of 14:35, 18 March 2008
Line 1:		Line 1:
	Many powerful high level functions are provided. These manipulate datasets in a complicated manor.		Many powerful high level functions are provided. These manipulate datasets in a complicated manor.
−
−	~~These functions are~~
−	~~<pre>>> wwout = deriv1x(ww)~~
−	~~>> wwout = deriv2x(ww)~~
−	~~>> wwout = deriv1y(ww)~~
−	~~>> wwout = deriv2y(ww)~~
−	~~>> wout = deriv1(w)~~
−	~~>> wout = deriv2(w)~~
−	~~>> wout = integrate_x(ww, xmin, xmax)~~
−	~~>> wout = integrate_y(ww, ymin, ymax)~~
−	~~>> dout = integrate_xy(ww, xmin, xmax, ymin, ymax)~~
−	~~>> dout = integrate(w, xmin, xmax)~~
−	~~>> wwout = smooth(ww)~~
−	~~>> wwout = smooth(w)~~
−	~~>> wwout = interp_x(ww, xarray, optional inputs)~~
−	~~>> wwout = interp_y(ww, yarray, optional inputs)~~
−	~~>> wout = interp(ww, xarray, optional inputs)~~
−	~~>> wwout = unspike(ww)~~
−	~~>> wwout = unspike(w)~~
−	~~>> [wwout fitdata] = fit(ww, func, pin, optional)~~
−	~~>> [wout fitdata] = fit(w, func, pin, optional)~~
−	~~>> wwout = func_eval(ww, func, args)~~
−	~~>> wout = func_eval(w, func, args)</pre>~~
−

	==Derrivative Functions==		==Derrivative Functions==

@@ Line 219: / Line 219: @@
-'''EXAMPLE:'''
+'''''EXAMPLE:'''''
 The following would be a suitable function to use with fit, where the fit is a simple polynomial one
@@ Line 280: / Line 280: @@
 ==Function Evaluation==

@@ Line 26: / Line 26: @@
 ==Derrivative Functions==
 ===First Derivative===
 These functions take the derivatives of datasets.
@@ Line 42: / Line 44: @@
 * Output is an [[IXTdataset_1d]] object
 * Calculates the first derivative of the dataset in the x direction
 ===Second Derivative===
 These functions take the second derivatives of datasets.
@@ Line 61: / Line 65: @@
 ==Integral Functions==
 These functions integrate a dataset between given limits using the trapezoid method.
@@ Line 81: / Line 86: @@
 * Output is an [[IXTdatum]] object
 * Integral is evaluated between xmin and xmax
 ==Smooth Functions==
 Smooth functions use an algorithm to smooth the data in a dataset to eliminate fluctuations.
@@ Line 91: / Line 98: @@
 * Output is the same object type as the input
 * Options allow the user to set the method of smoothing and parameters
 ===Optional Inputs===
@@ Line 107: / Line 115: @@
 See the Matlab online help for more information.
 ==Interpolate Functions==
 These functions always return '''point''' datasets regardless of point or histogram input. It can be viewed as the point data equivilent to the [[Rebin Functions | rebin]] functions. A new set of x or y datapoints is given and the data interpolated accross them.
@@ Line 130: / Line 140: @@
 * ''Default'' method uses linear interpretation
 * Optional inputs allow control of method
 === Optional Inputs===
@@ Line 144: / Line 155: @@
 ** 'cubic' - uses cubic interpolation
 * '''Extrapval:''' value given to out of range points (usually NaN or 0)
 ==Unspike Functions==
 Used to remove spurious spikes from datasets
@@ Line 156: / Line 169: @@
 * Spikes are replaced with an interpolated value
 * Optional inputs may be used to define what constitutes a spike (see Optional Inputs for definition of a spike)
 ===Optional Inputs===
@@ Line 167: / Line 181: @@
 * '''fac:''' If a signal point is within a factor FAC of both of its neighbours then is NOT a spike (''Default:'' 2)
 * '''sfac:''' If the difference of a point w.r.t. both of its neighbours is less than SFAC standard deviations then the point is NOT a spike (''Default:'' 5)
 ==Fitting Functions==
 These functions fit data to a function.
@@ Line 181: / Line 197: @@
 ** '''func:''' Function to fit w to
 ** '''pin:''' Starting parameters (a guess of what the best fit parameters will be) of the form [p1, p2, p3, ...]
 ===Function Format===
 ===fitdata===
 ===Optional Inputs===
 These functions may also be called with the syntaxes
@@ Line 213: / Line 265: @@
 ** maskval = [0, 1, 0, 0, 0, 1, 1, 1, ...] if maskval(i) = 1 then the point at w.x(i) will be kept.
 * ''''select'''' - the values returned in the output are only those used for the fitting.
 '''''EXAMPLES:'''''

@@ Line 200: / Line 200: @@
 |-
 ! {{Headcellstyle}} | Property
 ! {{Headcellstyle}} | Possible Values
 |-
 ! | Row 1
 | align="center" | a<sub>12</sub>
 |-
 ! | Row 2
 | align="center" | test 2
 |}
 ==Function Evaluation==

← Older revision		Revision as of 12:11, 18 March 2008
Line 197:		Line 197:

	''' Properties that can be set:'''		''' Properties that can be set:'''
−		+	{\| {{Tablestyle}}
		+	\|-
		+	! {{Headcellstyle}} \| Property
		+	! {{Headcellstyle}} \| Possible Values
		+	\|-
		+	! \| Row 1
		+	\| align="center" \| a<sub>12</sub>
		+	\|-
		+	! \| Row 2
		+	\| align="center" \| test 2
		+	\|}