10.123. Remove Flagged Edges

Group (Subgroup)

Surface Meshing (Cleanup)

Description

This Filter removes edges from an Edge Geometry based on a per-edge mask. An Edge Geometry is a node-based geometry made of straight line segments (edges), where each edge connects two vertices. A mask is a boolean (or uint8) value stored for every edge that flags it as either true (1) or false (0). Every edge flagged true is removed; the remaining edges are written into a new, smaller Edge Geometry.

Because the number of removed edges is not known until the filter runs, the result must be written to a newly created Edge Geometry rather than modifying the input in place. The new geometry will NOT contain copies of any Feature Attribute Matrix or Ensemble Attribute Matrix from the original geometry.

The mask is applied to the edges themselves, so it must come from an array in the Edge Data Attribute Matrix (one value per edge).

Data Handling

For each of the vertex and edge data attribute matrices, the user can select to copy none, some, or all of the associated data arrays into the newly created geometry. To copy none of the data, leave the choice set to Copy Selected XXX Data but do not populate the selection list.

A Note on Vertex Data Handling

The Vertex Data Handling parameter controls which vertex data arrays are transferred to the reduced geometry:

  • Copy Selected Vertex Data [0]: Copies only the vertex arrays selected by the user into the new geometry.

  • Copy All Vertex Data [1]: Copies all arrays from the vertex attribute matrix into the new geometry.

A Note on Edge Data Handling

The Edge Data Handling parameter controls which edge data arrays are transferred to the reduced geometry:

  • Copy Selected Edge Data [0]: Copies only the edge arrays selected by the user into the new geometry.

  • Copy All Edge Data [1]: Copies all arrays from the edge attribute matrix into the new geometry.

Note: Because the number of removed edges cannot be known before run time, the new Edge Geometry and all associated edge data to be copied are initialized to size 0 and then grown to the final size during execution.

Example Output

  • The next figure shows an edge geometry that has had a mask generated. Yellow parts are flagged as true.

Masked edge geometries for removal.

  • The next figure shows the result of running the filter.

Resulting edge geometry

Required Input Sources

Input Data Objects

Parameter Name

Parameter Type

Parameter Notes

Description

Edge Geometry

Geometry Selection

Edge

The Edge Geometry that will be processed.

Mask

Array Selection

Allowed Types: uint8, boolean Comp. Shape: 1

The DataArrayPath to the mask array that marks each edge as either true (remove) or false(keep).

Output Geometry

Parameter Name

Parameter Type

Parameter Notes

Description

Created Geometry

DataGroupCreation

The name of the created Edge Geometry

Vertex Data Handling

Parameter Name

Parameter Type

Parameter Notes

Description

Vertex Data Handling

Choices

How to handle Data that resides on the edges

Vertex Data

AttributeMatrixSelection

Vertex Attribute Matrix that will be copied to the reduced geometry

Vertex Attribute Arrays to Copy

MultiArraySelection

Vertex DataPaths to copy

Edge Data Handling

Parameter Name

Parameter Type

Parameter Notes

Description

Edge Data Handling

Choices

How to handle Data that resides on the edges

Edge Data

AttributeMatrixSelection

Edge Attribute Matrix that will be copied to the reduced geometry

Edge Attribute Arrays to Copy

MultiArraySelection

Edge DataPaths to copy

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.