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

mfile

Full text representation of the m-file that created this AO

ao

mfilename

The filename of the m-file that created this AO

ao

mdlfile

Full text representation of the mdl-file that created this AO

ao

mdlfilename

The filename of the mdl-file that created this AO

ao

procinfo

Contains extra processing information not contained in the main result of any method (plist-object).

ao

plotinfo

Plist-object which contains the

ao

description

Description of the AO

ao

hist

History object associated with this object

ltpda_uoh

name

Name of the object

ltpda_uo

created

Time object which stores the creation time of the object

ltpda_uo

creator

Creator of the object

ltpda_uo

version

CVS version string of the constructor

ltpda_obj

Back to Top Back to Top

Methods

Arithmetic Operator
Constructor Constructor of this class
Helper Helper methods only for internal usage
Internal Internal methods only for internal usage
MDC1 Mock data challenge 1
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

minus

MINUS implements minus 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

plus

PLUS implements addition operator for analysis objects.

ao

power

POWER implements power operator for analysis objects.

ao

rdivide

RDIVIDE implements rdivide operator for analysis objects.

ao

times

TIMES implements times 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

Back to Top of Section Back to Top of Section

Helper

Methods Description Defined in class

attachm

ATTACHM attach an m file to the analysis object.

ao

attachmdl

ATTACHMDL attach an mdl file to the analysis object.

ao

cat

CAT concatenate AOs into a vector.

ao

copy

COPY makes a (deep) copy of the input AOs.

ao

demux

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

ao

find

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

ao

index

INDEX index into an AO array or matrix. This properly captures the history.

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

md5

MD5 computes an MD5 checksum from an analysis objects.

ao

search

SEARCH selects AOs that match the given name.

ao

setDescription

SETDESCRIPTION sets the 'description' 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

string

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

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

isprop

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

ltpda_obj

setName

SETNAME Set the property 'name'.

ltpda_uoh

Back to Top of Section Back to Top of Section

Internal

Methods Description Defined in class

addHistory

ADDHISTORY Add a history-object to the ltpda_uo object.

ltpda_uoh

Back to Top of Section Back to Top of Section

MDC1

Methods Description Defined in class

mdc1_ifo2acc_fd

MDC1_IFO2ACC_FS calculates the external acceleration in the frequency-domain.

ao

mdc1_ifo2acc_inloop

MDC1_IFO2ACC_INLOOP calculates the inloop acceleration in the time-domain.

ao

mdc1_ifo2control

MDC1_IFO2CONTROL converts the input time-series to control forces.

ao

mdc1_x2acc

MDC1_X2ACC converts the input time-series to acceleration with a time-domain filter

ao

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

complex

COMPLEX overloads the complex operator for Analysis objects.

ao

conj

CONJ overloads the conjugate operator 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 determinant function for Analysis objects.

ao

exp

EXP overloads the exp operator for Analysis objects. Exponential.

ao

imag

IMAG overloads the imaginary operator for Analysis objects.

ao

inv

INV overloads the inverse function for Analysis Objects.

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

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

phase

PHASE overloads the ltpda_phase operator for Analysis objects.

ao

real

REAL overloads the real operator for Analysis objects.

ao

sign

SIGN overloads the sign operator for Analysis objects.%

ao

sort

SORT the values in the AO.

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

svd

SVD overloads the determinant function for Analysis objects.

ao

transpose

TRANSPOSE overloads the .' operator for Analysis Objects.

ao

uminus

UMINUS overloads the uminus operator for Analysis objects.

ao

var

VAR computes the variance of the data in the AO.

ao

zeropad

ZEROPAD zero pads the input data series.

ao

Back to Top of Section Back to Top of Section

Output

Methods Description Defined in class

char

CHAR overloads char() function for analysis objects.

ao

display

DISPLAY implement terminal display for analysis object.

ao

export

EXPORT export an analysis object to a text file.

ao

extractm

EXTRACTM extracts an m-file from an analysis object and saves it to disk.

ao

extractmdl

EXTRACTMDL extracts an mdl file from an analysis object and saves it to disk.

ao

iplot

IPLOT provides an intelligent plotting tool for LTPDA.

ao

plot

PLOT a simple plot of analysis objects.

ao

save

SAVE overloads save operator for ltpda objects.

ltpda_uo

type

TYPE converts the input objects to MATLAB functions.

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

cohere

COHERE makes coherence estimates of the time-series objects

ao

compute

COMPUTE performs the given operations on the input AOs.

ao

consolidate

CONSOLIDATE resamples all input AOs onto the same time grid.

ao

conv

CONV vector convolution.

ao

cpsd

CPSD makes cross-spectral density estimates of the time-series objects.

ao

delay

DELAY delays a time-series using various methods.

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

No description

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

fft

FFT overloads the fft method for Analysis objects.

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

No description

ao

hist

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

ao

ifft

IFFT overloads the ifft operator for Analysis objects.

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 coherence estimation computed on a log frequency axis.

ao

lcpsd

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

ao

lincom

LINCOM

ao

linedetect

LINEDETECT find spectral lines in the ao/fsdata objects.

ao

lpsd

LPSD implement the LPSD algorithm for analysis objects.

ao

ltfe

LTFE implement transfer-function estimation computed on a log frequency axis.

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

pwelch

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

ao

resample

RESAMPLE overloads resample function for AOs.

ao

rms

RMS Calculate RMS deviation from spectrum

ao

select

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

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

tfe

TFE makes transfer function estimates of the time-series objects.

ao

timedomainfit

TIMEDOMAINFIT uses lscov to fit a set of time-series AOs to a target time-series AO.

ao

upsample

UPSAMPLE overloads upsample function for AOs.

ao

xcorr

XCORR makes cross-correlation estimates of the time-series

ao

Back to Top of Section Back to Top of Section

Trigonometry

Methods Description Defined in class

acos

ACOS overloads the acos method for Analysis objects.

ao

asin

ASIN overloads the asin method for Analysis objects.

ao

atan

ATAN overloads the atan method for Analysis objects.

ao

atan2

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

ao

cos

COS overloads the cos operator for Analysis objects. Cosine of argument in radians.

ao

sin

SIN overloads the sin method for Analysis objects.

ao

tan

TAN overloads the tan method for Analysis objects.

ao

Back to Top of Section Back to Top of Section




©LTP Team