8.90. Multi-Threshold Objects

Group (Subgroup)

Processing (Threshold)

Description

This Filter allows the user to input single or multiple criteria for thresholding Attribute Arrays in an Attribute Matrix. Internally, the algorithm creates the output boolean arrays for each comparison that the user creates. Comparisons can be either a value and boolean operator (Less Than, Greater Than, Equal To, Not Equal To) or a collective set of comparisons. Then all the output arrays are compared with their given comparison operator ( And / Or ) with the value of a set being the result of its own comparisons calculated from top to bottom.

An example of this Filter’s use would be after EBSD data is read into DREAM3D-NX and the user wants to have DREAM3D-NX consider Cells that the user considers good. The user would insert this Filter and select the criteria that makes a Cell good. All arrays must come from the same Attribute Matrix in order for the Filter to execute.

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.

Input Parameter(s)

Parameter Name

Parameter Type

Parameter Notes

Description

Data Thresholds

ArrayThresholds

DataArray thresholds to mask

Mask Type

DataType

DataType used for the created Mask Array

Use Custom TRUE Value

Bool

Specifies whether to output a custom TRUE value (the default value is 1)

Custom TRUE Value

Scalar Value

Float64

This is the custom TRUE value that will be output to the mask array

Use Custom FALSE Value

Bool

Specifies whether to output a custom FALSE value (the default value is 0)

Custom FALSE Value

Scalar Value

Float64

This is the custom FALSE value that will be output to the mask array

Mask Array

DataObjectName

DataPath to the created Mask Array

Example Pipelines

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.