ao Class


Properties Properties of the class
Methods All Methods of the class ordered by category.
Examples Some constructor examples

Back to Class descriptions Back to Class descriptions

Properties

The LTPDA toolbox restrict access of the properties.

The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).

For example:

val = obj.prop(2).prop;
The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
For example:
obj2 = obj1.setName('my name') % This command creates a copy of obj1 (obj1 ~= obj2)
obj.setName('my name');        % This command applies to obj    

Properties Description Defined in class

data

Data object associated with this AO

ao

hist

History of the object (history object)

ltpda_uoh

procinfo

plist with additional information for an object.

ltpda_uoh

plotinfo

plist with the plot information

ltpda_uoh

name

name of the object

ltpda_uo

description

description of the object

ltpda_uo

mdlfile

model xml file of the LTPDAworkbench

ltpda_uo

UUID

Universally Unique Identifier of 128-bit

ltpda_uo

Back to Top Back to Top

Methods

Arithmetic Operator Arithmetic Operator
Constructor Constructor of this class
Converter Convertor methods
Helper Helper methods only for internal usage
Internal Internal methods only for internal usage
Operator Operator methods
Output Output methods
Relational Operator Relational operator methods
Signal Processing Signal processing methods
Trigonometry Trigometry methods

Back to Top Back to Top

Arithmetic Operator

Methods Description Defined in class

and

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

ao

minus

MINUS implements subtraction operator for analysis objects.

ao

mpower

MPOWER implements mpower operator for analysis objects.

ao

mrdivide

MRDIVIDE implements mrdivide operator for analysis objects.

ao

mtimes

MTIMES implements mtimes operator for analysis objects.

ao

or

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

ao

plus

PLUS implements addition operator for analysis objects.

ao

power

POWER implements power operator for analysis objects.

ao

rdivide

RDIVIDE implements division operator for analysis objects.

ao

times

TIMES implements multiplication operator for analysis objects.

ao

Back to Top of Section Back to Top of Section

Constructor

Methods Description Defined in class

ao

AO analysis object class constructor.

ao

rebuild

REBUILD rebuilds the input objects using the history.

ltpda_uoh

Back to Top of Section Back to Top of Section

Converter

Methods Description Defined in class

double

DOUBLE overloads double() function for analysis objects.

ao

Back to Top of Section Back to Top of Section

Helper

Methods Description Defined in class

convert

CONVERT perform various conversions on the ao.

ao

demux

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

ao

dx

DX Get the data property 'dx'.

ao

dy

DY Get the data property 'dy'.

ao

dz

DX Get the data property 'dz'.

ao

find

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

ao

fromProcinfo

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

ao

fs

FS Get the data property 'fs'.

ao

join

JOIN multiple AOs into a single AO.

ao

len

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

ao

nsecs

NSECS Get the data property 'nsecs'.

ao

scatterData

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

ao

search

SEARCH selects AOs that match the given name.

ao

setDx

SETDX sets the 'dx' property of the ao.

ao

setDy

SETDY sets the 'dy' property of the ao.

ao

setFs

SETFS sets the 'fs' property of the ao.

ao

setT0

SETT0 sets the 't0' property of the ao.

ao

setX

SETX sets the 'x' property of the ao.

ao

setXY

SETXY sets the 'xy' property of the ao.

ao

setXunits

SETXUNITS sets the 'xunits' property of the ao.

ao

setY

SETY sets the 'y' property of the ao.

ao

setYunits

SETYUNITS sets the 'yunits' property of the ao.

ao

setZ

SETZ sets the 'z' property of the ao.

ao

setZunits

SETZUNITS sets the 'zunits' property of the ao.

ao

simplifyYunits

SIMPLIFYYUNITS simplify the 'yunits' property of the ao.

ao

t0

T0 Get the data property 't0'.

ao

timeshift

TIMESHIFT for AO/tsdata objects, shifts the time axis such that x(1) = 0.

ao

validate

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

ao

x

X Get the data property 'x'.

ao

xunits

XUNITS Get the data property 'xunits'.

ao

y

Y Get the data property 'y'.

ao

yunits

YUNITS Get the data property 'yunits'.

ao

z

Z Get the data property 'z'.

ao

zunits

ZUNITS Get the data property 'zunits'.

ao

get

GET get a property of a object.

ltpda_obj

created

CREATED Returns a time object of the last modification.

ltpda_uoh

creator

CREATOR Extract the creator(s) from the history.

ltpda_uoh

csvexport

CSVEXPORT Exports the data of an object to a csv file.

ltpda_uoh

index

INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.

ltpda_uoh

requirements

REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.

ltpda_uoh

setDescription

SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.

ltpda_uoh

setMdlfile

SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.

ltpda_uoh

setName

SETNAME Sets the property 'name' of an ltpda_uoh object.

ltpda_uoh

setPlotinfo

SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.

ltpda_uoh

setProcinfo

SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.

ltpda_uoh

Back to Top of Section Back to Top of Section

Internal

Methods Description Defined in class

char

CHAR overloads char() function for analysis objects.

ao

generateConstructorPlist

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

ao

md5

MD5 computes an MD5 checksum from an analysis objects.

ao

plot

PLOT a simple plot of analysis objects.

ao

isprop

ISPROP tests if the given field is one of the object properties.

ltpda_obj

bsubmit

BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository

ltpda_uo

submit

SUBMIT Submits the given objects to an LTPDA repository

ltpda_uo

update

UPDATE Updates the given object in an LTPDA repository

ltpda_uo

string

STRING writes a command string that can be used to recreate the input object(s).

ltpda_uoh

type

TYPE converts the input objects to MATLAB functions.

ltpda_uoh

Back to Top of Section Back to Top of Section

Operator

Methods Description Defined in class

abs

ABS overloads the Absolute value method for analysis objects.

ao

acos

ACOS overloads the acos method for analysis objects.

ao

angle

ANGLE overloads the angle operator for analysis objects.

ao

asin

ASIN overloads the asin method for analysis objects.

ao

atan

ATAN overloads the atan method for analysis objects.

ao

bilinfit

BILINFIT is a linear fitting tool

ao

cat

CAT concatenate AOs into a row vector.

ao

complex

COMPLEX overloads the complex operator for Analysis objects.

ao

conj

CONJ overloads the conjugate operator for analysis objects.

ao

cos

COS overloads the cos method for analysis objects.

ao

ctranspose

CTRANSPOSE overloads the ' operator for Analysis Objects.

ao

det

DET overloads the determinant function for analysis objects.

ao

diag

DIAG overloads the diagonal operator for analysis objects.

ao

eig

EIG overloads the eigenvalues/eigenvectors function for analysis objects.

ao

exp

EXP overloads the exp operator for analysis objects. Exponential.

ao

hypot

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

ao

imag

IMAG overloads the imaginary operator for analysis objects.

ao

inv

INV overloads the inverse function for asnalysis objects.

ao

linfit

LINFIT is a linear fitting tool

ao

ln

LN overloads the log operator for analysis objects. Natural logarithm.

ao

log

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

ao

log10

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

ao

lscov

LSCOV is a wrapper for MATLAB's lscov function.

ao

max

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

ao

mean

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

ao

median

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

ao

min

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

ao

mode

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

ao

norm

NORM overloads the norm operator for Analysis Objects.

ao

offset

OFFSET adds an offset to the data in the AO.

ao

optSubtraction

SPSDSUBTRACTION makes a sPSD-weighted least-square iterative fit

ao

phase

PHASE is the phase operator for analysis objects.

ao

polynomfit

POLYNOMFIT is a polynomial fitting tool

ao

quasiSweptSine

QUASISWEPTSING computes a transfer function from swept-sine measurements

ao

real

REAL overloads the real operator for analysis objects.

ao

rotate

ROTATE applies rotation factor to AOs

ao

round

ROUND overloads the Round method for analysis objects.

ao

scale

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

ao

sign

SIGN overloads the sign operator for analysis objects.

ao

sin

SIN overloads the sin method for analysis objects.

ao

sort

SORT the values in the AO.

ao

spsdSubtraction

SPSDSUBTRACTION makes a sPSD-weighted least-square iterative fit

ao

sqrt

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

ao

std

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

ao

sum

SUM computes the sum of the data in the AO.

ao

sumjoin

SUMJOIN sums time-series signals togther

ao

svd

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

ao

svd_fit

SVD_FIT estimates parameters for a linear model using SVD

ao

tan

TAN overloads the tan method for analysis objects.

ao

transpose

TRANSPOSE overloads the .' operator for Analysis Objects.

ao

uminus

UMINUS overloads the uminus operator for analysis objects.

ao

unwrap

UNWRAP overloads the unwrap operator for analysis objects.

ao

var

VAR computes the variance of the data in the AO.

ao

Back to Top of Section Back to Top of Section

Output

Methods Description Defined in class

display

DISPLAY implement terminal display for analysis object.

ao

export

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

ao

gnuplot

GNUPLOT a gnuplot interface for AOs.

ao

iplot

IPLOT provides an intelligent plotting tool for LTPDA.

ao

iplotyy

IPLOT provides an intelligent plotting tool for LTPDA.

ao

table

TABLE display the data from the AO in a table.

ao

save

SAVE overloads save operator for ltpda objects.

ltpda_uo

report

REPORT generates an HTML report about the input objects.

ltpda_uoh

viewHistory

VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.

ltpda_uoh

Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defined in class

ge

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

ao

gt

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

ao

le

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

ao

lt

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

ao

eq

EQ overloads the == operator for ltpda objects.

ltpda_obj

ne

NE overloads the ~= operator for ltpda objects.

ltpda_obj

Back to Top of Section Back to Top of Section

Signal Processing

Methods Description Defined in class

average

AVERAGE averages aos point-by-point

ao

bicohere

BICOHERE computes the bicoherence of two input time-series

ao

bin_data

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

ao

buildWhitener1D

BUILDWHITENER1D builds a whitening filter based on the input frequency-series.

ao

cohere

COHERE estimates the coherence between time-series objects

ao

compute

COMPUTE performs the given operations on the input AOs.

ao

confint

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

ao

consolidate

CONSOLIDATE resamples all input AOs onto the same time grid.

ao

conv

CONV vector convolution.

ao

corr

CORR estimate linear correlation coefficients.

ao

cov

COV estimate covariance of data streams.

ao

cpsd

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

ao

crbound

CRBOUND computes the inverse of the Fisher Matrix

ao

delay

DELAY delays a time-series using various methods.

ao

delayEstimate

DELAYESTIMATE estimates the delay between two AOs

ao

detrend

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

ao

dft

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

ao

diff

DIFF differentiates the data in AO.

ao

dopplercorr

Dopplercorr coorects data for Doppler shift

ao

downsample

DOWNSAMPLE AOs containing time-series data.

ao

dropduplicates

DROPDUPLICATES drops all duplicate samples in time-series AOs.

ao

dsmean

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

ao

eqmotion

EQMOTION solves numerically a given linear equation of motion

ao

evaluateModel

EVALUATEMODEL evaluate a curvefit model.

ao

fft

FFT overloads the fft method for Analysis objects.

ao

fftfilt

FFTFILT overrides the fft filter function for analysis objects.

ao

filtSubtract

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

ao

filter

FILTER overrides the filter function for analysis objects.

ao

filtfilt

FILTFILT overrides the filtfilt function for analysis objects.

ao

firwhiten

FIRWHITEN whitens the input time-series by building an FIR whitening filter.

ao

fixfs

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

ao

fngen

FNGEN creates an arbitrarily long time-series based on the input PSD.

ao

gapfilling

GAPFILLING fills possible gaps in data.

ao

gapfillingoptim

GAPFILLINGOPTIM fills possible gaps in data.

ao

getdof

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

ao

heterodyne

HETERODYNE heterodynes time-series.

ao

hist

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

ao

ifft

IFFT overloads the ifft operator for Analysis objects.

ao

integrate

INTEGRATE integrates the data in AO.

ao

interp

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

ao

interpmissing

INTERPMISSING interpolate missing samples in a time-series.

ao

lcohere

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

ao

lcpsd

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

ao

linSubtract

LINSUBTRACT subtracts a linear contribution from an input ao.

ao

lincom

LINCOM make a linear combination of analysis objects

ao

linedetect

LINEDETECT find spectral lines in the ao/fsdata objects.

ao

linlsqsvd

LINLSQSVD Linear least squares with singular value decomposition

ao

lisovfit

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

ao

lpsd

LPSD implements the LPSD algorithm for analysis objects.

ao

ltfe

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

ao

mcmc

MCMC estimates paramters using a Monte Carlo Markov Chain.

ao

mcmc_td

MCMC_TD estimates paramters using a Monte Carlo Markov Chain.

ao

noisegen1D

NOISEGEN1D generates colored noise from white noise.

ao

noisegen2D

NOISEGEN2D generates cross correleted colored noise from white noise.

ao

normdist

NORMDIST computes the equivalent normal distribution for the data.

ao

polyfit

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

ao

psd

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

ao

psdconf

PSDCONF Calculates confidence levels and variance for psd

ao

removeVal

REMOVEVAL removes values from the input AO(s).

ao

resample

RESAMPLE overloads resample function for AOs.

ao

rms

RMS Calculate RMS deviation from spectrum

ao

sDomainFit

sDomainFit performs a fitting loop to identify model order and

ao

select

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

ao

sineParams

SINEPARAMS estimates parameters of sinusoids

ao

smoother

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

ao

spectrogram

SPECTROGRAM computes a spectrogram of the given ao/tsdata.

ao

spikecleaning

spikecleaning detects and corrects possible spikes in analysis objects

ao

split

SPLIT split an analysis object into the specified segments.

ao

spsd

SPSD implements the smoothed (binned) PSD algorithm for analysis objects.

ao

tdfit

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

ao

tfe

TFE estimates transfer function between time-series objects.

ao

timeaverage

TIMEAVERAGE Averages time series intervals

ao

upsample

UPSAMPLE overloads upsample function for AOs.

ao

whiten1D

WHITEN1D whitens the input time-series.

ao

whiten2D

WHITEN2D whiten the noise for two cross correlated time series.

ao

xcorr

XCORR makes cross-correlation estimates of the time-series

ao

xfit

XFIT fit a function of x to data.

ao

zDomainFit

zDomainFit performs a fitting loop to identify model order and

ao

zeropad

ZEROPAD zero pads the input data series.

ao

Back to Top of Section Back to Top of Section

Trigonometry

Methods Description Defined in class

atan2

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

ao

intersect

INTERSECT overloads the intersect operator for Analysis objects.

ao

Back to Top of Section Back to Top of Section




©LTP Team