Difference between revisions of "Scripting Homer Functions"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | It is possible to treat your data by making calls to the [[Homer and mgenie style functions#homer|homer]] | + | 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]] | ||
| + | * Before any of the following commands can be called the appropriate [[Instrument Setup]] functions '''must''' be called. | ||
| + | * 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'} | ||
| + | </pre> | ||
== white_beam == | == white_beam == | ||
| + | <pre> | ||
| + | >> runfile=white_beam(dso, run_no, 'keyword_1', parameter_1,..., 'keyword_N',parameter_N) | ||
| + | </pre> | ||
== mono_van == | == mono_van == | ||
| + | <pre> | ||
| + | >> runfile=mono_van(dso, run_no, chopper_type,'keyword_1', parameter_1,..., 'keyword_N',parameter_N) | ||
| + | </pre> | ||
| + | chopper type is a string argument denoting the type of chopper used in the experiment eg ''''sloppy'''' | ||
== mono_sample == | == mono_sample == | ||
Revision as of 10:04, 30 January 2008
It is possible to treat your data by making calls to the 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 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
- Before any of the following commands can be called the appropriate Instrument Setup functions must be called.
- 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
>> run_no={'11045' '23456' '12345'}
white_beam
>> runfile=white_beam(dso, run_no, 'keyword_1', parameter_1,..., 'keyword_N',parameter_N)
mono_van
>> runfile=mono_van(dso, run_no, chopper_type,'keyword_1', parameter_1,..., 'keyword_N',parameter_N)
chopper type is a string argument denoting the type of chopper used in the experiment eg 'sloppy'