Difference between revisions of "User Manual"

From LIBISIS
Jump to navigation Jump to search
m
Line 3: Line 3:
 
== Overview ==
 
== Overview ==
  
There are many different object types within Libisis used to store experimental data. Once an object is created, functions exist to manipulate the data contained within. The most common objects for plotting and data manipulation are [[IXTdataset_1d]] and [[IXTdataset_2d]] objects. All relevant data pertaining to a run can be stored in an [[IXTrunfile]] object. Data from many different file formats may be read into these objects for manipulation. Described below are many different functions for handling data.
+
There are many different object types within Libisis used to store experimental data. Once an object is created, functions exist to manipulate the data contained within. The most common objects for plotting and data manipulation are [[IXTdataset_1d]] and [[IXTdataset_2d]] objects. [[IXTrunfile]] objects contain all raw data from a run.
  
===[[Directory Structure]]===
+
[[IXTdataset_1d]] objects store signal and error information against one dimension (the x axis). Label and titling information is also stored. [[IXTdataset_2d]] objects also contain a second dimension (the y axis).
The functions are organised into a particular directorary structure outlined [[Directory Structure|here]].
+
 
 +
All relevant data pertaining to a run can be stored in an [[IXTrunfile]] object. The object can be thought of as an array of [[IXTdataset_2d]] objects with a lot of additional information.
 +
 
 +
Data is read into these objects (using methods described below) and can then be manipulated using many different tools and functions described in this documentation.  
  
 
===[[General Behaviour]]===
 
===[[General Behaviour]]===
Line 14: Line 17:
  
 
=== [[Input and Output Functions]] ===
 
=== [[Input and Output Functions]] ===
[[Input and Output Functions#ASCII Files|read_ascii]], [[Input and Output Functions#ASCII Files|write_ascii]]
+
[[Input and Output Functions#RAW Files|getspectra]], [[Input and Output Functions#RAW Files|getspectrum]] - Read in spectra from IXTraw_file objects or from RAW files
 +
 
 +
[[Input and Output Functions#ASCII Files|read_ascii]], [[Input and Output Functions#ASCII Files|write_ascii]] - Read or write to text files
 +
 
 +
[[Input and Output Functions#Point Data|read_points]], [[Input and Output Functions#Point Data|write_points]] - Read or write to text files, forcing data to be point data
 +
 
 +
[[Input and Output Functions#Histogram Data|read_hist]], [[Input and Output Functions#Histogram Data|write_hist]] - Read or write to text files, forcing data to be histogram data
  
[[Input and Output Functions#Point Data|read_points]], [[Input and Output Functions#Point Data|write_points]]
 
  
[[Input and Output Functions#Histogram Data|read_hist]], [[Input and Output Functions#Histogram Data|write_hist]]
 
  
[[Input and Output Functions#RAW Files|getspectra]], [[Input and Output Functions#RAW Files|getspectrum]]
 
  
 
=== [[Binary Operators]] ===
 
=== [[Binary Operators]] ===
 
Binary operators such as +, -, *, etc. are used to perform arithmetic operations between datasets and/or numbers  
 
Binary operators such as +, -, *, etc. are used to perform arithmetic operations between datasets and/or numbers  
 +
 
=== [[Elementary Functions]]===
 
=== [[Elementary Functions]]===
 +
 +
Elementary functions act on each signal element identically
 +
 
[[Elementary Functions|log]], [[Elementary Functions|exp]]
 
[[Elementary Functions|log]], [[Elementary Functions|exp]]
  
Line 32: Line 42:
  
 
=== [[Data Manipulation Functions]] ===
 
=== [[Data Manipulation Functions]] ===
[[Data Manipulation Functions#Shift Functions|shift]], [[Data Manipulation Functions#Shift Functions|shift_x]], [[Data Manipulation Functions#Shift Functions|shift_y]], [[Data Manipulation Functions#Shift Functions|shift_xy]]
+
[[Data Manipulation Functions#Shift Functions|shift]], [[Data Manipulation Functions#Shift Functions|shift_x]], [[Data Manipulation Functions#Shift Functions|shift_y]], [[Data Manipulation Functions#Shift Functions|shift_xy]] - Shift data along an independent axis
  
[[Data Manipulation Functions#Scale Functions|scale]], [[Data Manipulation Functions#ScaleFunctions|scale_x]], [[Data Manipulation Functions#Scale Functions|scale_y]]
+
[[Data Manipulation Functions#Scale Functions|scale]], [[Data Manipulation Functions#ScaleFunctions|scale_x]], [[Data Manipulation Functions#Scale Functions|scale_y]] - Scale one of the independent axes
  
[[Data Manipulation Functions#Flip Functions|flip]], [[Data Manipulation Functions#Flip Functions|flip_x]], [[Data Manipulation Functions#Flip Functions|flip_y]]
+
[[Data Manipulation Functions#Flip Functions|flip]], [[Data Manipulation Functions#Flip Functions|flip_x]], [[Data Manipulation Functions#Flip Functions|flip_y]] - Reverse the data in a dataset
  
 
=== [[Rebin Functions]] ===
 
=== [[Rebin Functions]] ===
 +
 +
Three different methods exist for rebinning a function. Rebin will rebin the data into user defined bins. Rebunch will bunch together a user defined number of bins. Regroup rebins data using a minimum binwidth given by the user but insures that the new bins are coincident with the existing bins.
 +
 
[[Rebin Functions#Rebin Functions|rebin]], [[Rebin Functions#Rebin Functions|rebin_x]], [[Rebin Functions#Rebin Functions|rebin_y]], [[Rebin Functions#Rebin Functions|rebin_xy]]
 
[[Rebin Functions#Rebin Functions|rebin]], [[Rebin Functions#Rebin Functions|rebin_x]], [[Rebin Functions#Rebin Functions|rebin_y]], [[Rebin Functions#Rebin Functions|rebin_xy]]
  
Line 48: Line 61:
 
=== [[High Level Functions]] ===
 
=== [[High Level Functions]] ===
  
[[High Level Functions#First Derivative|deriv1x]], [[High Level Functions#Second Derivative|deriv2x]], [[High Level Functions#First Derivative|deriv1y]], [[High Level Functions#Second Derivative|deriv2y]], [[High Level Functions#First Derivative|deriv1]], [[High Level Functions#Second Derivative|deriv2]]
+
[[High Level Functions#First Derivative|deriv1x]], [[High Level Functions#Second Derivative|deriv2x]], [[High Level Functions#First Derivative|deriv1y]], [[High Level Functions#Second Derivative|deriv2y]], [[High Level Functions#First Derivative|deriv1]], [[High Level Functions#Second Derivative|deriv2]] - Takes derivatives of a dataset
  
[[High Level Functions#Integral Functions|integrate_x]], [[High Level Functions#Integral Functions|integrate_y]], [[High Level Functions#Integral Functions|integrate_xy]], [[High Level Functions#Integral Functions|integrate]]
+
[[High Level Functions#Integral Functions|integrate_x]], [[High Level Functions#Integral Functions|integrate_y]], [[High Level Functions#Integral Functions|integrate_xy]], [[High Level Functions#Integral Functions|integrate]] - Integrates a dataset between user defined limits
  
[[High Level Functions#Smooth Functions|smooth]]
+
[[High Level Functions#Smooth Functions|smooth]] - Smooths out signal data to avoid small, sharp deviations
  
[[High Level Functions#Interpolate Functions|interp_x]], [[High Level Functions#Interpolate Functions|interp_y]], [[High Level Functions#Interpolate Functions|interp]]
+
[[High Level Functions#Interpolate Functions|interp_x]], [[High Level Functions#Interpolate Functions|interp_y]], [[High Level Functions#Interpolate Functions|interp]] - Interpolates data onto a different set of points
  
[[High Level Functions#Unspike Functions|unspike]]
+
[[High Level Functions#Unspike Functions|unspike]] - Removes any large spikes from the data
  
[[High Level Functions#Fit Functions|fit]]
+
[[High Level Functions#Fit Functions|fit]] - Fitting data to known functions and giving curves of best fit
  
[[High Level Functions#Function Evaluation|func_eval]]
+
[[High Level Functions#Function Evaluation|func_eval]] - Evaluate a function at the given x and y data points
  
  
 
=== [[Special Functions]] ===
 
=== [[Special Functions]] ===
[[Special Functions#Contract Functions|contract]]  
+
Special functions are used to transform data between different types.
 +
 
 +
[[Special Functions#Contract Functions|contract]] - Turn an array of [[IXTdataset_2d]] objects into a single [[IXTdataset_2d]] object
  
[[Special Functions#Expand Functions|expand_d1d]], [[Special Functions#Expand Functions|expand_listd1d]], [[Special Functions#Expand Functions|expand_d2d]], [[Special Functions#Expand Functions|expand_listd2d]]
+
[[Special Functions#Expand Functions|expand_d1d]], [[Special Functions#Expand Functions|expand_listd1d]], [[Special Functions#Expand Functions|expand_d2d]], [[Special Functions#Expand Functions|expand_listd2d]] - Expand single objects into many objects
  
[[Special Functions#Conversion Functions|oned_to_twod]]
+
[[Special Functions#Conversion Functions|oned_to_twod]] - Convert an [[IXTdataset_1d]] into an [[IXTdataset_2d]]
  
[[Special Functions#Conversion Functions|hist2point]], [[Special Functions#Conversion Functions|hist2point_x]], [[Special Functions#Conversion Functions|hist2point_y]],
+
[[Special Functions#Conversion Functions|hist2point]], [[Special Functions#Conversion Functions|hist2point_x]], [[Special Functions#Conversion Functions|hist2point_y]] - Convert between histogram and point data
  
 
==Graphics==
 
==Graphics==
Line 78: Line 93:
 
===[[Plot Commands]]===
 
===[[Plot Commands]]===
  
[[Plot Commands#One Dimensional Plots|dh]], [[Plot Commands#One Dimensional Plots|dk]], [[Plot Commands#One Dimensional Plots|dm]], [[Plot Commands#One Dimensional Plots|de]], [[Plot Commands#One Dimensional Plots|dp]], [[Plot Commands#One Dimensional Plots|dd]]
+
[[Plot Commands#One Dimensional Plots|dh]], [[Plot Commands#One Dimensional Plots|dl]], [[Plot Commands#One Dimensional Plots|dm]], [[Plot Commands#One Dimensional Plots|de]], [[Plot Commands#One Dimensional Plots|dp]], [[Plot Commands#One Dimensional Plots|dd]]
  
 
[[Plot Commands#Overplots|ph]], [[Plot Commands#Overplots|pl]], [[Plot Commands#Overplots|pm]], [[Plot Commands#Overplots|pe]], [[Plot Commands#Overplots|pp]], [[Plot Commands#Overplots|pd]]
 
[[Plot Commands#Overplots|ph]], [[Plot Commands#Overplots|pl]], [[Plot Commands#Overplots|pm]], [[Plot Commands#Overplots|pe]], [[Plot Commands#Overplots|pp]], [[Plot Commands#Overplots|pd]]

Revision as of 11:22, 20 March 2008

There are many different Matlab commands within Libisis. These include basic commands, such as taking the exponential of a dataset, through to integration and plotting commands. The following is an online user manual for the matlab interface of the Libisis software.

Overview

There are many different object types within Libisis used to store experimental data. Once an object is created, functions exist to manipulate the data contained within. The most common objects for plotting and data manipulation are IXTdataset_1d and IXTdataset_2d objects. IXTrunfile objects contain all raw data from a run.

IXTdataset_1d objects store signal and error information against one dimension (the x axis). Label and titling information is also stored. IXTdataset_2d objects also contain a second dimension (the y axis).

All relevant data pertaining to a run can be stored in an IXTrunfile object. The object can be thought of as an array of IXTdataset_2d objects with a lot of additional information.

Data is read into these objects (using methods described below) and can then be manipulated using many different tools and functions described in this documentation.

General Behaviour

Most functions share a general behaviour outlined here

Data Manipulation Functions

Input and Output Functions

getspectra, getspectrum - Read in spectra from IXTraw_file objects or from RAW files

read_ascii, write_ascii - Read or write to text files

read_points, write_points - Read or write to text files, forcing data to be point data

read_hist, write_hist - Read or write to text files, forcing data to be histogram data



Binary Operators

Binary operators such as +, -, *, etc. are used to perform arithmetic operations between datasets and/or numbers

Elementary Functions

Elementary functions act on each signal element identically

log, exp

sin, cos, tan

sinh, cosh, tanh

Data Manipulation Functions

shift, shift_x, shift_y, shift_xy - Shift data along an independent axis

scale, scale_x, scale_y - Scale one of the independent axes

flip, flip_x, flip_y - Reverse the data in a dataset

Rebin Functions

Three different methods exist for rebinning a function. Rebin will rebin the data into user defined bins. Rebunch will bunch together a user defined number of bins. Regroup rebins data using a minimum binwidth given by the user but insures that the new bins are coincident with the existing bins.

rebin, rebin_x, rebin_y, rebin_xy

rebunch, rebunch_x, rebunch_y, rebunch_xy

regroup, regroup_x, regroup_y, regroup_xy

High Level Functions

deriv1x, deriv2x, deriv1y, deriv2y, deriv1, deriv2 - Takes derivatives of a dataset

integrate_x, integrate_y, integrate_xy, integrate - Integrates a dataset between user defined limits

smooth - Smooths out signal data to avoid small, sharp deviations

interp_x, interp_y, interp - Interpolates data onto a different set of points

unspike - Removes any large spikes from the data

fit - Fitting data to known functions and giving curves of best fit

func_eval - Evaluate a function at the given x and y data points


Special Functions

Special functions are used to transform data between different types.

contract - Turn an array of IXTdataset_2d objects into a single IXTdataset_2d object

expand_d1d, expand_listd1d, expand_d2d, expand_listd2d - Expand single objects into many objects

oned_to_twod - Convert an IXTdataset_1d into an IXTdataset_2d

hist2point, hist2point_x, hist2point_y - Convert between histogram and point data

Graphics

Using Default Properties and Name Tags

Plot Commands

dh, dl, dm, de, dp, dd

ph, pl, pm, pe, pp, pd

ds, da, mp

sm

Pre-Emptive Formatting

acolor, aline, amark

Retrospective Formatting

lx, ly, lz

linlogbutton, linlogmenu, linx, logx, liny, logy, linz, logz

aspect

dxyz

kf keep_figure, rf release figure

set_plot, set_axes, set_figure

set_legend

Other Commands

sdp, set_default_property, sup, set_user_propety, ra, reset_all, rd, reset_default

gallnt, gallh, check_figure, chkf, get_handle, gh, alias

undop

color_slider

rename

fromplot

User Reference

Information for reference purposes, such as valid linestyles, marker styles etc.

Redundant

dean's test page