Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ENH:MultiThresholdObjects: Add ability to set custom TRUE and FALSE values. #669

Merged
merged 8 commits into from
Aug 22, 2023
Merged

ENH:MultiThresholdObjects: Add ability to set custom TRUE and FALSE values. #669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2d837f9
MultiThresholdObjects: Add ability to set custom TRUE and FALSE values.
joeykleingers Aug 18, 2023
c558776
Simplify CheckCustomValueInBounds operator.
joeykleingers Aug 18, 2023
c0026d1
Add missing preflight and execute calls.
joeykleingers Aug 18, 2023
b79ab7f
Put boolean tests back.
joeykleingers Aug 21, 2023
2359aed
Prevent selecting custom true/false values if output array is boolean.
joeykleingers Aug 21, 2023
e114b13
Use error codes enumeration.
joeykleingers Aug 21, 2023
99e3fcf
Add custom values test cases and check error codes.
joeykleingers Aug 21, 2023
06b8f26
Update doc with note about custom true/false values breaking other fi…
joeykleingers Aug 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/Plugins/ComplexCore/docs/MultiThresholdObjects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,19 @@ An example of this **Filter's** use would be after EBSD data is read into DREAM.

For example, an integer array contains the values 1, 2, 3, 4, 5. For a comparison value of 3 and the comparison operator greater than, the boolean threshold array produced will contain *false*, *false*, *false*, *true*, *true*. For the comparison set { *Greater Than* 2 AND *Less Than* 5} OR *Equals* 1, the boolean threshold array produced will contain *true*, *false*, *true*, *true*, *false*.

It is possible to set custom values for both the TRUE and FALSE values that will be output to the threshold array. For example, if the user selects an output threshold array type of uint32, then they could set a custom FALSE value of 5 and a custom TRUE value of 20. So then instead of outputting 0's and 1's to the threshold array, the filter would output 5's and 20's.

**NOTE**: If custom TRUE/FALSE values are chosen, then using the resulting mask array in any other filters that require a mask array will break those other filters. This is because most other filters that require a mask array make the assumption that the true/false values are 1/0.

## Parameters ##

| Name | Type | Description |
|------|------|-------------|
| Name | Type | Description |
|--------------------------|-----------------|----------------------------------------------------------------------------------------------------------------|
| Data Arrays to Threshold | Comparison List | This is the set of criteria applied to the objects the selected arrays correspond to when doing the thresholding |
| Use Custom TRUE Value | bool | Specifies whether to output a custom TRUE value |
| Custom TRUE Value | float64 | The custom TRUE value (the default value is 1) |
| Use Custom FALSE Value | bool | Specifies whether to output a custom FALSE value |
| Custom FALSE Value | float64 | The custom FALSE value (the default value is 0) |

## Required Geometry ##

Expand Down
Loading
Loading