8.16. Compute Attribute Array Frequency Histogram (Feature)
Description
This Filter accepts one or more numeric DataArray inputs and computes feature-specific histograms. For each selected array, values are grouped by feature, then divided into equal-width bins—using either automatically derived or user-defined minimum/maximum bounds—and counted per bin.
Optionally, a mask DataArray can be provided to include only specific elements in the histogram computation.
Outputs include:
Counts DataArray: One N-component tuple per feature where N is the number of bins and each component holds the histogram count for that feature.
Example: With 5 bins, feature 8’s counts appear as the five components at tuple index 8.
Bin Ranges DataArray: One (N*2)-component tuple per feature defining each bin’s inclusive lower bound and exclusive upper bound.
Example: For 4 bins spanning [0,8), a feature’s tuple is [0,2), [2,4), [4,6), [6,8) represented as
[0,2,2,4,4,6,6,8].
Most Populated Bin DataArray: One tuple per feature with one component indicating the bin index containing the most values.
Example: If feature 3’s third bin contains the most values, then tuple 3 has the value
2.
Modal Bin Ranges INeighborList (optional): One NeighborList that contains one list per feature specifying inclusive lower bound and exclusive upper bound containing the feature’s mode(s). Because there can be multiple modes, each list may include more than 2 entries.
Example: list 5 contains
[0.5, 10.2, 41.3, 54.1]if feature 5 has two mode values and they fall between 0.5 and 10.2 and between 41.3 and 54.1.
Input Parameter(s)
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Number of Bins |
Scalar Value |
Int32 |
Specifies number of histogram bins (greater than zero) |
Use Custom Min & Max Range |
Bool |
Whether the user can set the min and max values to consider for the histogram |
|
Min Value |
Scalar Value |
Float64 |
Specifies the inclusive lower bound of the histogram. |
Max Value |
Scalar Value |
Float64 |
Specifies the exclusive upper bound of the histogram. |
Calculate Modal Bin Ranges |
Bool |
Whether to compute the histogram bin ranges that contain the mode values. |
|
Use Mask Array |
Bool |
Specifies whether or not to use a mask array |
|
Mask Array |
Array Selection |
Allowed Types: uint8, boolean Comp. Shape: 1 |
DataPath to the boolean mask array. Values that are true will mark that cell/point as usable. |
Input Data
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Input Data Arrays |
MultiArraySelection |
The list of arrays to calculate histogram(s) for |
|
Cell Feature Ids |
Array Selection |
Allowed Types: int32 Comp. Shape: 1 |
Specifies to which feature each cell belongs. |
Output Parameters
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Create New DataGroup for Histograms |
Bool |
Whether or not to store the calculated histogram(s) in a new DataGroup |
|
New DataGroup Path |
DataGroupCreation |
The path to the new DataGroup in which to store the calculated histogram(s) |
|
Output DataGroup Path |
DataGroupSelection |
The complete path to the DataGroup in which to store the calculated histogram(s) |
|
Histogram Bin Counts Array Name |
String |
Name of the created “Bin Counts” array for each input array. |
|
Histogram Bin Ranges Array Name |
String |
Name of the created “Bin Ranges” array for each input array. |
|
Most Populated Bin Array Name |
String |
Name of the created “Most Populated Bin” array for each input array. |
|
Modal Bin Ranges Array Name |
DataObjectName |
Name of the created “Modal Bin Ranges” array for each input array. |
Example Pipelines
License & Copyright
Please see the description file distributed with this Plugin
DREAM3D-NX Help
If you need help, need to file a bug report or want to request a new feature, please head over to the DREAM3DNX-Issues GitHub site where the community of DREAM3D-NX users can help answer your questions.