Method pzmodel/pzmodel


  PZMODEL constructor for pzmodel class.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: PZMODEL constructor for pzmodel class.
 
 
  CONSTRUCTOR:
 
        pzm = pzmodel()                - creates an empty pzmodel object
        pzm = pzmodel(g, p, z)         - construct from gain, poles, zeros
        pzm = pzmodel(g, p, z, d)      - construct from gain, poles, zeros and a delay (in seconds)
        pzm = pzmodel(g, p, z, 'name') - construct including name
        pzm = pzmodel(g, p, z,         - construct from gain, poles, zeros, and
                      iunits, ounits)              io-units
        pzm = pzmodel('foo.fil')       - construct from LISO .fil file
        pzm = pzmodel('foo.xml')       - construct by loading the pzmodel from disk
        pzm = pzmodel('foo.mat')       - construct by loading the pzmodel from disk
        pzm = pzmodel(pl)              - create a pzmodel object from the
                                         description given in the parameter list.
        pzm = pzmodel(rat)             - creates a pzmodel from rational TF
 
 
  Poles and zeros can be given as single values, or a 2-element vector for
  [f, Q]. Multiple poles and zeros should be given in a cell-array:
 
  e.g. p = pzmodel(1, {1, 2, [3 4]}, {5, [6 10]}, 2)
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class pzmodel
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.

Example

plist('NAME', '', 'DESCRIPTION', '')

back to top back to top

From MAT File

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ltpda_uo.buildplist
FILENAME '' none MAT filename.

Example

plist('NAME', '', 'DESCRIPTION', '', 'FILENAME', '')

back to top back to top

From XML File

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ltpda_uo.buildplist
FILENAME '' none XML filename.

Example

plist('NAME', '', 'DESCRIPTION', '', 'FILENAME', '')

back to top back to top

From Repository

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ltpda_uo.buildplist
HOSTNAME '' none Database server hostname.
DATABASE '' none Database name.
USERNAME '' none User name to use when connecting to the database. Leave blank to be prompted.
PASSWORD {} [0x0] none Password to use when connecting to the database. Leave blank to be prompted.
CONN [] none Java mysql object.
ID, IDS [] none A vector of object IDs.
CID [] none A vector of collection IDs.
UUID, UUIDS {} [0x0] none A cell array of UUIDs.
BINARY 1
  • 1
  • 0
Use binary representation (not always available).

Example

plist('NAME', '', 'DESCRIPTION', '', 'HOSTNAME', '', 'DATABASE', '', 'USERNAME', '', 'PASSWORD', cell(0,0), 'CONN', [[]], 'ID', [[]], 'CID', [[]], 'UUID', cell(0,0), 'BINARY', [true])

back to top back to top

From Built-in Model

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
ltpda_uo.buildplist
BUILT-IN '' none Choose one of the built-in models. (use class.getBuiltInModels to get a list for a particular user class)
VERSION [] none Version of the built in model. The default version is used for the case that no 'Version' is defined.

Example

plist('NAME', '', 'DESCRIPTION', '', 'BUILT-IN', '', 'VERSION', [[]])

back to top back to top

From LISO File

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
pzmodel.buildplist
FILENAME '' none LISO filename.

Example

plist('NAME', '', 'DESCRIPTION', '', 'FILENAME', '')

back to top back to top

From Rational

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
pzmodel.buildplist
RATIONAL rational() none Rational transfer-function model object to design from.
IUNITS '' none The input units of the model.
OUNITS '' none The output units of the model.

Example

plist('NAME', '', 'DESCRIPTION', '', 'RATIONAL', rational([plist('NAME', '', 'DESCRIPTION', '')]), 'IUNITS', '', 'OUNITS', '')

back to top back to top

From Parfrac

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
pzmodel.buildplist
PARFRAC parfrac() none Partial fractions transfer-function model object to design from.
IUNITS '' none The input units of the model.
OUNITS '' none The output units of the model.

Example

plist('NAME', '', 'DESCRIPTION', '', 'PARFRAC', parfrac([plist('NAME', '', 'DESCRIPTION', '')]), 'IUNITS', '', 'OUNITS', '')

back to top back to top

From Poles/Zeros

no description
Key Default Value Options Description
ltpda_uoh.addGlobalKeys
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
pzmodel.buildplist
GAIN 1 none Model gain.
POLES [] none Vector/Cell-array of poles. Use either pz objects or the format
like {[f1, q1], f2, f3, [f4, q4]}
ZEROS [] none Vector/Cell-array of zeros. Use either pz objects or the format
like {[f1, q1], f2, f3, [f4, q4]}
IUNITS '' none The input units of the model.
OUNITS '' none The output units of the model.
DELAY 0 none The delay of the model in seconds.

Example

plist('NAME', '', 'DESCRIPTION', '', 'GAIN', [1], 'POLES', [[]], 'ZEROS', [[]], 'IUNITS', '', 'OUNITS', '', 'DELAY', [0])

back to top back to top

Some information of the method pzmodel/pzmodel are listed below:
Class name pzmodel
Method name pzmodel
Category Constructor
Package name ltpda
VCS Version 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 0
Max input args -1
Min output args 1
Max output args 1
Can be used as modifier 0
Supported numeric types {'double'}




©LTP Team