Skip to content

Commit

Permalink
ENH: Calculate "Modal Histogram Bin Ranges" Array In Find Attribute A…
Browse files Browse the repository at this point in the history 
…rray Statistics (#686)

* Add ability to calculate modal histogram bin ranges.
* Updating unit test and fixing incorrect code found while updating test.
* Link the new parameters to Find Histogram.
* Update documentation.

---------

Signed-off-by: Joey Kleingers <[email protected]>
  • Loading branch information
@joeykleingers
joeykleingers authored Sep 2, 2023
1 parent e51d69f commit 55fc837
Show file tree
Hide file tree
Showing 7 changed files with 199 additions and 33 deletions.
31 changes: 16 additions & 15 deletions src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,21 +69,22 @@ None

## Created Objects ##

| Kind | Default Name | Type | Component Dimensions | Description |
|---------------------|-------------------------|-----------------------------------|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Attribute Array** | Feature-Has-Data | bool | (1) | Indicates, for each feature, whether or not the feature actually contains any data (only usable when *Compute Statistics Per Feature/Ensemble* is turned on). This array is especially useful to help determine whether or not the outputted statistics are actually valid or not for a given feature. |
| **Attribute Array** | Histogram | uint64 | (Number of Bins) | Histogram of the input array, if _Find Histogram_ is checked |
| **Attribute Array** | Most Populated Bin | uint64 | (2) | Most populated bin from the histogram of the input array, if _Find Histogram_ is checked. First component is the bin index (0-based), second component is the number of values in the bin. |
| **Attribute Array** | Length | int64_t | (1) | Length of the input array, if _Find Length_ is checked |
| **Attribute Array** | Minimum | same as input **Attribute Array** | (1) | Minimum of the input array, if _Find Minimum_ is checked |
| **Attribute Array** | Maximum | same as input **Attribute Array** | (1) | Maximum of the input array, if _Find Maximum_ is checked |
| **Attribute Array** | Mean | double | (1) | Arithmetic mean of the input array, if _Find Mean_ is checked |
| **Attribute Array** | Median | double | (1) | Median of the input array, if _Find Median_ is checked |
| **Neighbor List** | Mode | same as input **Attribute Array** | (1) | Modes of the input array, if _Find Mode_ is checked |
| **Attribute Array** | Standard Deviation | double | (1) | Standard deviation of the input array, if _Find Standard Deviation_ is checked |
| **Attribute Array** | Summation | double | (1) | Summation of the input array, if _Find Summation_ is checked |
| **Attribute Array** | Standardized | double | (1) | Standardized version of the input array, if _Standardize Data_ is checked |
| **Attribute Array** | Number of Unique Values | int32_t | (1) | The number of unique values in the input array, if _Find Number of Unique Values_ is checked |
| Kind | Default Name | Type | Component Dimensions | Description |
|---------------------|----------------------------|---------------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Attribute Array** | Feature-Has-Data | bool | (1) | Indicates, for each feature, whether or not the feature actually contains any data (only usable when *Compute Statistics Per Feature/Ensemble* is turned on). This array is especially useful to help determine whether or not the outputted statistics are actually valid or not for a given feature. |
| **Attribute Array** | Histogram | uint64 | (Number of Bins) | Histogram of the input array, if _Find Histogram_ is checked |
| **Attribute Array** | Most Populated Bin | uint64 | (2) | Most populated bin from the histogram of the input array, if _Find Histogram_ is checked. First component is the bin index (0-based), second component is the number of values in the bin. |
| **Neighbor List** | Modal Histogram Bin Ranges | float | (1) | Ranges, in physical units, of histogram bin(s) that contain mode value(s). _Find Histogram_, _Find Modal Histogram Bin Ranges_, and _Find Mode_ must all be checked. The min/max values are stored in the neighbor list arrays from bin 0 - bin N (Example: [bin0min, bin0max, bin1min, bin1max, ... binNmin, binNmax]) |
| **Attribute Array** | Length | int64_t | (1) | Length of the input array, if _Find Length_ is checked |
| **Attribute Array** | Minimum | same as input **Attribute Array** | (1) | Minimum of the input array, if _Find Minimum_ is checked |
| **Attribute Array** | Maximum | same as input **Attribute Array** | (1) | Maximum of the input array, if _Find Maximum_ is checked |
| **Attribute Array** | Mean | double | (1) | Arithmetic mean of the input array, if _Find Mean_ is checked |
| **Attribute Array** | Median | double | (1) | Median of the input array, if _Find Median_ is checked |
| **Neighbor List** | Mode | same as input **Attribute Array** | (1) | Modes of the input array, if _Find Mode_ is checked |
| **Attribute Array** | Standard Deviation | double | (1) | Standard deviation of the input array, if _Find Standard Deviation_ is checked |
| **Attribute Array** | Summation | double | (1) | Summation of the input array, if _Find Summation_ is checked |
| **Attribute Array** | Standardized | double | (1) | Standardized version of the input array, if _Standardize Data_ is checked |
| **Attribute Array** | Number of Unique Values | int32_t | (1) | The number of unique values in the input array, if _Find Number of Unique Values_ is checked |

## Example Pipelines ##

Expand Down
Loading

0 comments on commit 55fc837

Please sign in to comment.