General Histogram VI

Owning Palette: Process Statistics VIs

Requires: DSC Module

Finds the discrete histogram of the input sequence X based on the given bin specifications.

This VI is functionally and connector pane compatible with the Advanced Analysis Library General Histogram VI. If you have the Advanced Analysis Library, you might consider using that version of the VI because it executes approximately six times faster.

	X is the input data.
	bins specifies the boundaries of each bin of the histogram. The input bins is an array of clusters where each cluster defines the range of values for a bin. The cluster includes the following elements. If no bin specifications are provided in the input bins, the inputs max, min, # bins, and inclusion will be used to specify a set of uniformly spaced bins. lower specifies the lower boundaries of the bin. upper specifies the upper boundaries of the bin. inclusion specifies how the boundaries of each bin are treated. The acceptable values for inclusion are listed as follows. 0 lower—(Default) Use the lower boundary to be part of the bin. 1 upper— Use the upper boundary to be part of the bin. 2 both— Use both the lower and upper boundaries to be part of the bin.
	max specifies the maximum value to include in the histogram. This parameter is optional as explained below.
	min specifies the minimum value to include in the histogram. This parameter is optional as explained below. If you do not wire the inputs max and min, the VI will use the maximum and minimum values in the input sequence Xd.
	# bins specifies the number of bins in the histogram. This parameter is optional. If # bins is left unwired, the number of bins will be determined according to Sturges’ Rule (number of bins = 1 + 3.3log(sizeof(X))).
	inclusion specifies how the boundaries of each bin are handled. The valid values for inclusion are: 0 include the lower boundary 1 include the upper boundary 2 include both boundaries
	histogram returns the histogram.
	axis returns the center values for each bin of histogram. The centers of each bin are set according to the following equation and returned in the output array axis.
	# outside is the output cluster. # outside contains three elements: total contains the total number of points in X not falling in any bin upon successful execution. The elements above and below have meaning only if Bins are specified such that Bin[0].upper =< Bin[1].lower < Bin[1].upper, and so on. above represents the number of values in X above Bin[sizeof(Bins)-1].upper. below represents the number of values in X below Bin[0].lower.
	error returns no errors. This output maintains compatibility with the Advanced Analysis Library General Histogram VI.