Difference between revisions of "IXTaxis"
m |
|||
| 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 33: | Line 32: | ||
The following syntax is used to create an IXTaxis object | The following syntax is used to create an IXTaxis object | ||
| + | |||
<pre>>>label = IXTaxis('caption', 'units', 'code')</pre> | <pre>>>label = IXTaxis('caption', 'units', 'code')</pre> | ||
| − | It is | + | |
| + | It is usually used as part of other objects, most commonly [[IXTdataset_1d]], [[IXTdataset_2d]], [[IXTrunfile]]. | ||
| Line 53: | Line 54: | ||
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. | 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== | ==Allowed Operations== | ||
Revision as of 14:00, 1 April 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 | caption to annotate the plot with |
| units | char | units of the axes (e.g. 'milliseconds') |
| code | char | units code used for conversions |
Creating an IXTaxis object
The following syntax is used to create an IXTaxis object
>>label = IXTaxis('caption', 'units', 'code')
It is usually used as part of other objects, most commonly IXTdataset_1d, IXTdataset_2d, IXTrunfile.
Example:
IXTdataset_2d(IXTbase, 'title', [signal], [error], IXTaxis,
[x], IXTaxis, [x_distribution], [y], IXTaxis, [y_distribution])
>> xlabel = IXTaxis('Time of Flight', 'microseconds', 't')
>> ylabel = IXTaxis('Spectrum Number', ' ', ' ')
>> slabel = IXTaxis('Intensity', 'arb', ' ')
>> 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