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
 
  VERSION:     $Id: pzmodel.m,v 1.133 2012/02/29 07:52:26 hewitson Exp $
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class pzmodel
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
back to top back to top

From MAT File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
FILENAME '' none MAT filename.
back to top back to top

From XML File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
FILENAME '' none XML filename.
back to top back to top

From Repository

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
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 [] none Password to use when connecting to the database. Leave blank to be prompted.
ID [] none A vector of object IDs.
CID [] none A vector of collection IDs.
BINARY 1
  • 1
  • 0
Use binary representation (not always available).
back to top back to top

From Built-in Model

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
BUILT-IN '' none Choose one of the built-in models. (use class.getBuiltInModels to get a list for a particular user class)
back to top back to top

From LISO File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
FILENAME '' none LISO filename.
back to top back to top

From Rational

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
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.
back to top back to top

From Parfrac

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
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.
back to top back to top

From Poles/Zeros

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
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.
back to top back to top

Some information of the method pzmodel/pzmodel are listed below:
Class name pzmodel
Method name pzmodel
Category Constructor
CVS Version $Id: pzmodel.m,v 1.133 2012/02/29 07:52:26 hewitson Exp $
Min input args 0
Max input args -1
Min output args 1
Max output args 1




©LTP Team