Difference between revisions of "IXTdataset 1d"
Jump to navigation
Jump to search
m |
|||
| Line 14: | Line 14: | ||
! {{Headcellstyle}} | Description | ! {{Headcellstyle}} | Description | ||
|- | |- | ||
| − | |'''IXTbase''' | + | |'''[[IXTbase]]''' |
| Object required for internal use | | Object required for internal use | ||
|- | |- | ||
| Line 43: | Line 43: | ||
The constructor for an IXTdataset_1d can be used to create a full IXTdataset_1d object | The constructor for an IXTdataset_1d can be used to create a full IXTdataset_1d object | ||
| − | <pre> w = IXTdataset_1d(IXTbase | + | <pre> w = IXTdataset_1d(base, 'title', [signal], [error], s_axis, [x], x_axis, [x_distribution])</pre> |
| + | |||
| + | * Length(signal), Length(error), Length(x) must all be equal | ||
| + | * signal, error and x must be one dimensional arrays | ||
| + | * s_axis and x_axis must be properly constructed [[IXTaxis]] objects | ||
| + | * x_distribution must be a logical value (1 or 0, TRUE or FALSE) | ||
| + | * base must be a properly constructed [[IXTbase]] object | ||
| + | |||
| + | Datasets without title and label information may be constructed using the syntax | ||
| + | |||
| + | <pre>w = IXTdataset_1d(x, signal, error)</pre> | ||
| + | |||
| + | * signal and error may be omitted. If so, w.signal and/or w.error will contain an array of 0's matching the dimensions of the x data | ||
| + | * | ||
==Examples== | ==Examples== | ||
Revision as of 11:58, 20 March 2008
An IXTdataset_1d is an object that stores signal and error data against one independent dimension (the x axis). Title and label information is also stored. These are used for manipulating and visualising a single spectrum.
One dimensional plotting can be used to visualise the data and many functions exist to manipulate it given in the user manual
Fields
IXTdataset_1d objects contain the following fields
| Field | Description |
|---|---|
| IXTbase | Object required for internal use |
| title | Title of the dataset used in plotting |
| signal | Signal data |
| error | Standard error |
| s_axis | IXTaxis object containing the signal axis label and units code information |
| x | Independent variable data (i.e. x data) |
| x_axis | IXTaxis object containing the x axis label and units code information |
| x_distribution | True if signal is a distribution on x (e.g. counts/microsecond) False if signal is not a distribution on x (e.g. counts) |
Constructing an IXTdataset_1d Object
The constructor for an IXTdataset_1d can be used to create a full IXTdataset_1d object
w = IXTdataset_1d(base, 'title', [signal], [error], s_axis, [x], x_axis, [x_distribution])
- Length(signal), Length(error), Length(x) must all be equal
- signal, error and x must be one dimensional arrays
- s_axis and x_axis must be properly constructed IXTaxis objects
- x_distribution must be a logical value (1 or 0, TRUE or FALSE)
- base must be a properly constructed IXTbase object
Datasets without title and label information may be constructed using the syntax
w = IXTdataset_1d(x, signal, error)
- signal and error may be omitted. If so, w.signal and/or w.error will contain an array of 0's matching the dimensions of the x data