Scripting Homer Functions - Revision history

Dickon Champion at 10:19, 31 January 2008

2008-01-31T10:19:43Z

2008-01-30T17:09:51Z

2008-01-30T17:08:25Z

mono_sample

2008-01-30T15:01:30Z

2008-01-30T15:00:43Z

The basics

2008-01-30T14:59:14Z

2008-01-30T14:58:13Z

mono_van

2008-01-30T12:25:46Z

white_beam

2008-01-30T12:24:19Z

2008-01-30T12:23:16Z

@@ Line 26: / Line 26: @@
 >> whitebeam_runfile=white_beam(dso,  run_no, 'keyword_1', parameter_1,..., 'keyword_N',parameter_N)
 </pre>
 * 'ei' is set to be 'white' by default
 * obvious values to override might be the 'd_int' values, or the normalisation details
@@ Line 34: / Line 35: @@
 </pre>
 * chopper type is a string argument denoting the type of chopper used in the experiment eg. ''''sloppy''''
 * 'ei' or 'fixei' '''must''' also be a keyword
 === monovan_abs ===
-The absolute units scaling factor from a monochromatic vanadium can be determined by making a call to monovan_abs, it is generally run on the [[runfile]] output from <tt>mono_van</tt>. This value can then be used as an argument to <tt>mono_sample</tt> below
+The absolute units scaling factor from a monochromatic vanadium can be determined by making a call to monovan_abs, it is generally run on the [[IXTrunfile]] output from <tt>mono_van</tt>. This value can then be used as an argument to <tt>mono_sample</tt> below
 <pre>
 >> scaling_factor=monovan_abs(monovan_runfile)
@@ Line 48: / Line 50: @@
 </pre>
+* creates an [[IXTrunfile]] output
 * chopper type is a string argument denoting the type of chopper used in the experiment eg. ''''sloppy''''
 * 'ei' or 'fixei' '''must''' also be a keyword

← Older revision		Revision as of 17:09, 30 January 2008
Line 51:		Line 51:
	* chopper type is a string argument denoting the type of chopper used in the experiment eg. ''''sloppy''''		* chopper type is a string argument denoting the type of chopper used in the experiment eg. ''''sloppy''''
	* 'ei' or 'fixei' '''must''' also be a keyword		* 'ei' or 'fixei' '''must''' also be a keyword
		+
		+	== Examples ==
		+
		+	[[Example Scripts \|Examples of homer scripting files]] can be downloaded

← Older revision		Revision as of 17:08, 30 January 2008
Line 51:		Line 51:
	* chopper type is a string argument denoting the type of chopper used in the experiment eg. ''''sloppy''''		* chopper type is a string argument denoting the type of chopper used in the experiment eg. ''''sloppy''''
	* 'ei' or 'fixei' '''must''' also be a keyword		* 'ei' or 'fixei' '''must''' also be a keyword
−	* 'solid' keyword '''must''' be defined, but generally would be <tt>whitebeam_runfile</tt>

@@ Line 3: / Line 3: @@
 It is possible to treat your data by making calls to the [[Homer and mgenie style functions#homer|homer]] function only, but it can be quite involved, requiring specific keyword arguments to be specified for different parts of the process. These three functions can be called in conjunction with [[diagnose]] to fully homer your data. They all call the [[Homer and mgenie style functions#homer|homer]] function underneath, but they set up particular default values particular to the process. All these default values can be overridden if they are defined as arguments to the function.
-* '''Before any of the following commands can be called the appropriate [[Instrument Setup]] functions '''must''' be called.'''
+* '''Before any of the following commands can be called the appropriate [[Instrument setup]] functions '''must''' be called.'''
 * All three functions have required keywords and accept all the optional keywords from [[Homer and mgenie style functions#homer|homer]]
 * run_no is a keyword common to all these functions, it is a string defining the run number to be homered

@@ Line 3: / Line 3: @@
 It is possible to treat your data by making calls to the [[Homer and mgenie style functions#homer|homer]] function only, but it can be quite involved, requiring specific keyword arguments to be specified for different parts of the process. These three functions can be called in conjunction with [[diagnose]] to fully homer your data. They all call the [[Homer and mgenie style functions#homer|homer]] function underneath, but they set up particular default values particular to the process. All these default values can be overridden if they are defined as arguments to the function.
 * All three functions have required keywords and accept all the optional keywords from [[Homer and mgenie style functions#homer|homer]]
 * run_no is a keyword common to all these functions, it is a string defining the run number to be homered
 * if multiple runs are to be added together then they can be provided in a cell array of strings
 <pre>
->> run_no={'11045' '23456' '12345'}
+>> run_no='12345'
 </pre>

← Older revision		Revision as of 14:59, 30 January 2008
Line 1:		Line 1:
		+	== The basics ==
		+
	It is possible to treat your data by making calls to the [[Homer and mgenie style functions#homer\|homer]] function only, but it can be quite involved, requiring specific keyword arguments to be specified for different parts of the process. These three functions can be called in conjunction with [[diagnose]] to fully homer your data. They all call the [[Homer and mgenie style functions#homer\|homer]] function underneath, but they set up particular default values particular to the process. All these default values can be overridden if they are defined as arguments to the function.		It is possible to treat your data by making calls to the [[Homer and mgenie style functions#homer\|homer]] function only, but it can be quite involved, requiring specific keyword arguments to be specified for different parts of the process. These three functions can be called in conjunction with [[diagnose]] to fully homer your data. They all call the [[Homer and mgenie style functions#homer\|homer]] function underneath, but they set up particular default values particular to the process. All these default values can be overridden if they are defined as arguments to the function.

@@ Line 23: / Line 23: @@
 >> whitebeam_runfile=white_beam(dso,  run_no, 'keyword_1', parameter_1,..., 'keyword_N',parameter_N)
 </pre>
-* 'ei' is set to be 'white by default
+* 'ei' is set to be 'white' by default
 == mono_van ==

← Older revision		Revision as of 12:23, 30 January 2008
Line 10:		Line 10:

	* no extra functions need to be called on the dso [[IXTdata_source]] object.		* no extra functions need to be called on the dso [[IXTdata_source]] object.
		+	* normalisation by an integral of monitor 1 between 1000 and 2000 <math>\mu</math>s is set by default and common to all functions

	== non-default keyword arguments ==		== non-default keyword arguments ==