Special Functions - Revision history

Dean Whittaker: /* Noisify */

2008-04-03T10:13:43Z

Noisify

Dean Whittaker: /* Noisify */

2008-04-02T14:03:38Z

Noisify

Dean Whittaker at 08:33, 1 April 2008

2008-04-01T08:33:24Z

Dean Whittaker at 09:09, 19 March 2008

2008-03-19T09:09:42Z

Dean Whittaker at 09:08, 19 March 2008

2008-03-19T09:08:51Z

Dean Whittaker at 16:22, 18 March 2008

2008-03-18T16:22:19Z

New page

Some special functions exist that are useful when writing scripts that use Libisis

==Contract Functions==

contract_d2d

==Expand Functions==

expand_d2d expand_listd2d expand_d1d expand_listd1d

==Conversion Functions==

oned_to_twod hist2point, hist2point_x, hist2point_y noisify

==Functions to Aid Plotting==

make_label

← Older revision		Revision as of 10:13, 3 April 2008
Line 91:		Line 91:
	* Default factor is 0.1		* Default factor is 0.1
	* Mean value at a point in the poison distribution method is the y value.		* Mean value at a point in the poison distribution method is the y value.
−	~~will add random noise to the~~

@@ Line 85: / Line 85: @@
-* w may be an [[IXTdataset_1]] or [[IXTdataset_2d]] object
+* w may be an [[IXTdataset_1d]] or [[IXTdataset_2d]] object
 * Output will be the same as input
 * Noise will have a gaussian distribution unless given the 'poison' command

← Older revision		Revision as of 08:33, 1 April 2008
Line 72:		Line 72:
	* w is an [[IXTdataset_1d]] object		* w is an [[IXTdataset_1d]] object
	* ww is an [[IXTdataset_2d]] object		* ww is an [[IXTdataset_2d]] object
		+
		+
		+	==Noisify==
		+
		+
		+	Noisify is a function used to add random noise to a dataset. It is good for testing fit functions etc.
		+
		+
		+	<pre>>> w= noisify(w)
		+	>> w = noisify(w, factor)
		+	>> w = noisify(w,'poison')</pre>
		+
		+
		+	* w may be an [[IXTdataset_1]] or [[IXTdataset_2d]] object
		+	* Output will be the same as input
		+	* Noise will have a gaussian distribution unless given the 'poison' command
		+	* Standard deviation = factor * (maximum signal value)
		+	* Default factor is 0.1
		+	* Mean value at a point in the poison distribution method is the y value.
		+	will add random noise to the

@@ Line 1: / Line 1: @@
 Some special functions exist that are useful when writing scripts that use Libisis
 ==Contract Functions==
 These functions are used to contract an array of datasets into a single dataset.
@@ Line 12: / Line 14: @@
 For instance, if a dataset has ww(1).x = [1, 2, 3, 4] ww(1).y = [1, 2, 3, 4] ww(2).x = [1, 2, 3, 4] ww(2).y = [6, 7, 8] then wwout will be a dataset with wwout.x = [1, 2, 3, 4] and wwout.y = [1, 2, 3, 4, 6, 7, 8].
 ==Expand Functions==
 These functions are used to expand a single [[IXTdataset_2d]] into an array of datasets.
@@ Line 33: / Line 37: @@
 * Output will be an array, each element pertaining to one y row in the input
 * If list is give, only the y indicies in list will be expanded
 ==Conversion Functions==
 Conversion functions convert from one object type or data type to another
@@ Line 52: / Line 58: @@
 * Converts one dimension (x or y) from histogram data to point data
 ==Functions to Aid Plotting==
 Standard functions exist to help with plotting

@@ Line 2: / Line 2: @@
 ==Contract Functions==
-contract_d2d
+<pre>>> wwout = contract(ww)</pre>
 ==Expand Functions==
-expand_d2d expand_listd2d expand_d1d expand_listd1d
+* Input is an [[IXTdataset_2d]] object
 ==Conversion Functions==
-oned_to_twod hist2point, hist2point_x, hist2point_y noisify
+<pre>>> wwout = oned_to_twod(w)</pre>
 ==Functions to Aid Plotting==
-make_label
+* xlab is the label for the x axis