Method ao/hist


  HIST overloads the histogram function (hist) of MATLAB for Analysis Objects.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: HIST overloads the histogram function (hist) of MATLAB for
               Analysis Objects.
 
  CALL:        b = hist(a)
               b = hist(a, pl)
 
  INPUTS:      a  - input analysis object(s)
               pl - a parameter list
 
  OUTPUTS:     b  - xydata type analysis object(s) containing the
                    histogrammed data
 
  Parameters Description
 
  WARNING: the '.' method of calling hist() doesn't work since AOs have a
  property called 'hist'. Use the standard function call instead:
 
     >> a.hist  % returns the history object and doesn't call ao/hist
     >> hist(a) % calls ao/hist
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Number Of Bins

no description
Key Default Value Options Description
hist
N 10 none The number of bins to compute the histogram on.
NORM 0
  • 0
  • 1
Normalized output. If set to true, it will give the output comparable
to the normal distrubution PDF.

Example

plist('N', [10], 'NORM', [false])

back to top back to top

Bin Centres

no description
Key Default Value Options Description
hist
X [] none A vector of bin centers.

Example

plist('X', [[]])

back to top back to top

Some information of the method ao/hist are listed below:
Class name ao
Method name hist
Category Signal Processing
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