Method pzmodel/setGain
SETGAIN sets the 'gain' property of the pzmodel object.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DESCRIPTION: SETGAIN sets the 'gain' property of the pzmodel object.
CALL: objs.setGain(val);
objs.setGain(val1, val2);
objs.setGain(plist('gain', val));
objs = objs.setGain(val);
INPUTS: objs: Can be a vector, matrix, list, or a mix of them.
val: numeric value in seconds
1. Single vector e.g. 1.12
Each pzmodel object in objs get this value.
2. Single vector in a cell-array e.g. {1.12}
Each pzmodel object in objs get this value.
3. cell-array with the same number of vectors as in objs
e.g. {1.2, 2, 4} and 3 pzmodel object in objs
Each pzmodel object in objs get its corresponding
value from the cell-array
Parameters Description
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details |
|
Access |
public |
Defining Class |
pzmodel |
Sealed |
0 |
Static |
0 |
Parameter Description
Sets for this method … |
Default |
Default |
no description |
Key |
Default Value |
Options |
Description |
setGain |
GAIN |
[] |
none |
New gain for the pole/zero model. |
Example |
plist('GAIN', [[]]) |
back to top
Some information of the method pzmodel/setGain are listed below: |
Class name |
pzmodel |
Method name |
setGain |
Category |
Helper |
Package name |
ltpda |
VCS Version |
967b0eec0dece803a81af8ef54ad2f8c784b20b2 |
Min input args |
1 |
Max input args |
-1 |
Min output args |
1 |
Max output args |
-1 |
Can be used as modifier |
1 |
Supported numeric types |
{'double'} |
|
Method: pzmodel/setDescription |
|
Method: pzmodel/setIunits |
 |
©LTP Team