Skip to content

Commit

Permalink
DOC: Update MinSize docs to add warnings about removed/replaced data
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
  • Loading branch information
imikejackson committed May 24, 2024
1 parent 8e95bfa commit 48f419b
Showing 1 changed file with 12 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,18 @@ This **Filter** removes **Features** that have a total number of **Cells** below

The **Filter** can be run in a mode where the minimum number of neighbors is applied to a single **Ensemble**. The user can select to apply the minimum to one specific **Ensemble**.

## Warning: Cell Level Data Will Be Changed

Cells that are part of features that are smaller than the minimum size threshold will have their DataArray values **replaced** with values from neighboring cells that are within a valid feature, i.e., features that are removed have their cell level data replaced with neighboring larger features.

## WARNING: Feature Data Will Become Invalid

By modifying the cell level data, any feature data that was previously computed will most likely be invalid at this point. Filters such as "Find Sizes", "Find Shapes" should be re-run if you want accurate final results from your pipeline.

## WARNING: NeighborList Removal

If the Cell Feature AttributeMatrix contains any *NeighborList* data arrays, those arrays will be **REMOVED** because those lists are now invalid. Re-run the *Find Neighbors* filter to re-create the lists.

## Notes ##

If any features are removed **and** the Cell Feature AttributeMatrix contains any _NeighborList_ data arrays those arrays will be **REMOVED** because those lists are now invalid. Re-run the _Find Neighbors_ filter to re-create the lists.
Expand Down

0 comments on commit 48f419b

Please sign in to comment.