pzmodel 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

gain

Gain of the model

pzmodel

poles

Vector of poles (pz-objects)

pzmodel

zeros

Vector of zeros (pz-objects)

pzmodel

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

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

Constructor

Methods Description Defined in class

pzmodel

PZMODEL constructor for pzmodel class.

pzmodel

Back to Top of Section Back to Top of Section

Helper

Methods Description Defined in class

isprop

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

ltpda_obj

setName

SETNAME Set the property 'name'.

ltpda_uoh

string

STRING writes a command string that can be used to recreate the input pzmodel object.

pzmodel

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

copy

COPY Make copy of pzmodel objects depending of the second input

pzmodel

getlowerFreq

GETLOWERFREQ gets the frequency of the lowest pole or zero in the model.

pzmodel

getupperFreq

GETUPPERFREQ gets the frequency of the highest pole or zero in the model.

pzmodel

pzm2ab

PZM2AB convert pzmodel to IIR filter coefficients using bilinear transform.

pzmodel

Back to Top of Section Back to Top of Section

Operator

Methods Description Defined in class

tomfir

TOMFIR approximates a pole/zero model with an FIR filter.

pzmodel

tomiir

TOMIIR converts a pzmodel to an IIR filter using a bilinear transform.

pzmodel

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

type

TYPE converts the input objects to MATLAB functions.

ltpda_uoh

char

CHAR convert a pzmodel object into a string.

pzmodel

display

DISPLAY overloads display functionality for pzmodel objects.

pzmodel

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

fngen

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

pzmodel

resp

RESP returns the complex response of a pzmodel as an Analysis Object.

pzmodel

Back to Top of Section Back to Top of Section




©LTP Team