Difference between revisions of "User Manual"

From LIBISIS
Jump to navigation Jump to search
Line 70: Line 70:
 
===[[Using Name Tags]]===
 
===[[Using Name Tags]]===
 
===[[Plot Commands]]===
 
===[[Plot Commands]]===
There are many different ways to plot datasets, these are all outlined [[Plot Commands | here]].
+
 
 +
dh, dl, dm, de
 +
 
 +
ph, pl, pm, pe, pd, pp
 +
 
 +
ds, da, mp
 +
 
 
===[[Pre-Emptive Formatting]]===
 
===[[Pre-Emptive Formatting]]===
Many properties can be set before a plot is made, for instance on a line plot, the line colour may be set before a plot is made
+
 
 +
acolor, aline, amark
 +
 
 
===[[Retrospective Formatting]]===
 
===[[Retrospective Formatting]]===
Most formatting is performed after a plot is made. This includes changing limits and
+
 
 +
lx, ly, lz
 +
 
 +
linlogbutton, linlogmenu, linx, logx, liny, logy, linz, logz
 +
 
 +
aspect
 +
 
 +
dxyz
 +
 
 +
kf keep_figure
 +
 
 +
set_plot, set_axes, set_figure
 +
 
 +
set_legend
 +
 
 
===[[Other Commands]]===
 
===[[Other Commands]]===
Some other commands are contained within the graphics package to facilitate the advanced user.
 
  
==Full Function List==
+
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
 +
 
 +
 
 +
==Redundant==
  
 
[[dean's test page]]
 
[[dean's test page]]

Revision as of 16:33, 18 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. 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.

Directory Structure

The functions are organised into a particular directorary structure outlined here.

General Behaviour

Most functions share a general behaviour outlined here

Data Manipulation Functions

Input and Output Functions

read_ascii, write_ascii

read_points, write_points

read_hist, write_hist

getspectra, getspectrum

Binary Operators

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

Elementary Functions

log, exp

sin, cos, tan

sinh, cosh, tanh

Data Manipulation Functions

shift, shift_x, shift_y, shift_xy

scale, scale_x, scale_y

flip, flip_x, flip_y

Rebin Functions

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

integrate_x, integrate_y, integrate_xy, integrate

smooth

interp_x, interp_y, interp

unspike

fit

func_eval


Special Functions

Special functions are provided, mainly for internal use, to convert datasets or change the properties of a dataset.

Graphics

Using Name Tags

Plot Commands

dh, dl, dm, de

ph, pl, pm, pe, pd, pp

ds, da, mp

Pre-Emptive Formatting

acolor, aline, amark

Retrospective Formatting

lx, ly, lz

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

aspect

dxyz

kf keep_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


Redundant

dean's test page