Difference between revisions of "IXTaxis"
m |
m |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
The IXTaxis object contains a string defining the [[units code]], a string defining actual units and a string defining annotation for the axes | The IXTaxis object contains a string defining the [[units code]], a string defining actual units and a string defining annotation for the axes | ||
| Line 13: | Line 11: | ||
! {{Headcellstyle}} | Description | ! {{Headcellstyle}} | Description | ||
|- | |- | ||
| − | |base | + | |'''base''' |
|[[IXTbase]] | |[[IXTbase]] | ||
|object needed for internal reasons | |object needed for internal reasons | ||
|- | |- | ||
| − | |caption | + | |'''caption''' |
| − | |char | + | |char(allocatable) |
|caption to annotate the plot with | |caption to annotate the plot with | ||
|- | |- | ||
| − | |units | + | |'''units''' |
|char | |char | ||
|units of the axes (e.g. 'milliseconds') | |units of the axes (e.g. 'milliseconds') | ||
|- | |- | ||
| − | |code | + | |'''code''' |
| − | |char | + | |char(length 5) |
|[[units code]] used for conversions | |[[units code]] used for conversions | ||
|} | |} | ||
| + | |||
| + | ==Creating an IXTaxis object== | ||
| + | |||
| + | The following syntax is used to create an IXTaxis object | ||
| + | |||
| + | |||
| + | <pre>>>label = IXTaxis('caption', 'units', 'code')</pre> | ||
| + | |||
| + | * If any of the inputs is omitted it is left blank. | ||
| + | * 'caption' may be a cell array of strings. | ||
| + | |||
| + | |||
| + | It is usually used as part of other objects, most commonly [[IXTdataset_1d]], [[IXTdataset_2d]], [[IXTrunfile]]. | ||
| + | |||
| + | |||
| + | '''''Example:''''' | ||
| + | |||
| + | |||
| + | <tt>>> xlabel = IXTaxis('Time of Flight', 'microseconds', '$t') | ||
| + | |||
| + | >> ylabel = IXTaxis('Spectrum Number', ' ', '$spno') | ||
| + | |||
| + | >> slabel = IXTaxis('Intensity', 'Counts', '$cts') | ||
| + | |||
| + | >> w = [[IXTdataset_2d]]([[IXTbase]], 'Test Data', signal, error, slabel, x, xlabel, false, y, ylabel, false)</tt> | ||
| + | |||
| + | |||
| + | creates an [[IXTdataset_2d]] object with the x label as time of flight in microseconds, the y label as spectrum number and signal intensity in arbitrary units. | ||
| + | |||
| + | ==Allowed Operations== | ||
The following operations may be performed on this data type: | The following operations may be performed on this data type: | ||
Latest revision as of 14:15, 4 August 2008
The IXTaxis object contains a string defining the units code, a string defining actual units and a string defining annotation for the axes
The elements of the object are as follows:
| Element | Type | Description |
|---|---|---|
| base | IXTbase | object needed for internal reasons |
| caption | char(allocatable) | caption to annotate the plot with |
| units | char | units of the axes (e.g. 'milliseconds') |
| code | char(length 5) | units code used for conversions |
Creating an IXTaxis object
The following syntax is used to create an IXTaxis object
>>label = IXTaxis('caption', 'units', 'code')
- If any of the inputs is omitted it is left blank.
- 'caption' may be a cell array of strings.
It is usually used as part of other objects, most commonly IXTdataset_1d, IXTdataset_2d, IXTrunfile.
Example:
>> xlabel = IXTaxis('Time of Flight', 'microseconds', '$t')
>> ylabel = IXTaxis('Spectrum Number', ' ', '$spno')
>> slabel = IXTaxis('Intensity', 'Counts', '$cts')
>> w = IXTdataset_2d(IXTbase, 'Test Data', signal, error, slabel, x, xlabel, false, y, ylabel, false)
creates an IXTdataset_2d object with the x label as time of flight in microseconds, the y label as spectrum number and signal intensity in arbitrary units.
Allowed Operations
The following operations may be performed on this data type:
Class specific Functions