Method miir/setHistout


  SETHISTOUT sets the 'histout' property of the filter object.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: SETHISTOUT sets the 'histout' property of the filter object.
 
  CALL:        objs.setHistout(val);
               objs.setHistout(val1, val2);
               objs.setHistout(plist('histout', val));
               objs = objs.setHistout(val);
 
  INPUTS:      objs: Can be a vector, matrix, list, or a mix of them.
               val:  numeric vector or an AO which y-values are taken for the Histout
                  1. Single vector e.g.
                       Each filter object in objs get this value.
                  2. Single vector in a cell-array e.g. {[1 2 3]}
                       Each filter object in objs get this value.
                  3. cell-array with the same number of vectors as in objs
                     e.g. {ao, [1 2 3], ao} and 3 filter object in objs
                       Each filter object in objs get its corresponding
                       value from the cell-array
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ltpda_filter
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
setHistout
HISTOUT [] none Output history of the filter.

Example

plist('HISTOUT', [[]])

back to top back to top

Some information of the method ltpda_filter/setHistout are listed below:
Class name ltpda_filter
Method name setHistout
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'}




©LTP Team