Functions - By Category


Categories




Constructor

Function name Class Description

rebuild

ao

collection

collection

% COLLECTION constructor for collection class.

rebuild

collection

filterbank

filterbank

% FILTERBANK constructor for filterbank class.

rebuild

filterbank

matrix

matrix

% MATRIX constructor for matrix class.

rebuild

matrix

rebuild

mfir

miir

miir

% MIIR IIR filter object class constructor.

rebuild

miir

parfrac

parfrac

% PARFRAC partial fraction representation of a transfer function.

rebuild

parfrac

pest

pest

% PEST constructor for parameter estimates (pest) class.

rebuild

pest

plist

plist

% PLIST Plist class object constructor.

pzmodel

pzmodel

% PZMODEL constructor for pzmodel class.

rebuild

pzmodel

rational

rational

% RATIONAL rational representation of a transfer function.

rebuild

rational

rebuild

smodel

smodel

smodel

% SMODEL constructor for smodel class.

rebuild

ssm

ssm

ssm

% SSM statespace model class constructor.

rebuild

timespan

Back to top

Internal

Function name Class Description

bsubmit

ao

char

ao

% CHAR overloads char() function for analysis objects.

generateConstructorPlist

ao

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

ao

md5

ao

% MD5 computes an MD5 checksum from an analysis objects.

plot

ao

% PLOT a simple plot of analysis objects.

string

ao

submit

ao

type

ao

update

ao

bsubmit

collection

generateConstructorPlist

collection

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

collection

string

collection

submit

collection

type

collection

update

collection

bsubmit

filterbank

generateConstructorPlist

filterbank

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

filterbank

string

filterbank

submit

filterbank

type

filterbank

update

filterbank

bsubmit

matrix

generateConstructorPlist

matrix

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

matrix

string

matrix

submit

matrix

type

matrix

update

matrix

bsubmit

mfir

generateConstructorPlist

mfir

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

mfir

string

mfir

submit

mfir

type

mfir

update

mfir

bsubmit

miir

generateConstructorPlist

miir

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

miir

string

miir

submit

miir

type

miir

update

miir

bsubmit

parfrac

generateConstructorPlist

parfrac

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

getlowerFreq

parfrac

% GETLOWERFREQ gets the frequency of the lowest pole in the model.

getupperFreq

parfrac

% GETUPPERFREQ gets the frequency of the highest pole in the model.

isprop

parfrac

string

parfrac

submit

parfrac

type

parfrac

update

parfrac

bsubmit

pest

generateConstructorPlist

pest

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

pest

string

pest

submit

pest

type

pest

update

pest

bsubmit

plist

getDescriptionForParam

plist

% GETDESCRIPTIONFORPARAM Returns the description for the specified parameter key.

getSetRandState

plist

% GETSETRANDSTATE gets or sets the random state of the MATLAB functions 'rand' and 'randn'

isprop

plist

parse

plist

% PARSE a plist for strings which can be converted into numbers

plist2cmds

plist

% PLIST2CMDS convert a plist to a set of commands.

shouldIgnore

plist

% SHOULDIGNORE True for plists which have the key 'ignore' with the value true.

simplify

plist

% SIMPLIFY simplifies a plist.

submit

plist

update

plist

bsubmit

pzmodel

generateConstructorPlist

pzmodel

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

getlowerFreq

pzmodel

% GETLOWERFREQ gets the frequency of the lowest pole or zero in the model.

getupperFreq

pzmodel

% GETUPPERFREQ gets the frequency of the highest pole or zero in the model.

isprop

pzmodel

string

pzmodel

submit

pzmodel

type

pzmodel

update

pzmodel

bsubmit

rational

generateConstructorPlist

rational

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

getlowerFreq

rational

% GETLOWERFREQ gets the frequency of the lowest pole in the model.

getupperFreq

rational

% GETUPPERFREQ gets the frequency of the highest pole in the model.

isprop

rational

string

rational

submit

rational

type

rational

update

rational

bsubmit

smodel

generateConstructorPlist

smodel

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

smodel

string

smodel

submit

smodel

type

smodel

update

smodel

bsubmit

ssm

generateConstructorPlist

ssm

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

ssm

ssm2dot

ssm

% SSM2DOT converts a statespace model object a DOT file.

string

ssm

submit

ssm

type

ssm

update

ssm

bsubmit

timespan

double

timespan

% DOUBLE overloads double() function for timespan objects.

generateConstructorPlist

timespan

% GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

isprop

timespan

string

timespan

submit

timespan

type

timespan

update

timespan

Back to top

Statespace

Function name Class Description
Back to top

Signal Processing

Function name Class Description

average

ao

% AVERAGE averages aos point-by-point

bin_data

ao

% BIN_DATA rebins aos data, on logarithmic scale, linear scale, or arbitrarly chosen.

cdfplot

ao

% CDFPLOT makes cumulative distribution plot

cohere

ao

% COHERE estimates the coherence between time-series objects

compute

ao

% COMPUTE performs the given operations on the input AOs.

confint

ao

% CONFINT Calculates confidence levels and variance for psd, lpsd, cohere, lcohere and curvefit parameters

consolidate

ao

% CONSOLIDATE resamples all input AOs onto the same time grid.

conv

ao

% CONV vector convolution.

corr

ao

% CORR estimate linear correlation coefficients.

cov

ao

% COV estimate covariance of data streams.

cpsd

ao

% CPSD estimates the cross-spectral density between time-series objects

crbound

ao

% CRBOUND computes the inverse of the Fisher Matrix

delay

ao

% DELAY delays a time-series using various methods.

delayEstimate

ao

% DELAYESTIMATE estimates the delay between two AOs

detrend

ao

% DETREND detrends the input analysis object using a polynomial of degree N.

dft

ao

% DFT computes the DFT of the input time-series at the requested frequencies.

diff

ao

% DIFF differentiates the data in AO.

dopplercorr

ao

% Dopplercorr coorects data for Doppler shift

downsample

ao

% DOWNSAMPLE AOs containing time-series data.

dropduplicates

ao

% DROPDUPLICATES drops all duplicate samples in time-series AOs.

dsmean

ao

% DSMEAN performs a simple downsampling by taking the mean of every N samples.

ecdf

ao

% ECDF calculate empirical cumulative distribution function

eqmotion

ao

% EQMOTION solves numerically a given linear equation of motion

evaluateModel

ao

% EVALUATEMODEL evaluate a curvefit model.

fft

ao

% FFT overloads the fft method for Analysis objects.

fftfilt

ao

% FFTFILT overrides the fft filter function for analysis objects.

filtSubtract

ao

% FILTSUBTRACT subtracts a frequency dependent noise contribution from an input ao.

filter

ao

% FILTER overrides the filter function for analysis objects.

filtfilt

ao

% FILTFILT overrides the filtfilt function for analysis objects.

fixfs

ao

% FIXFS resamples the input time-series to have a fixed sample rate.

gapfilling

ao

% GAPFILLING fills possible gaps in data.

gapfillingoptim

ao

% GAPFILLINGOPTIM fills possible gaps in data.

getdof

ao

% GETDOF Calculates degrees of freedom for psd, lpsd, cohere and lcohere

heterodyne

ao

% HETERODYNE heterodynes time-series.

hist

ao

% HIST overloads the histogram function (hist) of MATLAB for Analysis Objects.

ifft

ao

% IFFT overloads the ifft operator for Analysis objects.

integrate

ao

% INTEGRATE integrates the data in AO.

interp

ao

% INTERP interpolate the values in the input AO(s) at new values.

interpmissing

ao

% INTERPMISSING interpolate missing samples in a time-series.

kstest

ao

% KSTEST perform KS test on input AOs

lcohere

ao

% LCOHERE implement magnitude-squadred coherence estimation on a log frequency axis.

lcpsd

ao

% LCPSD implement cross-power-spectral density estimation on a log frequency axis.

linSubtract

ao

% LINSUBTRACT subtracts a linear contribution from an input ao.

lincom

ao

% LINCOM make a linear combination of analysis objects

linedetect

ao

% LINEDETECT find spectral lines in the ao/fsdata objects.

linlsqsvd

ao

% LINLSQSVD Linear least squares with singular value decomposition

lisovfit

ao

% LISOVFIT uses LISO to fit a pole/zero model to the input frequency-series.

lpsd

ao

% LPSD implements the LPSD algorithm for analysis objects.

ltfe

ao

% LTFE implements transfer function estimation computed on a log frequency axis.

map3D

ao

% MAP3D maps the input 1 or 2D AOs on to a 3D AO

mcmc

ao

% MCMC estimates paramters using a Monte Carlo Markov Chain.

mcmc_td

ao

% MCMC_TD estimates paramters using a Monte Carlo Markov Chain.

noisegen1D

ao

% NOISEGEN1D generates colored noise from white noise.

noisegen2D

ao

% NOISEGEN2D generates cross correleted colored noise from white noise.

normdist

ao

% NORMDIST computes the equivalent normal distribution for the data.

polyfit

ao

% POLYFIT overloads polyfit() function of MATLAB for Analysis Objects.

psd

ao

% PSD makes power spectral density estimates of the time-series objects

psdconf

ao

% PSDCONF Calculates confidence levels and variance for psd

qqplot

ao

% QQFPLOT makes quantile-quantile plot

removeVal

ao

% REMOVEVAL removes values from the input AO(s).

resample

ao

% RESAMPLE overloads resample function for AOs.

rms

ao

% RMS Calculate RMS deviation from spectrum

sDomainFit

ao

% sDomainFit performs a fitting loop to identify model order and

select

ao

% SELECT select particular samples from the input AOs and return new AOs with only those samples.

sineParams

ao

% SINEPARAMS estimates parameters of sinusoids

smoother

ao

% SMOOTHER smooths a given series of data points using the specified method.

spcorr

ao

% SPCORR calculate Spearman Rank-Order Correlation Coefficient

spikecleaning

ao

% spikecleaning detects and corrects possible spikes in analysis objects

tdfit

ao

% TDFIT fit a set of smodels to a set of input and output signals..

tfe

ao

% TFE estimates transfer function between time-series objects.

timeaverage

ao

% TIMEAVERAGE Averages time series intervals

upsample

ao

% UPSAMPLE overloads upsample function for AOs.

whiten1D

ao

% WHITEN1D whitens the input time-series.

whiten2D

ao

% WHITEN2D whiten the noise for two cross correlated time series.

xcorr

ao

% XCORR makes cross-correlation estimates of the time-series

xfit

ao

% XFIT fit a function of x to data.

zDomainFit

ao

% zDomainFit performs a fitting loop to identify model order and

zeropad

ao

% ZEROPAD zero pads the input data series.

resp

filterbank

% RESP Make a frequency response of a filterbank.

crb

matrix

% CRB computes the inverse of the Fisher Matrix

dispersion

matrix

% DISPERSION computes the dispersion function

linfitsvd

matrix

% LINFITSVD Linear fit with singular value decomposition

linlsqsvd

matrix

% LINLSQSVD Linear least squares with singular value decomposition

mchNoisegen

matrix

% MCHNOISEGEN Generates multichannel noise data series given a model

mchNoisegenFilter

matrix

% MCHNOISEGENFILTER Construct a matrix filter from cross-spectral density matrix

mcmc

matrix

% MCMC estimates paramters using a Monte Carlo Markov Chain.

modelselect

matrix

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

tdfit

matrix

% TDFIT fit a MATRIX of transfer function SMODELs to a matrix of input and output signals.

impresp

mfir

resp

mfir

impresp

miir

resp

miir

resp

parfrac

eval

pest

% EVAL evaluate a pest object

resp

pzmodel

simplify

pzmodel

% SIMPLIFY simplifies pzmodels by cancelling like poles with like zeros.

resp

rational

bode

ssm

% BODE makes a bode plot from the given inputs to outputs.

bodecst

ssm

% BODECST makes a bodecst plot from the given inputs to outputs.

resp

ssm

% RESP gives the timewise impulse response of a statespace model.

respcst

ssm

% RESPCST gives the timewise impulse response of a statespace model.

Back to top

Arithmetic Operator

Function name Class Description

and

ao

% AND (&) overloads the and (&) method for analysis objects.

minus

ao

% MINUS implements subtraction operator for analysis objects.

mpower

ao

% MPOWER implements mpower operator for analysis objects.

mrdivide

ao

% MRDIVIDE implements mrdivide operator for analysis objects.

mtimes

ao

% MTIMES implements mtimes operator for analysis objects.

or

ao

% OR (|) overloads the or (|) method for Analysis objects.

plus

ao

% PLUS implements addition operator for analysis objects.

power

ao

% POWER implements power operator for analysis objects.

rdivide

ao

% RDIVIDE implements division operator for analysis objects.

times

ao

% TIMES implements multiplication operator for analysis objects.

addFilters

filterbank

% ADDFILTERS This method adds a filter to the filterbank

conj

matrix

% conj implements conj operator for matrix objects.

ctranspose

matrix

% CTRANSPOSE implements conjugate transpose operator for matrix objects.

fft

matrix

% FFT implements the fft operator for matrix objects.

filter

matrix

% FILTER implements N-dim filter operator for matrix objects.

fixfs

matrix

% FIXFS adjusts the sample frequency of each time-series AO in the matrix.

minus

matrix

% MINUS implements subtraction operator for ltpda model objects.

mtimes

matrix

% MTIMES implements mtimes operator for matrix objects.

plus

matrix

% PLUS implements addition operator for matrix objects.

rdivide

matrix

% RDIVIDE implements division operator for matrix objects.

resample

matrix

% RESAMPLE resamples each time-series AO in the matrix.

times

matrix

% TIMES implements multiplication operator for matrix objects.

transpose

matrix

% TRANSPOSE implements transpose operator for matrix objects.

rdivide

pzmodel

% RDIVIDE overloads the division operator for pzmodels.

times

pzmodel

% TIMES overloads the multiplication operator for pzmodels.

conj

smodel

% CONJ gives the complex conjugate of the input smodels

minus

smodel

% MINUS implements subtraction operator for smodel objects.

mrdivide

smodel

% MRDIVIDE implements mrdivide operator for smodel objects.

mtimes

smodel

% MTIMES implements mtimes operator for smodel objects.

plus

smodel

% PLUS implements addition operator for smodel objects.

rdivide

smodel

% RDIVIDE implements division operator for smodel objects.

times

smodel

% TIMES implements multiplication operator for smodel objects.

Back to top

Helper

Function name Class Description

convert

ao

% CONVERT perform various conversions on the ao.

created

ao

creator

ao

csvexport

ao

demux

ao

% DEMUX splits the input vector of AOs into a number of output AOs.

dx

ao

% DX Get the data property 'dx'.

dy

ao

% DY Get the data property 'dy'.

dz

ao

% DX Get the data property 'dz'.

find

ao

% FIND particular samples that satisfy the input query and return a new AO.

fromProcinfo

ao

% FROMPROCINFO returns for a given key-name the value of the procinfo-plist

fs

ao

% FS Get the data property 'fs'.

get

ao

index

ao

join

ao

% JOIN multiple AOs into a single AO.

len

ao

% LEN overloads the length operator for Analysis objects. Length of the data samples.

nsecs

ao

% NSECS Get the data property 'nsecs'.

requirements

ao

scatterData

ao

% SCATTERDATA Creates from the y-values of two input AOs an new AO(xydata)

search

ao

% SEARCH selects AOs that match the given name.

setDescription

ao

setDx

ao

% SETDX sets the 'dx' property of the ao.

setDy

ao

% SETDY sets the 'dy' property of the ao.

setFs

ao

% SETFS sets the 'fs' property of the ao.

setMdlfile

ao

setName

ao

setPlotinfo

ao

setProcinfo

ao

setReferenceTime

ao

% SETREFERENCETIME sets the t0 to the new value but doesn't move the data in time

setT0

ao

% SETT0 sets the 't0' property of the ao.

setToffset

ao

% SETTOFFSET sets the 'toffset' property of the ao with tsdata

setX

ao

% SETX sets the 'x' property of the ao.

setXY

ao

% SETXY sets the 'xy' property of the ao.

setXunits

ao

% SETXUNITS sets the 'xunits' property of the ao.

setY

ao

% SETY sets the 'y' property of the ao.

setYunits

ao

% SETYUNITS sets the 'yunits' property of the ao.

setZ

ao

% SETZ sets the 'z' property of the ao.

setZunits

ao

% SETZUNITS sets the 'zunits' property of the ao.

simplifyYunits

ao

% SIMPLIFYYUNITS simplify the 'yunits' property of the ao.

t0

ao

% T0 Get the data property 't0'.

timeshift

ao

% TIMESHIFT for AO/tsdata objects, shifts data in time by the specified value in seconds.

toffset

ao

% TOFFSET Returns the data property 'toffset' in seconds.

validate

ao

% VALIDATE checks that the input Analysis Object is reproducible and valid.

x

ao

% X Get the data property 'x'.

xunits

ao

% XUNITS Get the data property 'xunits'.

y

ao

% Y Get the data property 'y'.

yunits

ao

% YUNITS Get the data property 'yunits'.

z

ao

% Z Get the data property 'z'.

zunits

ao

% ZUNITS Get the data property 'zunits'.

addObjects

collection

% ADDOBJECTS adds the given objects to the collection.

created

collection

creator

collection

csvexport

collection

get

collection

getObjectAtIndex

collection

% GETOBJECTATINDEX index into the inner objects of one collection object.

getObjectsOfClass

collection

% GETOBJECTSOFCLASS returns all objects of the specified class in a collection-object.

index

collection

nobjs

collection

% NOBJS Returns the number of objects in the inner object array.

removeObjectAtIndex

collection

% REMOVEOBJECTATINDEX removes the object at the specified position from the collection.

requirements

collection

setDescription

collection

setMdlfile

collection

setName

collection

setObjectAtIndex

collection

% SETOBJECTATINDEX sets an input object to the collection.

setObjs

collection

% SETOBJS sets the 'objs' property of a collection object.

setPlotinfo

collection

setProcinfo

collection

created

filterbank

creator

filterbank

csvexport

filterbank

get

filterbank

index

filterbank

requirements

filterbank

setDescription

filterbank

setIunits

filterbank

% SETIUNITS sets the 'iunits' property of each filter-object inside the filterbank-object.

setMdlfile

filterbank

setName

filterbank

setOunits

filterbank

% SETOUNITS sets the 'ounits' property of each filter-object inside the filterbank-object.

setPlotinfo

filterbank

setProcinfo

filterbank

created

matrix

creator

matrix

csvexport

matrix

get

matrix

getObjectAtIndex

matrix

% GETOBJECTATINDEX index into the inner objects of one matrix object.

index

matrix

ncols

matrix

% NCOLS Returns the number of columns of the inner object array.

nrows

matrix

% NROWS Returns the number of rows of the inner object array.

osize

matrix

% OSIZE Returns the size of the inner object array.

requirements

matrix

setDescription

matrix

setMdlfile

matrix

setName

matrix

setObjs

matrix

% SETOBJS sets the 'objs' property of a matrix object.

setPlotinfo

matrix

setProcinfo

matrix

created

mfir

creator

mfir

csvexport

mfir

get

mfir

index

mfir

redesign

mfir

% REDESIGN redesign the input filter to work for the given sample rate.

requirements

mfir

setA

mfir

setDescription

mfir

setGd

mfir

% SETGD Set the property 'gd'

setHistout

mfir

setIunits

mfir

setMdlfile

mfir

setName

mfir

setOunits

mfir

setPlotinfo

mfir

setProcinfo

mfir

simplifyUnits

mfir

created

miir

creator

miir

csvexport

miir

get

miir

index

miir

redesign

miir

% REDESIGN redesign the input filter to work for the given sample rate.

requirements

miir

setA

miir

setB

miir

% SETB Set the property 'b'

setDescription

miir

setHistin

miir

% SETHISTIN Set the property 'histin'

setHistout

miir

setIunits

miir

setMdlfile

miir

setName

miir

setOunits

miir

setPlotinfo

miir

setProcinfo

miir

simplifyUnits

miir

created

parfrac

creator

parfrac

csvexport

parfrac

get

parfrac

index

parfrac

requirements

parfrac

setDescription

parfrac

setIunits

parfrac

setMdlfile

parfrac

setName

parfrac

setOunits

parfrac

setPlotinfo

parfrac

setProcinfo

parfrac

simplifyUnits

parfrac

combineExps

pest

% combineExps combine the results of different parameter estimation

computePdf

pest

% computes Probability Density Function from a pest object

created

pest

creator

pest

csvexport

pest

find

pest

% FIND Creates analysis objects from the selected parameter(s).

get

pest

index

pest

mcmcPlot

pest

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

requirements

pest

setChain

pest

% SETCHI2 Set the property 'chain'

setChi2

pest

% SETCHI2 Set the property 'chi2'

setCorr

pest

% SETCORR Set the property 'corr'

setCov

pest

% SETCOV Set the property 'cov'

setDescription

pest

setDof

pest

% SETDOF Set the property 'dof'

setDy

pest

% SETDY Set the property 'dy'

setDyForParameter

pest

% SETDYFORPARAMETER Sets the according dy-error for the specified parameter.

setMdlfile

pest

setModels

pest

% SETMODELS Set the property 'models'

setName

pest

setNames

pest

% SETNAMES Set the property 'names'

setPdf

pest

% SETPDF Set the property 'pdf'

setPlotinfo

pest

setProcinfo

pest

setY

pest

% SETY Set the property 'y'

setYforParameter

pest

% SETYFORPARAMETER Sets the according y-value for the specified parameter.

setYunits

pest

% SETYUNITS Set the property 'yunits'

setYunitsForParameter

pest

% SETYUNITSFORPARAMETER Sets the according y-unit for the specified parameter.

tdChi2

pest

% tdChi2 computes the chi-square for a parameter estimate.

append

plist

% APPEND append a param-object, plist-object or a key/value pair to the parameter list.

combine

plist

% COMBINE multiple parameter lists (plist objects) into a single plist.

find

plist

% FIND overloads find routine for a parameter list.

get

plist

getIndexForKey

plist

% GETINDEXFORKEY returns the index of a parameter with the given key.

getKeys

plist

% GETKEYS Return all the keys of the parameter list.

getOptionsForParam

plist

% GETOPTIONSFORPARAM Returns the options for the specified parameter key.

getParamValueForParam

plist

% GETPARAMVALUEFORPARAM Returns the paramValue for the specified parameter key.

getSelectionForParam

plist

% GETSELECTIONFORPARAM Returns the selection mode for the specified parameter key.

isparam

plist

% ISPARAM look for a given key in the parameter lists.

merge

plist

% MERGE the values for the same key of multiple parameter lists together.

mfind

plist

% MFIND multiple-arguments find routine for a parameter list.

nparams

plist

% NPARAMS returns the number of param objects in the list.

pop

plist

% POP remove a parameter from the parameter list and return its value.

pset

plist

% PSET set or add a key/value pairor a param-object into the parameter list.

remove

plist

% REMOVE remove a parameter from the parameter list.

removeKeys

plist

% REMOVEKEYS removes keys from a PLIST.

setDefaultForParam

plist

% SETDEFAULTFORPARAM Sets the default value of the param object in dependencies of the 'key'

setDescription

plist

setDescriptionForParam

plist

% SETDESCRIPTIONFORPARAM Sets the property 'desc' of the param object in dependencies of the 'key'

setMdlfile

plist

setName

plist

setOptionsForParam

plist

% SETOPTIONSFORPARAM Sets the options of the param object in dependencies of the 'key'

setSelectionForParam

plist

% SETSELECTIONFORPARAM Sets the selection mode of the param object in dependencies of the 'key'

string

plist

% STRING converts a plist object to a command string which will recreate the plist object.

subset

plist

% SUBSET returns a subset of a parameter list.

created

pzmodel

creator

pzmodel

csvexport

pzmodel

get

pzmodel

index

pzmodel

requirements

pzmodel

setDelay

pzmodel

% SETDELAY sets the 'delay' property of the pzmodel object.

setDescription

pzmodel

setGain

pzmodel

% SETGAIN sets the 'gain' property of the pzmodel object.

setIunits

pzmodel

setMdlfile

pzmodel

setName

pzmodel

setOunits

pzmodel

setPlotinfo

pzmodel

setPoles

pzmodel

% SETPOLES Set the property 'poles' of a pole/zero model.

setProcinfo

pzmodel

setZeros

pzmodel

% SETZEROS Set the property 'zeros' of a pole/zero model.

simplifyUnits

pzmodel

created

rational

creator

rational

csvexport

rational

get

rational

index

rational

requirements

rational

setDescription

rational

setIunits

rational

setMdlfile

rational

setName

rational

setOunits

rational

setPlotinfo

rational

setProcinfo

rational

simplifyUnits

rational

addAliases

smodel

% ADDALIASES Add the key-value pairs to the alias-names and alias-values

addParameters

smodel

% ADDPARAMETERS Add some parameters to the symbolic model (smodel) object

assignalias

smodel

% ASSIGNALIAS assign values to smodel alias

clearAliases

smodel

% CLEARALIASES Clear the aliases.

created

smodel

creator

smodel

csvexport

smodel

double

smodel

% DOUBLE Returns the numeric result of the model.

eval

smodel

% EVAL evaluates the symbolic model and returns an AO containing the numeric data.

fitfunc

smodel

% FITFUNC Returns a function handle which sets the 'values' and 'xvals' to a ltpda model.

get

smodel

hessian

smodel

% hessian compute the hessian matrix for a symbolic model.

index

smodel

op

smodel

% OP Add a operation around the model expression

requirements

smodel

setAliasNames

smodel

% SETALIASNAMES Set the property 'aliasNames'

setAliasValues

smodel

% SETALIASVALUES Set the property 'aliasValues'

setAliases

smodel

% SETALIASES Set the key-value pairs to the alias-names and alias-values

setDescription

smodel

setMdlfile

smodel

setName

smodel

setParameters

smodel

% SETPARAMETERS Set some parameters to the symbolic model (smodel) object

setParams

smodel

% SETPARAMS Set the property 'params' AND 'values'

setPlotinfo

smodel

setProcinfo

smodel

setTrans

smodel

% SETTRANS sets the 'trans' property of the smodel object.

setValues

smodel

% SETVALUES Set the property 'values'

setXunits

smodel

% SETXUNITS sets the 'xunits' property of the smodel object.

setXvals

smodel

% SETXVALS sets the 'xvals' property of the smodel object.

setXvar

smodel

% SETXVAR sets the 'xvar' property of the smodel object.

setYunits

smodel

% SETYUNITS sets the 'yunits' property of the smodel object.

simplifyUnits

smodel

% SIMPLIFYUNITS simplify the x and/or y units of the model.

subs

smodel

% SUBS substitutes symbolic parameters with the given values.

addParameters

ssm

% ADDPARAMETERS Adds the parameters to the model.

created

ssm

creator

ssm

csvexport

ssm

duplicateInput

ssm

% DUPLICATEINPUT copies the specified input blocks.

get

ssm

index

ssm

parameterDiff

ssm

% PARAMETERDIFF Makes a ssm that produces the output and state derivatives.

requirements

ssm

setBlockDescriptions

ssm

% SETBLOCKDESCRIPTIONS Sets descriptions of the specified SSM blocks.

setBlockNames

ssm

% SETBLOCKNAMES Sets names of the specified SSM blocks.

setBlockProperties

ssm

% SETBLOCKPROPERTIES Sets the specified properties of the specified SSM blocks.

setDescription

ssm

setMdlfile

ssm

setName

ssm

setParameters

ssm

% SETPARAMETERS Sets the values of the given parameters.

setParams

ssm

% SETPARAMS Sets the parameters of the model to the given plist.

setPlotinfo

ssm

setPortDescriptions

ssm

% SETPORTDESCRIPTIONS Sets descriptions of the specified SSM ports.

setPortNames

ssm

% SETPORTNAMES Sets names of the specified SSM ports.

setPortProperties

ssm

% SETPORTPROPERTIES Sets names of the specified SSM ports.

setPortUnits

ssm

% SETPORTUNITS Sets units of the specified SSM ports.

setProcinfo

ssm

created

timespan

creator

timespan

csvexport

timespan

get

timespan

index

timespan

requirements

timespan

setDescription

timespan

setEndT

timespan

% SETENDT sets the 'endT' property of the timespan objects.

setMdlfile

timespan

setName

timespan

setPlotinfo

timespan

setProcinfo

timespan

setStartT

timespan

% SETSTARTT sets the 'startT' property of the timespan objects.

Back to top

Operator

Function name Class Description

abs

ao

% ABS overloads the Absolute value method for analysis objects.

acos

ao

% ACOS overloads the acos method for analysis objects.

angle

ao

% ANGLE overloads the angle operator for analysis objects.

asin

ao

% ASIN overloads the asin method for analysis objects.

atan

ao

% ATAN overloads the atan method for analysis objects.

bilinfit

ao

% BILINFIT is a linear fitting tool

cat

ao

% CAT concatenate AOs into a row vector.

complex

ao

% COMPLEX overloads the complex operator for Analysis objects.

conj

ao

% CONJ overloads the conjugate operator for analysis objects.

cos

ao

% COS overloads the cos method for analysis objects.

det

ao

% DET overloads the determinant function for analysis objects.

diag

ao

% DIAG overloads the diagonal operator for analysis objects.

eig

ao

% EIG overloads the eigenvalues/eigenvectors function for analysis objects.

exp

ao

% EXP overloads the exp operator for analysis objects. Exponential.

hypot

ao

% HYPOT overloads robust computation of the square root of the sum of squares for AOs.

imag

ao

% IMAG overloads the imaginary operator for analysis objects.

inv

ao

% INV overloads the inverse function for analysis objects.

linfit

ao

% LINFIT is a linear fitting tool

log

ao

% LOG overloads the log operator for analysis objects. Natural logarithm.

log10

ao

% LOG10 overloads the log10 operator for analysis objects. Common (base 10) logarithm.

lscov

ao

% LSCOV is a wrapper for MATLAB's lscov function.

max

ao

% MAX computes the maximum value of the data in the AO.

mean

ao

% MEAN computes the mean value of the data in the AO.

median

ao

% MEDIAN computes the median value of the data in the AO.

min

ao

% MIN computes the minimum value of the data in the AO.

mode

ao

% MODE computes the modal value of the data in the AO.

norm

ao

% NORM overloads the norm operator for analysis objects.

offset

ao

% OFFSET adds an offset to the data in the AO.

phase

ao

% PHASE is the phase operator for analysis objects.

polynomfit

ao

% POLYNOMFIT is a polynomial fitting tool

real

ao

% REAL overloads the real operator for analysis objects.

rotate

ao

% ROTATE applies rotation factor to AOs

round

ao

% ROUND overloads the Round method for analysis objects.

scale

ao

% SCALE scales the data in the AO by the specified factor.

sign

ao

% SIGN overloads the sign operator for analysis objects.

sin

ao

% SIN overloads the sin method for analysis objects.

sort

ao

% SORT the values in the AO.

spsdSubtraction

ao

% SPSDSUBTRACTION makes a sPSD-weighted least-square iterative fit

sqrt

ao

% SQRT computes the square root of the data in the AO.

std

ao

% STD computes the standard deviation of the data in the AO.

sum

ao

% SUM computes the sum of the data in the AO.

sumjoin

ao

% SUMJOIN sums time-series signals togther

svd

ao

% SVD overloads the svd (singular value decomposition) function for analysis objects.

svd_fit

ao

% SVD_FIT estimates parameters for a linear model using SVD

tan

ao

% TAN overloads the tan method for analysis objects.

transpose

ao

% TRANSPOSE overloads the .' operator for Analysis Objects.

uminus

ao

% UMINUS overloads the uminus operator for analysis objects.

unwrap

ao

% UNWRAP overloads the unwrap operator for analysis objects.

var

ao

% VAR computes the variance of the data in the AO.

det

matrix

% DET evaluates the determinant for matrix object.

fftfilt

matrix

% FFTFILT fft filter for matrix objects

inv

matrix

% INV evaluates the inverse for matrix object.

linearize

matrix

% LINEARIZE output the derivatives of the model relative to the parameters.

rotate

matrix

% ROTATE applies rotation factor to matrix objects

simplify

matrix

% SIMPLIFY each model in the matrix.

spsdSubtraction

matrix

% SPSDSUBTRACTION makes a sPSD-weighted least-square iterative fit

tomfir

pzmodel

% TOMFIR approximates a pole/zero model with an FIR filter.

tomiir

pzmodel

% TOMIIR converts a pzmodel to an IIR filter using a bilinear transform.

convol_integral

smodel

% CONVOL_INTEGRAL implements the convolution integral for smodel objects.

det

smodel

% DET evaluates the determinant of smodel objects.

diff

smodel

% DIFF implements differentiation operator for smodel objects.

fourier

smodel

% FOURIER implements continuous f-domain Fourier transform for smodel objects.

ifourier

smodel

% IFOURIER implements continuous f-domain inverse Fourier transform for smodel objects.

ilaplace

smodel

% ILAPLACE implements continuous s-domain inverse Laplace transform for smodel objects.

inv

smodel

% INV evaluates the inverse of smodel objects.

iztrans

smodel

% IZTRANS implements continuous z-domain inverse Z-transform for smodel objects.

laplace

smodel

% LAPLACE implements continuous s-domain Laplace transform for smodel objects.

linearize

smodel

% LINEARIZE output the derivatives of the model relative to the parameters.

simplify

smodel

% SIMPLIFY implements simplify operator for smodel objects.

sum

smodel

% SUM adds all the elements of smodel objects arrays.

ztrans

smodel

% ZTRANS implements continuous z-domain Z-transform for smodel objects.

CPSD

ssm

% CPSD computes the output theoretical CPSD shape with given inputs.

PSD

ssm

% PSD computes the output theoretical CPSD shape with given inputs.

append

ssm

% appends embedded subsytems, with exogenous inputs

assemble

ssm

% assembles embedded subsytems, with exogenous inputs

cpsdForCorrelatedInputs

ssm

% cpsdForCorrelatedInputs computes the output theoretical CPSD shape with given inputs.

cpsdForIndependentInputs

ssm

% CPSDFORINDEPENDENTINPUTS computes the output theoretical CPSD shape with given inputs.

kalman

ssm

% KALMAN applies Kalman filtering to a discrete ssm with given i/o

keepParameters

ssm

% KEEPPARAMETERS enables to substitute symbollic patameters

modifyTimeStep

ssm

% MODIFYTIMESTEP modifies the timestep of a ssm object

optimiseForFitting

ssm

% OPTIMISEFORFITTING reduces the system matrices to doubles and strings.

removeEmptyBlocks

ssm

% REMOVEEMPTYBLOCKS enables to do model simplification

reorganize

ssm

% REOGANIZE rearranges a ssm object for fast input to BODE, SIMULATE, PSD.

sMinReal

ssm

% SMINREAL gives a minimal realization of a ssm object by deleting unreached states

simplify

ssm

% SIMPLIFY enables to do model simplification

simulate

ssm

% SIMULATE simulates a discrete ssm with given inputs

steadyState

ssm

% STEADYSTATE returns a possible value for the steady state of an ssm.

subsParameters

ssm

% SUBSPARAMETERS enables to substitute symbolic patameters

Back to top

Output

Function name Class Description

display

ao

% DISPLAY implement terminal display for analysis object.

export

ao

% EXPORT export the data of an analysis object to a text file.

gnuplot

ao

% GNUPLOT a gnuplot interface for AOs.

iplotyy

ao

% IPLOT provides an intelligent plotting tool for LTPDA.

report

ao

save

ao

table

ao

% TABLE display the data from the AO in a table.

viewHistory

ao

char

collection

% CHAR convert a collection object into a string.

display

collection

% DISPLAY overloads display functionality for collection objects.

report

collection

save

collection

viewHistory

collection

char

filterbank

% CHAR convert a filterbank object into a string.

display

filterbank

% DISPLAY overloads display functionality for filterbank objects.

report

filterbank

save

filterbank

viewHistory

filterbank

char

matrix

% CHAR convert a matrix object into a string.

display

matrix

% DISPLAY overloads display functionality for matrix objects.

iplot

matrix

% IPLOT calls ao/iplot on all inner ao objects.

report

matrix

save

matrix

viewHistory

matrix

char

mfir

% CHAR convert a mfir object into a string.

display

mfir

% DISPLAY overloads display functionality for mfir objects.

report

mfir

save

mfir

viewHistory

mfir

char

miir

% CHAR convert a miir object into a string.

display

miir

% DISPLAY overloads display functionality for miir objects.

report

miir

save

miir

viewHistory

miir

char

parfrac

% CHAR convert a parfrac object into a string.

display

parfrac

% DISPLAY overloads display functionality for parfrac objects.

report

parfrac

save

parfrac

viewHistory

parfrac

char

pest

% CHAR convert a pest object into a string.

display

pest

% DISPLAY overloads display functionality for pest objects.

report

pest

save

pest

viewHistory

pest

char

plist

% CHAR convert a parameter list into a string.

display

plist

% DISPLAY display plist object.

save

plist

char

pzmodel

% CHAR convert a pzmodel object into a string.

display

pzmodel

% DISPLAY overloads display functionality for pzmodel objects.

report

pzmodel

save

pzmodel

viewHistory

pzmodel

char

rational

% CHAR convert a rational object into a string.

display

rational

% DISPLAY overloads display functionality for rational objects.

report

rational

save

rational

viewHistory

rational

char

smodel

% CHAR convert a smodel object into a string.

display

smodel

% DISPLAY overloads display functionality for smodel objects.

report

smodel

save

smodel

viewHistory

smodel

char

ssm

% CHAR convert a ssm object into a string.

display

ssm

% DISPLAY display ssm object.

displayProperties

ssm

% DISPAYPROPERTIES displays the ssm model porperties.

dotview

ssm

% DOTVIEW view an ssm object via the DOT interpreter.

double

ssm

% Convert a statespace model object to double arrays for given i/o

findParameters

ssm

% findParameters returns parameter names matching the given pattern.

getParameters

ssm

% getParameters returns parameter values for the given names.

getParams

ssm

% GETPARAMS returns the parameter list for this SSM model.

isStable

ssm

% ISSTABLE tells if ssm is numerically stable

report

ssm

save

ssm

settlingTime

ssm

% SETTLINGTIME retunrns 1% the settling time of the system.

viewHistory

ssm

char

timespan

% CHAR convert a timespan object into a string.

display

timespan

% DISPLAY overloads display functionality for timespan objects.

report

timespan

save

timespan

viewHistory

timespan

Back to top

Relational Operator

Function name Class Description

eq

ao

ge

ao

% GE overloads >= operator for analysis objects. Compare the y-axis values.

gt

ao

% GT overloads > operator for analysis objects. Compare the y-axis values.

le

ao

% LE overloads <= operator for analysis objects. Compare the y-axis values.

lt

ao

% LT overloads < operator for analysis objects. Compare the y-axis values.

ne

ao

eq

collection

ne

collection

eq

filterbank

ne

filterbank

eq

matrix

ne

matrix

eq

mfir

ne

mfir

eq

miir

ne

miir

eq

parfrac

ne

parfrac

eq

pest

ne

pest

eq

plist

% EQ overloads the == operator for ltpda plist objects.

ne

plist

eq

pzmodel

ne

pzmodel

eq

rational

ne

rational

eq

smodel

ne

smodel

eq

ssm

ne

ssm

eq

timespan

ne

timespan

Back to top

Trigonometry

Function name Class Description

atan2

ao

% ATAN2 overloads the atan2 operator for analysis objects. Four quadrant inverse tangent.

intersect

ao

% INTERSECT overloads the intersect operator for Analysis objects.

Back to top

MDC01

Function name Class Description
Back to top

GUI function

Function name Class Description
Back to top

Converter

Function name Class Description

double

ao

% DOUBLE overloads double() function for analysis objects.

ssm2miir

ssm

% SSM2MIIR converts a statespace model object to a miir object

ssm2pzmodel

ssm

% SSM2PZMODEL converts a time-continuous statespace model object to a pzmodel

ssm2rational

ssm

% SSM2RATIONAL converts a statespace model object to a rational frac. object

ssm2ss

ssm

% SSM2SS converts a statespace model object to a MATLAB statespace object.

Back to top

User defined

Function name Class Description
Back to top




©LTP Team