Homer and mgenie style functions - Revision history

Dean Whittaker: /* homer */

2008-08-12T14:12:46Z

homer

Dickon Champion: /* mon */

2008-04-09T13:49:20Z

mon

Dean Whittaker at 14:37, 31 March 2008

2008-03-31T14:37:07Z

Dean Whittaker: removed "see also" information from bottom

2008-03-17T10:36:09Z

removed "see also" information from bottom

Dickon Champion at 16:39, 30 January 2008

2008-01-30T16:39:31Z

Dickon Champion at 16:18, 30 January 2008

2008-01-30T16:18:00Z

Dickon Champion at 16:16, 30 January 2008

2008-01-30T16:16:05Z

Dickon Champion at 15:52, 30 January 2008

2008-01-30T15:52:42Z

Dickon Champion: /* mon */

2008-01-30T15:50:29Z

mon

Dickon Champion: /* homer */

2008-01-30T12:17:17Z

homer

@@ Line 210: / Line 210: @@
 |'mass'  || real   || mass of sample
 |-
-|'RMM'  || logical   || relative molecular mass of sample
+|'RMM'  || real  || relative molecular mass of sample
 |}

@@ Line 61: / Line 61: @@
 |  'mon_mask'|| 'string' || specifies a mask file, supplied parameter is defines the location of the monitor mask file
 |-
-|  'm_rebin'|| [xlo,dx,xhi] or [x_1,dx_1,x_2,dx_2,...,x_n,dx_n,x_n+1] || rebin parameters are defined according to the '''numerical''' array inputs of [rebin_x],[rebin] for single datasets
+|  'm_rebin'|| [xlo,dx,xhi] or [x_1,dx_1,x_2,dx_2,...,x_n,dx_n,x_n+1] || rebin parameters are defined according to the '''numerical''' array inputs of [[rebin_x]],[[rebin]] for single datasets
 |}

← Older revision		Revision as of 14:37, 31 March 2008
Line 1:		Line 1:
−	== Preparing the [IXTdata_source] ==	+	== Preparing the [[IXTdata_source]] ==

	All the population routines descirbed here use the [[IXTdata_source]] object. The [[IXTdata_source]] object is used to define source files for the population of an [[IXTrunfile]] object. Different source files can be added to the [[IXTdata_source]] object with their own special commands:		All the population routines descirbed here use the [[IXTdata_source]] object. The [[IXTdata_source]] object is used to define source files for the population of an [[IXTrunfile]] object. Different source files can be added to the [[IXTdata_source]] object with their own special commands:

← Older revision		Revision as of 10:36, 17 March 2008
Line 212:		Line 212:
	\|'RMM' \|\| logical \|\| relative molecular mass of sample		\|'RMM' \|\| logical \|\| relative molecular mass of sample
	\|}		\|}
−
−
−	see also: [Creating Datasets], [Arrays of Datasets], [Mathematical Functions and Operators], [Other Matlab Utilities], [Input and Output Functions], [Dataset Manipulation and Conversion Functions]
−
−	~~------~~

@@ Line 3: / Line 3: @@
 All the population routines descirbed here use the [[IXTdata_source]] object.  The [[IXTdata_source]] object is used to define source files for the population of an [[IXTrunfile]] object. Different source files can be added to the [[IXTdata_source]] object with their own special commands:
-*rawfiles: [[add_rawfile]]
+*rawfiles: [[add_rawfile]] [[add_multrawfile]]
 *monitor map files: [[add_monmap]]
 *monitor mask files: [[add_monmask]]

@@ Line 86: / Line 86: @@
 | 'period'   ||numeric ||specifies period default:1, if = 0 then spectra can be defined from more than one period
 |-
-|  'det_map' or [[IXTmap]]||'string' ||specifies a map file, supplied parameter is defines the location of the detector map file
+|  'det_map' or ||'string' or [[IXTmap]] ||specifies a map file, supplied parameter is defines the location of the detector map file
 |-
 | 'det_mask'||'string' ||specifies a mask file, supplied parameter is defines the location of the detector mask file
@@ Line 121: / Line 121: @@
 |'period'   || numeric || specifies period default:1, if = 0 then spectra can be defined from more than one period
 |-
-|'mon_map' or [[IXTmap]]|| 'string' || specifies a monitor map file, supplied parameter is defines the location of the monitor map file
+|  'mon_map' or ||'string' or [[IXTmap]] ||specifies a monitor map file, supplied parameter is defines the location of the monitor map file
 |-
 |'mon_mask'|| 'string' ||specifies a monitor mask file, supplied parameter is defines the location of the monitor mask file
@@ Line 127: / Line 127: @@
 |'m_rebin'|| [xlo,dx,xhi] or [x_1,dx_1,x_2,dx_2,...,x_n,dx_n,x_n+1] || specifies rebinning of monitor data, rebin parameters are defined according to the *numerical* array inputs of [rebin_x],[rebin] for single datasets
 |-
-|'det_map' or [[IXTmap]]|| 'string' || specifies a detector map file, supplied parameter is defines the location of the detector map file
+|  'det_map' or ||'string' or [[IXTmap]] ||specifies a detector map file, supplied parameter is defines the location of the detector map file
 |-
 |'det_mask'|| 'string' || specifies a detector mask file, supplied parameter is defines the location of the detector mask file
@@ Line 172: / Line 172: @@
 |'fixei' || real  || specifies a known incident energy, so that ei determination is not necessary
 |-
-|'mon_map' or [[IXTmap]]|| 'string' || specifies a monitor map file, supplied parameter is defines the location of the monitor map file
+|  'mon_map' or ||'string' or [[IXTmap]] || specifies a monitor map file, supplied parameter is defines the location of the monitor map file
 |-
 |'mon_mask'|| 'string' || specifies a monitor mask file, supplied parameter is defines the location of the monitor mask file
@@ Line 180: / Line 180: @@
 |'m_rebin'|| [xlo,dx,xhi] or [x_1,dx_1,x_2,dx_2,...,x_n,dx_n,x_n+1] || specifies rebinning of monitor data, rebin parameters are defined according to the *numerical* array inputs of [rebin_x],[rebin] for single datasets
 |-
-|'det_map' or [[IXTmap]]|| 'string' || specifies a detector map file, supplied parameter is defines the location of the detector map file
+|  'det_map' or ||'string' or [[IXTmap]] ||specifies a detector map file, supplied parameter is defines the location of the detector map file
 |-
 |'det_mask'|| 'string' || specifies a detector mask file, supplied parameter is defines the location of the detector mask file

@@ Line 22: / Line 22: @@
 There are three standard ways to populate an [[IXTrunfile]] object, all require an [[IXTdata_source]] object which has had the type of instrument defined in it ie. chopper or diffraction instrument. As well as simply loading data from a raw file the data can generally be optionally masked/mapped/rebinned using an argument to the population function as a keyword with an associated parameter (eg. a map/mask file, rebin parameters etc.)
-If a map/mask/raw file is provided as a command line argument, then it will override any specification already defined in the [IXTdata_source] object.
+*'''For any of these functions to run properly the matlab environment must be prepared by calling the [[instrument setup]] scripts.'''
+*If a map/mask/raw file is provided as a command line argument, then it will override any specification already defined in the [IXTdata_source] object.
-If no map files are defined, either on the command line or in the [[IXTdata_source]] object then a 1:1 mapping with _all_ spectra will be created by default. If no mask files are defined then all spectra will be included in the workspaces.
+*If no map files are defined, either on the command line or in the [[IXTdata_source]] object then a 1:1 mapping with _all_ spectra will be created by default. If no mask files are defined then all spectra will be included in the workspaces.
 The standard construction for these population routines is as follows.

@@ Line 73: / Line 73: @@
 >> runfile = mon(dso,run_no,'mon_map',monitor_map_file,'mon_mask',monitor_mask_file,'m_rebin',rebin_parameters)
 </pre>
 === spec ===

@@ Line 189: / Line 189: @@
 |'d_rebin'|| [xlo,dx,xhi] or [x_1,dx_1,x_2,dx_2,...,x_n,dx_n,x_n+1] || specifies rebinning of detector data, rebin parameters are defined according to the '''numerical''' array inputs of [rebin_x],[rebin] for single datasets. 'd_rebin' '''cannot''' be supplied with 'd_int'
 |-
-|'d_int'|| [xlo,xhi] || specifies limits for integration of the dataset between two limits, if 'det_units' has been supplied then integration will take place after units conversion, 'd_int' '''cannot''' be supplied with 'd_rebin'
+|'d_int'|| [xlo,xhi] || specifies limits for integration of the dataset between two limits, if 'det_units' has been supplied then integration will take place after units conversion, 'd_int' '''cannot''' be supplied with 'd_rebin'. limits are specified in the units of the data, therefore if your output units are 'w' then your integration limits are specified in meV. if no units are specified then the limits are in time (microseconds)
 |-
 |'background'|| [xlo,xhi] || specifies a background subtraction, the supplied parameter is a numerical array defining the background integration range in time-of-flight