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

delay

Delay of the pole/zero Model

pzmodel

version

CVS version string of the constructor

pzmodel

iunits

Input unit of a transfer function

ltpda_tf

ounits

Output unit of a transfer function

ltpda_tf

hist

History object associated with this object

ltpda_uoh

name

Name of the object

ltpda_uo

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

rebuild

REBUILD rebuilds the input objects using the history.

ltpda_uoh

pzmodel

PZMODEL constructor for pzmodel class.

pzmodel

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

isprop

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

ltpda_obj

setIunits

SETIUNITS sets the 'iunits' property of the ao.

ltpda_tf

setOunits

SETOUNITS sets the 'ounits' property of the ao.

ltpda_tf

created

CREATED Returns a time object of the last modification.

ltpda_uoh

creator

CREATOR Extract the creator(s) from the history.

ltpda_uoh

index

INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.

ltpda_uoh

setName

SETNAME Set the property 'name'.

ltpda_uoh

setProperties

SETPROPERTIES set different properties of an object.

ltpda_uoh

string

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

ltpda_uoh

setDelay

SETDELAY sets the 'delay' property of a pole/zero model.

pzmodel

Back to Top of Section Back to Top of Section

Internal

Methods Description Defined in class

bsubmit

BSUBMIT bsubmits the given collection of objects to an LTPDA Repository.

ltpda_uo

submit

SUBMIT submits the given collection of objects to an LTPDA Repository.

ltpda_uo

update

UPDATE updates the given object in an LTPDA Repository.

ltpda_uo

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

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

report

REPORT generates an HTML report about the input objects.

ltpda_uoh

save

SAVE overloads save operator for ltpda objects.

ltpda_uoh

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

mrdivide

MRDIVIDE overloads the division operator for pzmodels.

pzmodel

mtimes

MTIMES overloads the multiplication operator for pzmodels.

pzmodel

rdivide

RDIVIDE overloads the division operator for pzmodels.

pzmodel

resp

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

pzmodel

simplify

SIMPLIFY simplifies pzmodels by cancelling like poles with like zeros.

pzmodel

times

TIMES overloads the multiplication operator for pzmodels.

pzmodel

Back to Top of Section Back to Top of Section




©LTP Team