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

Public Properties Public means that all clients can access the member by its name.
Private Properties Private restricts the access to the class itself. Only methods that are part of the same class can access private members.

Back to Top Back to Top

Public Properties

Properties Description

name

Name of the analysis object (AO)

description

A human-readable/-created description of this AO

Private Properties

Properties Description

data

Data object associated with this AO

hist

History object associated with this AO

provenance

Provenance object associated with this AO

mfile

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

mfilename

The filename of the m-file that created this AO

mdlfile

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

mdlfilename

The filename of the mdl-file that created this AO

plist

The parameter list object which creates the first version of this AO

version

CVS version string of the constructor

created

Time object which stores the creation time of the AO

Methods

Constructor Constructor of this class
Helper Helper functions only for internal usage
Internal Internal functions only for internal usage
Operator Operator functions
Output Output functions
Trigonometry Trigometry functions

Back to Top Back to Top

Constructor

Methods Description

ao

AO analysis object class constructor.

Back to Top of Section Back to Top of Section

Helper

Methods Description

attachm

ATTACHM attach an m file to the analysis object.

attachmdl

ATTACHMDL attach an mdl file to the analysis object.

cat

CAT concatenate AOs into a vector.

demux

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

find

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

get

GET get ao properties.

index

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

isfield

No description

isvalid

ISVALID tests if the given ao has all the correct fields of the correct type.

len

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

md5

MD5 computes an MD5 checksum from an analysis objects.

mux

MUX concatenate AOs into a vector.

set

SET set an analysis object property.

setnh

SET set an analysis object property without recording the history.

string

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

timeshift

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

validate

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

Back to Top of Section Back to Top of Section

Internal

Methods Description

subsasgn

SUBSASGN define index assignment for analysis object properties.

subsref

SUBSREF Define field name indexing for analysis objects.

Back to Top of Section Back to Top of Section

Operator

Methods Description

abs

ABS overloads the Absolute value operator for Analysis objects.

complex

COMPLEX overloads the complex operator for Analysis objects.

conj

CONJ overloads the conjugate operator for Analysis objects.

ctranspose

CTRANSPOSE overloads the ' operator for Analysis Objects.

det

DET overloads the determinant function for Analysis objects.

diag

DIAG overloads the diagonal operator for Analysis Objects.

eig

EIG overloads the determinant function for Analysis objects.

exp

EXP overloads the exp operator for Analysis objects. Exponential.

imag

IMAG overloads the imaginary operator for Analysis objects.

inv

INV overloads the inverse function for Analysis Objects.

ln

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

log

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

log10

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

mean

MEAN overloads the mean operator for Analysis objects. Compute the mean value.

median

MEDIAN overloads the median operator for Analysis objects. Compute the median value.

norm

NORM overloads the norm operator for Analysis Objects.

phase

PHASE overloads the ltpda_phase operator for Analysis objects.

real

REAL overloads the real operator for Analysis objects.

sqrt

SQRT overloads the sqrt operator for Analysis objects. Square root.

std

STD overloads the std operator for Analysis objects. Compute the standard deviation.

sum

SUM overloads the sum operator for Analysis objects. Compute the sum value.

svd

SVD overloads the determinant function for Analysis objects.

transpose

TRANSPOSE overloads the .' operator for Analysis Objects.

var

VAR overloads the var operator for Analysis objects. Compute the variance.

Back to Top of Section Back to Top of Section

Output

Methods Description

ao2m

AO2M converts an analysis object to an '.m' file based on the history contained in the analysis object.

char

CHAR overloads char() function for analysis objects.

display

DISPLAY implement terminal display for analysis object.

export

EXPORT export an analysis object to a text file.

extractm

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

extractmdl

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

iplot

IPLOT provides an intelligent plotting tool for LTPDA.

plot

PLOT a simple plot of analysis objects.

save

SAVE overloads save operator for analysis objects.

stairs

STAIRS overloads the stairs function for Analysis Objects.

Back to Top of Section Back to Top of Section

Trigonometry

Methods Description

acos

ACOS overloads the acos operator for Analysis objects. Inverse cosine result in radians.

asin

ASIN overloads the asin operator for Analysis objects. Inverse sine result in radians.

atan

ATAN overloads the atan operator for Analysis objects. Inverse tangent result in radians.

cos

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

sin

SIN overloads the sin operator for Analysis objects. Sine of argument in radians.

tan

TAN overloads the tan operator for Analysis objects. Tangent of argument in radians.

Back to Top of Section Back to Top of Section