ifit.mccode.org - Description of iData

DESCRIPTION

 d = iData(a, ...) : iData class object constructor

 The iData objects are the containers where to import your data sets. It is then
 possible to Load, Plot, apply Math operators, Fit, and Save.

 Creates an iData object which contains data along with additional information.
   An iData object may store any Data, and define its Signal, Error, Monitor, 
     and Axes as aliases refering to e.g. parts of the Data.
   The input argument 'a', is converted into an iData object. It may be:
     a scalar/vector/matrix
       iData(1:100)
     a string giving a file name to load. Use alternatively iData/load.
       iData('filename_data')
     a structure
     a cell array which elements are imported separately
     a iData object (updated if no output argument is specified).
   The special syntax iData(x,y, .., c) creates an iData with
     signal c and axes x,y, ...
   The syntax iData(iFunc object, pars, axes) evaluates the iFunc model using the 
     iData object axes, and returns the model value as an iData object.
   The output argument is a single object or array of iData.
   Input arguments may be more than one, or given as cells.

 When used with file names, compressed files may be used, as well as URLs and internal
   anchor reference using the '#' character, such as in 'http://path/file.zip#Data'.

 Type <a href="matlab:doc(iData)">doc(iData)</a> to access the iFit/iData Documentation.
 Refer to <a href="matlab:doc iData/load">iData/load</a> for more information about loading data sets.
 iData is part of iFit http://ifit.mccode.org 

 examples:
   d=iData('filename'); a=iData('http://filename.zip#Data');
   d=iData(rand(10));

 Version: Aug. 22, 2017
 See also: iData, iData/load, methods, iData/setaxis, iData/setalias, iData/doc
 (c) E.Farhi, ILL. License: EUPL.

CROSS-REFERENCE INFORMATION

disp disp(s) : display iData object (details)

double d = double(s) : convert iData into doubles

end b = end(s,index,n) : end value for iData objects

find d = find(s) : find iData signal non zeros values

get [...] = get(s, 'PropertyName', ...) : get iData object properties

getaxis [val, lab] = getaxis(s, AxisIndex) : get iData axis value and label

iData d = iData(a, ...) : iData class object constructor

isempty isempty(s) : true for empty iData object

isfield b = isfield(s, field) : check existence of field/alias in iData objects

isnan b = isnan(s) : True for NaN iData object elements

isnumeric b = isnumeric(s) : True for numeric iData object elements

isvector b = isvector(s) : True for vector iData object

label b = label(s, alias, label) : Change iData label for a given alias/axis

load d = load(s, file, loader, ...): iData file loader

ndims d = ndims(s) : get the dimensionality of iData object

reshape c = reshape(a) : reshape the object Signal

set [s,...] = set(s, 'PropertyName', Propertyvalue, ...) : set iData properties

setalias [s,...] = setalias(s, AliasName, AliasLink, {AliasLabel}) : set iData aliases

setaxis s = setaxis(s, rank, alias, value) : set iData axes

size size(s) : get iData object size (number of elements)

version v = version(iData): iData class version

camproj s = camproj(a,dim) : projection/radial integration of iData objects elements

cart2sph s = cart2sph(a,dim) : cartesian to polar/spherical representation of iData objects

cell [content,fields]=cell(s) : convert iData objects into cells

conv c = conv(a,b) : computes the convolution of iData objects

copyobj b = copyobj(s) : makes a copy of iData object

cwt b = cwt(s,dim,scales,wname,'wname',...) : Continuous wavelet transform

doc doc(iData): iData web page documentation

dog s= dog(dim,a) : split iData objects elements along dimension

edit edit(s) : edit iData object Signal/Monitor

fft c = fft(a) : computes the Discrete Fourier transform of iData objects

fill FILL fill-in over missing data

get [...] = get(s, 'PropertyName', ...) : get iData object properties

hist hist(a, axis1, axis2, ...) computes the accumulated histogram from event data sets

iData d = iData(a, ...) : iData class object constructor

image h = image(r,g,b, option) : Plot up to 3 images overlayed on the RGB channels

interp [b...] = interp(s, ...) : interpolate iData object

intersect [ai,bi] = intersect(a, b) : computes object intersection area and values

isfield b = isfield(s, field) : check existence of field/alias in iData objects

jacobian [b, j] = jacobian(a, new_axes, 'new_axes_labels'...) : computes the gradient (derivative) of iData objects

kmeans [b,c] = kmeans(X, k) : k-means clustering of iData object

linspace v = linspace(a,b,n) : creates a linearly spaced vector of objects

logspace v = logspace(a,b,n) : creates a logarithmically spaced vector of objects

meshgrid s = meshgrid(a) : transforms an iData object so that its axes are grids

mtimes c = mtimes(a,b) : computes the matrix product of iData objects

pack b = pack(a) : compress iData storage to save memory

reducevolume h = reducevolume(s, factor) : reduce an iData object size

rotate s = rotate(a, theta) : computes the rotation of iData objects around the origin

saveas f = saveas(s, filename, format, options) : save iData object into various data formats

set [s,...] = set(s, 'PropertyName', Propertyvalue, ...) : set iData properties

setalias [s,...] = setalias(s, AliasName, AliasLink, {AliasLabel}) : set iData aliases

setaxis s = setaxis(s, rank, alias, value) : set iData axes

smooth Z = smooth(Y) : smooth iData objects

sort s = sort(a,dim) : Sort iData objects axes in ascending or descending order

subsasgn b = subsasgn(a,index,b) : iData indexed assignement

subsref b = subsref(a,s) : iData indexed references

unique s = unique(a,dim) : set unique iData objects axes with no repetitions

zeros s = zeros(s,N,M,P,...) : initialize an iData array

iFit/iData

PURPOSE

SYNOPSIS

DESCRIPTION

CROSS-REFERENCE INFORMATION