8.28. Compute Feature Neighbors
Group (Subgroup)
Statistics (Morphological)
Description
This Filter determines, for each Feature, the number of other Features that are in contact with it. The algorithm for determining the number of “contiguous” neighbors of each Feature is as follows:
Identify the Feature to which a Cell belongs
Identify the Features to which each of the current Cell’s six (6) face-face neighboring Cells (front, back, left, right, up, down) belong
If a neighboring Cell belongs to a different Feature than the current Cell, then that Feature (owner of the neighboring Cell) is added to the list of contiguous neighbors of the Feature that owns the current Cell
Repeat 1-3 for all Cells
While performing the above steps, the number of neighboring Cells with a different Feature owner than a given Cell is stored, which identifies whether a Cell lies on the surface/edge/corner of a Feature (i.e. the Feature boundary). Additionally, the surface area shared between each set of contiguous Features is calculated by tracking the number of times two neighboring Cells correspond to a contiguous Feature pair. The Filter also notes which Features touch the outer surface of the sample (this is obtained for “free” while performing the above algorithm). The Filter gives the user the option whether or not they want to store this additional information.
Input Parameter(s)
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Store Boundary Cells Array |
Bool |
Whether to store the boundary Cells array |
|
Store Surface Features Array |
Bool |
Whether to store the surface Features array |
Input Data Objects
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Image Geometry |
Geometry Selection |
Image |
The geometry in which to identify feature neighbors |
Cell Feature Ids |
Array Selection |
Allowed Types: int32 Comp. Shape: 1 |
Specifies to which Feature each cell belongs |
Input Feature Data
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Feature Attribute Matrix |
AttributeMatrixSelection |
Feature Attribute Matrix of the selected Feature Ids |
Output Cell Data
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Boundary Cells |
DataObjectName |
The number of neighboring Cells of a given Cell that belong to a different Feature than itself. Values will range from 0 to 6. Only created if Store Boundary Cells Array is checked |
Output Feature Data
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Number of Neighbors |
DataObjectName |
Number of contiguous neighboring Features for a given Feature |
|
Neighbor List |
DataObjectName |
List of the contiguous neighboring Features for a given Feature |
|
Shared Surface Area List |
DataObjectName |
List of the shared surface area for each of the contiguous neighboring Features for a given Feature |
|
Surface Features |
DataObjectName |
The name of the surface features data array. Flag equal to 1 if the Feature touches an outer surface of the sample and equal to 0 if it does not. Only created if Store Surface Features Array is checked |
Example Pipelines
(01) SmallIN100 Morphological Statistics
(10) SmallIN100 Full Reconstruction
(02) Single Hexagonal Phase Equiaxed
(03) Single Cubic Phase Rolled
(05) Composite
(06) SmallIN100 Postsegmentation Processing
(01) Single Cubic Phase Equiaxed
(04) Two Phase Cubic Hexagonal Particles Equiaxed
(06) SmallIN100 Synthetic
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.