10.44. Compute Neighbor List Statistics

Group (Subgroup)

Statistics (Misc Filters)

Description

This Filter reduces a NeighborList – a per-feature list of values, one entry per neighbor – into per-feature scalar summary statistics. Each chosen statistic becomes its own output Attribute Array at the feature level.

A typical use is summarizing per-feature neighbor misorientations: Compute Feature Neighbor Misorientations produces a NeighborList containing the misorientation between a feature and each of its neighbors; this filter reduces that list to “average misorientation per feature” or “max neighbor misorientation per feature” so the result can be plotted or thresholded.

Available Statistics

The user can independently enable any combination of:

• Length – the number of entries in the list (i.e., the number of neighbors).

• Minimum – smallest value in the list.

• Maximum – largest value in the list.

• Mean – arithmetic mean of the list.

• Median – median of the list.

• Standard Deviation – sample standard deviation of the list.

• Summation – sum of all values in the list.

Output statistics inherit the units of the input list (e.g., degrees for a misorientation list, dimensionless count for a neighbor count list).

Required Input Sources

• Input NeighborList – a feature-level list-of-lists. Common producers include Compute Feature Neighbors (shared surface area), Compute Feature Neighbor Misorientations (misorientation per neighbor), Compute Feature Neighbor C-Axis Misalignments, or Compute Slip Transmission Metrics.

Input Parameter(s)

Parameter Name	Parameter Type	Parameter Notes	Description
Find Length	Bool		Specifies whether or not the filter creates the Length array during calculations
Find Minimum	Bool		Specifies whether or not the filter creates the Minimum array during calculations
Find Maximum	Bool		Specifies whether or not the filter creates the Maximum array during calculations
Find Mean	Bool		Specifies whether or not the filter creates the Mean array during calculations
Find Median	Bool		Specifies whether or not the filter creates the Median array during calculations
Find Standard Deviation	Bool		Specifies whether or not the filter creates the Standard Deviation array during calculations
Find Summation	Bool		Specifies whether or not the filter creates the Summation array during calculations

Input Data Objects

Parameter Name	Parameter Type	Parameter Notes	Description
NeighborList to Compute Statistics	NeighborListSelection		Input Data Array to compute statistics

Output Data Object(s)

Parameter Name	Parameter Type	Parameter Notes	Description
Length	DataObjectName		Path to create the Length array during calculations
Minimum	DataObjectName		Path to create the Minimum array during calculations
Maximum	DataObjectName		Path to create the Maximum array during calculations
Mean	DataObjectName		Path to create the Mean array during calculations
Median	DataObjectName		Path to create the Median array during calculations
Standard Deviation	DataObjectName		Path to create the Standard Deviation array during calculations
Summation	DataObjectName		Path to create the Summation array during calculations

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.