diff --git a/Docs/Math.html b/Docs/Math.html
index e1819b45..944f0ca7 100644
--- a/Docs/Math.html
+++ b/Docs/Math.html
@@ -486,6 +486,18 @@
resize
|
Resized signal
@@ -930,7 +942,10 @@ Convolution/correlation
computes the cross correlation of two signals. The auto-correlation is simply
xcorr(a).
-Last, the corrcoef method returns the Pearson product-moment correlation coefficient, which measures the similarity between two data sets. It returns a measure of the similarity between data sets (1=equal, 0=non correlated, -1=anti-correlated).
+Last, the corrcoef method returns the Pearson product-moment correlation coefficient,
+ which measures the similarity between two data sets. It returns a
+measure of the similarity between data sets (1=equal, 0=non correlated,
+-1=anti-correlated).
Warning: The accuracy of the conv and xcorr
operators depends on the axis sampling. A coarse axis sampling (that is
@@ -1053,6 +1068,11 @@ Data segmentation (partitioning
The wavelet transform cwt may also be used to perform a peak analysis, separating sharp features from broad ones (see above).
+
+The principal component analysis
+ (PCA) methodology consists in finding similarities between data sets.
+Groups of 'close' data sets can then be defined. The corresponding iData
+ method is pca .
Projection, integration and sum
There
are
diff --git a/Docs/Methods.html b/Docs/Methods.html
index fd5a8134..9f6ec2cd 100644
--- a/Docs/Methods.html
+++ b/Docs/Methods.html
@@ -35,6 +35,9 @@ iF
>> methods(iData)
The help windows then displays the help for each command (usage, input and output arguments, examples, ...).
+To get help of any of these iData methods, type e.g.:
+>> help iData/load
+
Most of these methods are also valid for iFunc model objects, and the naming corresponds with standard Matlab functions.
data structure, aliases, signal and axes
@@ -42,17 +45,17 @@
- - iData: defines a new
+
- iData: defines a new
iData object from variables, arrays,
files, figures and more.
- - set: sets
+
- set: sets
an
iData
property
or
alias
value
- - get: gets
+
- get: gets
an
iData
property
@@ -64,7 +67,7 @@
setalias: defines
+ - setalias: defines
an
alias,
that
@@ -77,11 +80,11 @@
getalias: gets
+ - getalias: gets
an
alias
definition
- - label: defines
+
- label: defines
the
object
alias
@@ -90,7 +93,7 @@
xlabel: sets
+ - xlabel: sets
or
get
2nd
@@ -99,7 +102,7 @@
ylabel: sets
+ - ylabel: sets
or
get
1st
@@ -108,7 +111,7 @@
zlabel: sets
+ - zlabel: sets
or
get
the
@@ -117,7 +120,7 @@
clabel: sets
+ - clabel: sets
or
get
the
@@ -125,11 +128,11 @@
rmalias: removes
+ - rmalias: removes
an
alias
definition
- - rmaxis: removes
+
- rmaxis: removes
an
axis
definition,
@@ -138,7 +141,7 @@
setaxis and a{n}: defines
+ - setaxis and a{n}: defines
an
axis
as
@@ -151,11 +154,11 @@
getaxis
-and a{n}:
+ - getaxis
+and a{n}:
gets the axis value and definition. The axis 0 refers to the
Signal/Monitor.
- - ndims: returns
+
- ndims: returns
the
dimentionality
of
@@ -167,7 +170,7 @@
size: returns
+ - size: returns
the
size
of
@@ -178,11 +181,11 @@
squeeze: removes singleton
+ - squeeze: removes singleton
dimension from iData object or array
- - isfield: checks if a name is defined in the iData object as a structure field or alias
-- circshift: shifts an axis by a given quantify, equivalent to a{n} = a{n} +delta
-- fileattrib: sets/gets object property attributes, extracted from initial file (text/HDF/NeXus/CDF/NetCDF)
+ - isfield: checks if a name is defined in the iData object as a structure field or alias
+- circshift: shifts an axis by a given quantify, equivalent to a{n} = a{n} +delta
+- fileattrib: sets/gets object property attributes, extracted from initial file (text/HDF/NeXus/CDF/NetCDF)
@@ -195,14 +198,14 @@
- - commandhistory: returns
+
- commandhistory: returns
the
list
of
past commands performed in order to get
the current object. It is also possible to export the history of an object into a Matlab script.
- - copyobj: copies
+
- copyobj: copies
an
object
into
@@ -214,7 +217,7 @@
disp: displays
+ - disp: displays
the
object
description,
@@ -222,27 +225,27 @@
display: displays
+ - display: displays
a
short
description
of
the
object
- - edit: edits the Signal/Monitor
+
- edit: edits the Signal/Monitor
of the object as a Table/spreadsheet.
- - doc: opens
+
- doc: opens
the
iData
documentation
as
web
pages
- - methods:
+
- methods:
opens the iData methods documentation (this page)
- - findfield: searches
+
- findfield: searches
in
objects
for
@@ -253,14 +256,14 @@
findobj: searches
+ - findobj: searches
for
objects
in
the
workspace/memory
- - findstr: searches
+
- findstr: searches
in
objects
for
@@ -272,10 +275,10 @@
flipud: flips along up/down, that is revert the Y axis (vertical) on 2D objects
- - fliplr: flips along left/right, that is revert the X axis (horizontal) on 2D objects
+ - flipud: flips along up/down, that is revert the Y axis (vertical) on 2D objects
+ - fliplr: flips along left/right, that is revert the X axis (horizontal) on 2D objects
- - full: switches
+
- full: switches
the
object
to
@@ -284,7 +287,7 @@
sparse: switches
+ - sparse: switches
the
object
to
@@ -302,7 +305,7 @@
ind2sub: gets
+ - ind2sub: gets
indexed
element
in
@@ -310,7 +313,7 @@
pack: selects
+ - pack: selects
automatically
the
full
@@ -324,16 +327,16 @@
permute: dimensions permutation (generalized transposition)
-- reshape: re-orders elements of an object
+ - permute: dimensions permutation (generalized transposition)
+- reshape: re-orders elements of an object
-- reducevolume: rebins the object so that it contains a larger binning, or less that 1e6 elements
-- resize: fast rebinning of an object
+ - reducevolume: rebins the object so that it contains a larger binning, or less that 1e6 elements
+- resize: fast rebinning of an object
- - version: displays
+
- version: displays
the
iData
library
@@ -346,10 +349,10 @@
Saving objects are available.
- - iData: defines a new
+
- iData: defines a new
iData object from variables, arrays,
files, figures and more.
- - load: loads
+
- load: loads
file(s)
and
convert
@@ -359,7 +362,7 @@
saveas: exports
+ - saveas: exports
objects
into
many
@@ -368,9 +371,9 @@
save: is the same as saveas.
+ - save: is the same as saveas.
- - getframe: creates
+
- getframe: creates
a
snapshopt
image
@@ -379,14 +382,14 @@
cell: converts
+ - cell: converts
an
object
into
a
cell
- - char: converts
+
- char: converts
an
object
into
@@ -399,7 +402,7 @@
double: converts
+ - double: converts
an
object
into
@@ -412,13 +415,13 @@
findobj: finds
+ - findobj: finds
iData
objects
in
memory
- - logical: converts
+
- logical: converts
an
object
into
@@ -426,20 +429,20 @@
ones: initialize
+ - ones: initialize
an
array
of
objects (same as zeros)
- - real: extracts
+
- real: extracts
the
real
part
of
an
object
- - imag: extracts
+
- imag: extracts
the
imaginary
part
@@ -455,7 +458,7 @@
single: converts
+ - single: converts
an
object
into
@@ -464,10 +467,10 @@
struct: convert an object into a
+ - struct: convert an object into a
structure
- - zeros: initialize
+
- zeros: initialize
an
array
of
@@ -480,7 +483,7 @@
- - find: finds
+
- find: finds
non
zeros
elements
@@ -488,34 +491,34 @@
isempty: tests
+ - isempty: tests
objects
for
emptyness
(dimension=0)
- - gt
+
- gt
and >: greater than
comparison
- - lt
+
- lt
and <:
lower than comparison
- - ge
+
- ge
and >=:
greater or equal than comparison
- - le
+
- le
and <=:
greater or equal than comparison
- - eq
+
- eq
and ==:
equal comparison
- - ne
+
- ne
and ~=:
not equal comparison
- - isfinite: returns
+
- isfinite: returns
index
of
elements
@@ -526,7 +529,7 @@
isfloat: tests
+ - isfloat: tests
if
object
Signal
@@ -536,7 +539,7 @@
isinf: tests
+ - isinf: tests
if
object
Signal
@@ -544,13 +547,13 @@
isinteger: tests
+ - isinteger: tests
if
object
Signal
stores
integers
- - islogical: tests
+
- islogical: tests
if
object
Signal
@@ -558,14 +561,14 @@
isnan: tests
+ - isnan: tests
if
object
Signal
contains
NaN
values
- - isnumeric: tests
+
- isnumeric: tests
if
object
Signal
@@ -576,10 +579,10 @@
isreal: tests
+ - isreal: tests
if object Signal stores real values (that is no imaginary part)
- - isscalar: tests
+
- isscalar: tests
if
object
is
@@ -588,7 +591,7 @@
issparse: tests
+ - issparse: tests
if
object
Signal
@@ -599,18 +602,18 @@
isvector: tests
+ - isvector: tests
if
object
is
a
vector
(dim=1)
- - not: not
+
- not: not
equal
comparison
- - sign: returns
+
- sign: returns
the
sign
of
@@ -623,57 +626,57 @@
iData
mathematical operators is available.
- - abs: absolute value
+
- abs: absolute value
(complex modulus)
- - acos: arc cosine
- - asin: arc sine
- - atan: arc tangent
- - cos: cosine
- - cosh, sinh, tanh: hyperbolic trigonometric functions
- - acosh, asinh, atanh: inverse hyperbolic trigonometric functions
- - conj: complex conjugate
+ - acos: arc cosine
+ - asin: arc sine
+ - atan: arc tangent
+ - cos: cosine
+ - cosh, sinh, tanh: hyperbolic trigonometric functions
+ - acosh, asinh, atanh: inverse hyperbolic trigonometric functions
+ - conj: complex conjugate
- - ctranspose: complex
+
- ctranspose: complex
conjugate transpose (')
- - exp: exponent
- - floor: lower integer
- - eval: evaluates a model
+
- exp: exponent
+ - floor: lower integer
+ - eval: evaluates a model
using the axes of an object (similar to eval)
- - imag: imaginary part
- - ldivide: combine (.\)
+ - imag: imaginary part
+ - ldivide: combine (.\)
- - log: log (base 2)
- - log10: log base 10
- - minus: subtraction (-)
+ - log: log (base 2)
+ - log10: log base 10
+ - minus: subtraction (-)
- - mldivide: combine
+
- mldivide: combine
(\)
- - mrdivide: divide (/)
+ - mrdivide: divide (/)
- - mtimes: multiplication (*)
+ - mtimes: multiplication (*)
- - plus: addition (+)
+ - plus: addition (+)
- - power: exponentiation (^)
+ - power: exponentiation (^)
- - rdivide: divide (./)
+ - rdivide: divide (./)
- - sign: sign of object
+
- sign: sign of object
Signal
- - sin: sine
- - sqr: square (power 2, ^2)
- - sqrt: square root
- - tan: tangent
- - times: multiplication (.*)
+ - sin: sine
+ - sqr: square (power 2, ^2)
+ - sqrt: square root
+ - tan: tangent
+ - times: multiplication (.*)
- - transpose: non-conjugate
+
- transpose: non-conjugate
transpose (.')
- - permute: dimensions permutation (generalized transposition)
+ - permute: dimensions permutation (generalized transposition)
@@ -684,28 +687,28 @@
@@ -715,29 +718,32 @@ fitting are available.
- - min: returns the minimum
+
- min: returns the minimum
Signal value or the minimum of two objects.
- - max: returns the maximum
+
- max: returns the maximum
Signal value or the maximum of two objects.
- - mean: returns the mean
+
- mean: returns the mean
Signal value.
- - median: returns the
+
- median: returns the
median Signal value.
- - std: computes the
+
- std: computes the
standard deviation (second moment) of object along each axis, that is
the Gaussian half width. The center of mass/first moment can also be
obtained.
- - peaks: returns a fast
+
- peaks: returns a fast
analysis of object and returns peak positions, amplitudes and width, as
well as base-line/background.
- object(model, parameters, ...): evaluates a model
function onto object axes.
-- fits: finds best model
+
- fits: finds best model
parameters to fit the Signal. New
fit functions/models can be created with the iFunc/Model Builder tool.
-- corrcoef: compute the correlation (Pearson) between an object and something else.
-
+- corrcoef: compute the correlation coefficient (Pearson) between an object and something else.
+- kmeans: data segmentation in k partitions/groups/clusters/segments
+- pca: principal component analysis in a k-space
+
+
math: integration and derivatives,
@@ -747,13 +753,13 @@
- - camproj: extracts the
+
- camproj: extracts the
projection of the object onto a selected axis by summing along all
other dimensions. The resulting object is a vectorial object (ndims=1).
The projection along one axis is the sum along all other axes. When dim='radial' a radial integration is performed (assumes all axes are of coordinates).
-- cart2sph: transforms an object from Cartesian to spherical/polar coordinates.
+- cart2sph: transforms an object from Cartesian to spherical/polar coordinates.
- - trapz: integrates object
+
- trapz: integrates object
along a given dimension. The resulting object has this dimension
removed. As opposed to sum, the
@@ -769,38 +775,38 @@
trapz method takes into
account the axis binning, which may be uneven.
- - sum: sums object along a
+
- sum: sums object along a
given dimension. The resulting object has this dimension removed. As
opposed to trapz, the sum method does not take into
account the axis binning.
- - norm: computes the norm-2 of the object Signal.
+ - norm: computes the norm-2 of the object Signal.
- - prod: multiplies object
+
- prod: multiplies object
elements along a given dimension. The resulting object has this
dimension removed. This method does not take
into account the axis binning.
- - cumtrapz: computes the accumulated integral of an object along a given dimension, that is the primitive. The result has the
+
- cumtrapz: computes the accumulated integral of an object along a given dimension, that is the primitive. The result has the
same dimension as the initial object, and its last element/slice along
the specified dimension is the result of the sum method.
- - cumsum: computes the accumulated sum of an object along a given dimension. The result has the
+
- cumsum: computes the accumulated sum of an object along a given dimension. The result has the
same dimension as the initial object, and its last element/slice along
the specified dimension is the result of the sum method. This is the signal
primitive, equal to cumtrapz when dx=1.
- - cumprod: computes the accumulated product of an object along a given dimension. The result has
+
- cumprod: computes the accumulated product of an object along a given dimension. The result has
the same dimension as the initial object, and its last
element/slice along the specified dimension is the result of the prod
method.
- - del2: computes the Laplacian
+
- del2: computes the Laplacian
(local curvature, sum of the second partial derivatives).
- - gradient: computes the gradient
+
- gradient: computes the gradient
(derivatives) of an object.
- - diff: computes the gradient for the 1sty axis only (rows).
+ - diff: computes the gradient for the 1sty axis only (rows).
- - jacobian: computes the
+
- jacobian: computes the
Jacobian from the object current axes to new axes. This is to be used
for object coordinate changes. The
'from' and 'to' axes
@@ -813,13 +819,13 @@
- - combine: merges/combines
+
- combine: merges/combines
objects. The resulting object has the same dimensionality as the
initial ones, but may have a different sampling along axes. Its Signal
is the sum of Signals weighted by the Monitors, performed on the
intersection range of axes. Fast
notation is \
- - cat: concatenates/appends
+
- cat: concatenates/appends
objects.
If
the
@@ -832,7 +838,7 @@
dog: splits an object
+ - dog: splits an object
along a given dimension. The result is a vector of objects containing
the series of slices. This is the opposite operation to cat !
@@ -844,37 +850,37 @@
- - linspace: creates
+
- linspace: creates
continuous linear series of objects between two objects used as bounds.
This is a kind of morphing from one object to another one.
- - logspace: creates
+
- logspace: creates
continuous logarithmic series of objects between two objects used as
bounds.
This is a kind of morphing from one object to another one.
- - colon: creates a
+
- colon: creates a
continuous linear object array with a number of steps which is the
difference between mean values. Fast
notation is ':'
- - hist: converts an event type object into an histogrammed nD grid object.
+ - hist: converts an event type object into an histogrammed nD grid object.
- - interp: interpolates
+
- interp: interpolates
objects along a new set of axes. This method is in particular used to
prepare objects before performing most binary operations.
- - intersect: computes
+
- intersect: computes
intersection of axes between objects. This method is in particular used
in order to determine the operational range in binary operations.
-- meshgrid: transforms an iData object so that its axes are grids
+ - meshgrid: transforms an iData object so that its axes are grids
- - union: computes union of
+
- union: computes union of
axes between objects. This method is in particular used when catenating
objects.
- - sort: sorts objects axes
+
- sort: sorts objects axes
and reorder the corresponding signal.
-- smooth: smooth a data set using a robust spline smoothing or a Savitsky-Golay average.
-- resize: fast rebinning of an object
+ - smooth: smooth a data set using a robust spline smoothing or a Savitsky-Golay average.
+- resize: fast rebinning of an object
@@ -885,36 +891,36 @@
|