View source for IXTdataset 1d

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. 

[[Plot Commands#One Dimensional Plots|One dimensional plotting]] can be used to visualise the data and many functions exist to manipulate it given in the [[User Manual|user manual]]


==Fields==

IXTdataset_1d objects contain the following fields


{| {{Tablestyle}}
|-
! {{Headcellstyle}} | Field
! {{Headcellstyle}} | Description
|-
|'''[[IXTbase]]'''
| Object required for internal use 
|-
|'''title'''
| Title of the dataset used in [[Plot Commands|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 using the following syntax

<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
* Title, s_axis and x_axis will contain blank objects 
* x_distribution will be FALSE


datasets can also be made using commands found in [[Input and Output Functions|input and output functions]]

==Changing Values in an IXTdataset_1d object== 

The fields in the object are accessible on the matlab command line. Therefore the values of the fields can be changed easily, for instance

<pre>>> w.title = 'mytitle'</pre>

will set the title in w to 'mytitle'


==Examples==


'''Two Identical Scripts to Construct an IXTdataset_1d From a Function'''


Here, assume that a function my_func is some unusual function of the form

<tt>function y = my_polynom(x, pin)
y = pin(1).*x.^6 + pin(2).*x.*sin(x) + pin(3).*x</tt>


The function


<tt>x = 1:300

y = my_func(x, [2, 3, 2]) % generate y values

title = 'my unusual function' 

xaxis = [[IXTaxis]]('Independent Variable')

yaxis = [[IXTaxis]]('Dependent Variable')

e = zeros(size(x))       % need error values for full construction

w = IXTdataset_1d(IXTbase, title, y, e, yaxis, x, xaxis, false)

[[Plot Commands|dl]](w)   % plot the data</tt>


gives the same results as


<tt>x = 1:300

w = IXTdataset_1d(x)     % create dataset with blank y and e values

w.title = 'my unusual function'

w.x_axis = [[IXTaxis]]('Independent Variable')

w.y_axis = [[IXTaxis]]('Dependent Variable')

w = [[High Level Functions#Function Evaluation|func_eval(w, [2 3 2])

[[Plot Commands|dl]](w)</tt>