matrix 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

objs

objects in matrix

matrix

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
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

Back to Top Back to Top

Arithmetic Operator

Methods Description Defined in class

conj

conj implements conj operator for matrix objects.

matrix

ctranspose

CTRANSPOSE implements conjugate transpose operator for matrix objects.

matrix

fft

FFT implements the fft operator for matrix objects.

matrix

filter

FILTER implements N-dim filter operator for matrix objects.

matrix

fixfs

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

matrix

minus

MINUS implements subtraction operator for ltpda model objects.

matrix

mtimes

MTIMES implements mtimes operator for matrix objects.

matrix

plus

PLUS implements addition operator for matrix objects.

matrix

psd

PSD computes the PSD of the time-series in a matrix object.

matrix

rdivide

RDIVIDE implements division operator for matrix objects.

matrix

resample

RESAMPLE resamples each time-series AO in the matrix.

matrix

split

SPLIT splits a matrix object into the specified segments.

matrix

times

TIMES implements multiplication operator for matrix objects.

matrix

transpose

TRANSPOSE implements transpose operator for matrix objects.

matrix

Back to Top of Section Back to Top of Section

Constructor

Methods Description Defined in class

rebuild

REBUILD rebuilds the input objects using the history.

ltpda_uoh

matrix

MATRIX constructor for matrix class.

matrix

Back to Top of Section Back to Top of Section

Helper

Methods Description Defined in class

get

GET get a property of a object.

ltpda_obj

setDescription

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

ltpda_uo

setMdlfile

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

ltpda_uo

setName

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

ltpda_uo

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

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

getObjectAtIndex

GETOBJECTATINDEX index into the inner objects of one matrix object.

matrix

ncols

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

matrix

nrows

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

matrix

osize

OSIZE Returns the size of the inner object array.

matrix

setObjs

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

matrix

Back to Top of Section Back to Top of Section

Internal

Methods Description Defined in class

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

generateConstructorPlist

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

matrix

Back to Top of Section Back to Top of Section

Operator

Methods Description Defined in class

det

DET evaluates the determinant for matrix object.

matrix

fftfilt

FFTFILT fft filter for matrix objects

matrix

inv

INV evaluates the inverse for matrix object.

matrix

linearize

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

matrix

rotate

ROTATE applies rotation factor to matrix objects

matrix

simplify

SIMPLIFY each model in the matrix.

matrix

spsdSubtraction

SPSDSUBTRACTION makes a sPSD-weighted least-square iterative fit

matrix

Back to Top of Section Back to Top of Section

Output

Methods Description Defined in class

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

char

CHAR convert a matrix object into a string.

matrix

display

DISPLAY overloads display functionality for matrix objects.

matrix

iplot

IPLOT calls ao/iplot on all inner ao objects.

matrix

Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defined in class

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

crb

CRB computes the inverse of the Fisher Matrix

matrix

dispersion

DISPERSION computes the dispersion function

matrix

linfitsvd

LINFITSVD Linear fit with singular value decomposition

matrix

linlsqsvd

LINLSQSVD Linear least squares with singular value decomposition

matrix

mchNoisegen

MCHNOISEGEN Generates multichannel noise data series given a model

matrix

mchNoisegenFilter

MCHNOISEGENFILTER Construct a matrix filter from cross-spectral density matrix

matrix

mcmc

MCMC estimates paramters using a Monte Carlo Markov Chain.

matrix

modelselect

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

matrix

tdfit

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

matrix

Back to Top of Section Back to Top of Section




©LTP Team