Finds the discrete histogram of a signal based on the given bin specifications.
Boundaries of each bin of the histogram. This input is an array of clusters where each cluster defines the range of values for a bin.
If no bin specifications are provided in bins, this node uses maximum, minimum, number of bins, and inclusion to specify a set of uniformly spaced bins.
Lower boundaries of the bin.
Default: 0
Upper boundaries of the bin.
Default: 0
Method to treat the boundaries of each bin.
Name | Description |
---|---|
lower | Includes the lower boundary. |
upper | Includes the upper boundary. |
both | Includes both boundaries. |
neither | Includes neither boundaries. |
Default: lower
Maximum value to include in the histogram.
Default: 0
Minimum value to include in the histogram.
Default: 0
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
Default: No error
Number of bins in the histogram.
Default: 10
The boundary of each bin to handle.
If bin specifications are provided in bins, this node uses the inclusion in bins instead.
Name | Description |
---|---|
lower | Includes the lower boundary. |
upper | Includes the upper boundary. |
Determining the Bin Widths When inclusion Is lower
If inclusion is set to lower, the bin widths are determined according to the following equations.
where
Determining the Bin Widths When inclusion Is upper
If inclusion is set to upper, the bin widths are determined according to the following equations.
where
Default: lower
The histogram of the input signal.
An array of the center values of the bins of the histogram.
Discrete histogram of the input signal.
Discrete histogram of the input signal.
An array of the center values of the bins of the histogram.
Information about points that do not fall in any bin upon successful execution of the node.
Total number of values in signal that do not fall in any bin upon successful execution.
Number of values in signal below the first bin on the lower boundary.
Number of values in signal above the last bin on the upper boundary.
Error information.
The node produces this output according to standard error behavior.
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
The node completes the following steps to obtain the histogram h(x):
The following equation defines the bin intervals.
where
Whether the two ending points bins[i].lower and bins[i].upper of each bin are included in the bin ${\mathrm{\Delta}}_{i}$ depends on the value of inclusion in the corresponding cluster i of bins.
If bins is an empty array, this node uses the inputs maximum, minimum, and number of bins to establish the bins. Each bin width $\mathrm{\Delta}x$ is the same and calculated with the following equation.
The following equation calculates the width of the frequency bin Δx.
The following equation defines the function y_{i}(x).
This node evaluates the histogram h(x) with the following equation.
where
Where This Node Can Run:
Desktop OS: Windows
FPGA: This product does not support FPGA devices