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 Defining 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 plotinfo object ltpda_uoh
name name of the object ltpda_uo
description description of the object 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

Back to Top Back to Top

Arithmetic Operator

Methods Description Defining Class
cross Implements cross operator for matrix objects. matrix
ctranspose Implements conjugate transpose operator for matrix objects. matrix
filter Implements N-dim filter operator for matrix objects. matrix
filtfilt Overrides the filtfilt function for matrices of analysis objects. matrix
minus Implements subtraction operator for ltpda model objects. matrix
mtimes Implements mtimes operator for matrix objects. matrix
plus Implements addition operator for matrix objects. matrix
power TIMES implements multiplication operator for matrix objects. matrix
rdivide Implements division operator for matrix objects. matrix
times Implements multiplication operator for matrix objects. matrix
transpose Implements transpose operator for matrix objects. matrix
Back to Top of Section Back to Top of Section

Constructor

Methods Description Defining Class
rebuild Rebuilds the input objects using the history. ltpda_uoh
matrix Constructor for matrix class. matrix
Back to Top of Section Back to Top of Section

Converter

Methods Description Defining Class
double Converts a matrix of objects into matrix of numbers matrix
Back to Top of Section Back to Top of Section

Helper

Methods Description Defining Class
search Selects objects inside the collection/matrix object that match the given name. ltpda_container
get Get a property of a object. ltpda_obj
setDescription Sets the 'description' property of a ltpda_uo object. ltpda_uo
setName Sets the property 'name' of an ltpda_uoh object. ltpda_uo
created Returns a time object of the last modification. ltpda_uoh
creator Extract the creator(s) from the history. ltpda_uoh
csvexport Exports the data of an object to a csv file. ltpda_uoh
index Index into a 'ltpda_uoh' object array or matrix. This properly captures the history. ltpda_uoh
requirements Returns a list of LTPDA extension requirements for a given object. ltpda_uoh
setPlotAxes Sets the 'axes' property of a the object's plotinfo. ltpda_uoh
setPlotColor Sets the color of a the object's plotinfo. ltpda_uoh
setPlotFigure Sets the 'figure' property of a the object's plotinfo. ltpda_uoh
setPlotFillmarker Defines if the plot function fill the marker or not. ltpda_uoh
setPlotLineStyle Sets the linestyle of a the object's plotinfo. ltpda_uoh
setPlotLinewidth Sets the linewidth of a the object's plotinfo. ltpda_uoh
setPlotMarker Sets the marker of a the object's plotinfo. ltpda_uoh
setPlotMarkerEdgeColor Sets the color of a the object's marker edge. ltpda_uoh
setPlotMarkerFaceColor Sets the color of a the object's marker face. ltpda_uoh
setPlotMarkersize Sets the markersize of a the object's plotinfo. ltpda_uoh
setPlotinfo Sets the 'plotinfo' property of a ltpda_uoh object. ltpda_uoh
setPlottingStyle Sets the style property of a the object's plotinfo. ltpda_uoh
setProcinfo Sets the 'procinfo' property of a ltpda_uoh object. ltpda_uoh
setShowsErrors Sets the 'showErrors' property of a the object's plotinfo. ltpda_uoh
getObjectAtIndex Index into the inner objects of one matrix object. matrix
osize Returns the size of the inner object array. matrix
setObjs Sets the 'objs' property of a matrix object. matrix
Back to Top of Section Back to Top of Section

Internal

Methods Description Defining Class
isprop Tests if the given field is one of the object properties. ltpda_obj
bsubmit Submits the given collection of objects in binary form to an LTPDA repository ltpda_uo
submit Submits the given collection of objects to an LTPDA repository ltpda_uo
update Updates the given object in an LTPDA repository ltpda_uo
string Writes a command string that can be used to recreate the input object(s). ltpda_uoh
type Converts the input objects to MATLAB functions. ltpda_uoh
generateConstructorPlist Generates a PLIST from the properties which can rebuild the object. matrix
plot The matrix objects on the given axes. matrix
Back to Top of Section Back to Top of Section

Operator

Methods Description Defining Class
conj Implements conj operator for ltpda_container objects. ltpda_container
det Evaluates the determinant for matrix object. matrix
fftfilt Fft filter for matrix objects matrix
inv Evaluates the inverse for matrix object. matrix
linearize Output the derivatives of the model relative to the parameters. matrix
lscov Is a wrapper for MATLAB's lscov function. matrix
mean Evaluates the meanerse for matrix object. matrix
rotate Applies rotation factor to matrix objects matrix
simplify Each model in the matrix. matrix
spsdSubtraction Makes a sPSD-weighted least-square iterative fit matrix
Back to Top of Section Back to Top of Section

Output

Methods Description Defining Class
save Overloads save operator for ltpda objects. ltpda_uo
report Generates an HTML report about the input objects. ltpda_uoh
viewHistory Displays the history of an object as a dot-view or a MATLAB figure. ltpda_uoh
char Convert a matrix object into a string. matrix
display Overloads display functionality for matrix objects. matrix
iplot Calls ao/iplot on all inner ao objects. matrix
toArray Unpacks the objects in a matrix and places them into a MATLAB matrix
unpack Unpacks the objects in a matrix and sets them to the given output matrix
Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defining Class
isequal Overloads the isequal operator for ltpda objects. ltpda_obj
Back to Top of Section Back to Top of Section

Signal Processing

Methods Description Defining Class
abs Overloads the Absolute value method for analysis objects in a ltpda_container object. ltpda_container
consolidate Resamples all input AOs in a ltpda_container object onto the same time grid. ltpda_container
detrend Detrends the analysis objects in a ltpda_container object using a polynomial of degree N. ltpda_container
diff Differentiates the data in a ltpda_container object. ltpda_container
downsample Downsamples each time-series AO in the ltpda_container. ltpda_container
dsmean Resamples each time-series AO in the ltpda_container. ltpda_container
fft Implements the fft operator for ltpda_container objects. ltpda_container
fixfs Adjusts the sample frequency of each time-series AO in the ltpda_container. ltpda_container
heterodyne Heterodynes time-series in a ltpda_container object. ltpda_container
interp Interpolate the values of each AO in the ltpda_container at new values. ltpda_container
interpmissing Interpolate missing samples of each time-series AO in the ltpda_container. ltpda_container
lpsd Computes the log-scale PSD of the time-series AOs in a ltpda_container object. ltpda_container
polyfit Overloads polyfit() function of MATLAB for ltpda_container objects. ltpda_container
psd Computes the PSD of the time-series in a ltpda_container object. ltpda_container
removeVal Removes values from each AO in the ltpda_container. ltpda_container
resample Resamples each time-series AO in the ltpda_container. ltpda_container
simplifyYunits Overloads the simplifyYunits value method for analysis objects in a ltpda_container object. ltpda_container
split Splits a ltpda_container object into the specified segments. ltpda_container
sqrt Computes the sqrt of each object in the ltpda_container. ltpda_container
subsData Computes the SUBSDATA of the time-series in a ltpda_container object. ltpda_container
timeaverage Averages time series intervals in a ltpda_container object. ltpda_container
uminus Overloads the uminus operator for all AOs in the ltpda_container. ltpda_container
cohere Estimates the coherence between elements of the vector. matrix
cpsd Estimates the cross-spectral density between elements of the vector. matrix
crb Computes the inverse of the Fisher Matrix matrix
delay Overloads ao/delay for matrix objects. matrix
dispersion Computes the dispersion function matrix
dispersionLoop DISPERSION computes the dispersion function matrix
lcohere Estimates the coherence between elements of the vector using matrix
lcpsd Estimates the coherence between elements of the vector using a matrix
lincom Make a linear combination of analysis objects matrix
linfitsvd Linear fit with singular value decomposition matrix
linlsqsvd Linear least squares with singular value decomposition matrix
loglikelihood Compute log-likelihood for MATRIX objects matrix
ltfe Estimates the transfer function between elements of the vector using matrix
mchNoisegen Generates multichannel noise data series given a model matrix
mchNoisegenFilter Construct a matrix filter from cross-spectral density matrix matrix
modelSelect %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% matrix
tdfit Fit a MATRIX of transfer function SMODELs to a matrix of input and output signals. matrix
tfe Estimates the transfer functions between elements of the vector. matrix
Back to Top of Section Back to Top of Section



©LTP Team