Skip to content

Commit

Permalink
ENH: Update docs for filters that change FeatureIds to warn user of i…
Browse files Browse the repository at this point in the history
…nvalid feature attribute matrix (#980)

This commit adds warnings to users though updated documentation about aliasing/skewed or invalid results based on if the feature ids change or some other action that would invalidate the feature attribute matrix.

- Compute Surface Area to Volume
    This filter had its main algorithm simplified a bit and variables updated
- Compute Surface Features
    This filter had its output changed to uint8 from bool
- Erode/Dilate bad data
- Fill Bad Data
- Require Minimum Size Features
- Require Minimum Number of Neighbors

Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
imikejackson authored May 28, 2024
1 parent 82e6046 commit f867a30
Show file tree
Hide file tree
Showing 26 changed files with 932 additions and 341 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"isDisabled": false,
"name": "(08) Small IN100 Full Reconstruction.d3dpipeline",
"pinnedParams": [],
"name": "Untitled Pipeline",
"pipeline": [
{
"args": {
Expand Down Expand Up @@ -67,7 +66,7 @@
},
"comments": "",
"filter": {
"name": "nx::core::MultiThresholdObjects",
"name": "nx::core::MultiThresholdObjectsFilter",
"uuid": "4246245e-1011-4add-8436-0af6bed19228"
},
"isDisabled": false
Expand All @@ -81,7 +80,7 @@
},
"comments": "",
"filter": {
"name": "nx::core::ConvertOrientations",
"name": "nx::core::ConvertOrientationsFilter",
"uuid": "501e54e6-a66f-4eeb-ae37-00e649c00d4b"
},
"isDisabled": false
Expand Down Expand Up @@ -113,7 +112,7 @@
},
"comments": "",
"filter": {
"name": "simplnx::IdentifySampleFilter",
"name": "nx::core::IdentifySampleFilter",
"uuid": "94d47495-5a89-4c7f-a0ee-5ff20e6bd273"
},
"isDisabled": false
Expand Down Expand Up @@ -238,7 +237,7 @@
},
"comments": "",
"filter": {
"name": "simplnx::FindNeighborsFilter",
"name": "nx::core::ComputeFeatureNeighborsFilter",
"uuid": "7177e88c-c3ab-4169-abe9-1fdaff20e598"
},
"isDisabled": false
Expand All @@ -256,10 +255,8 @@
"feature_ids_path": "DataContainer/Cell Data/FeatureIds",
"feature_parent_ids_array_name": "ParentIds",
"feature_phases_array_path": "DataContainer/Cell Feature Data/Phases",
"non_contiguous_neighbor_list_array_path": "",
"seed_array_name": "MergeTwins SeedValue",
"seed_value": 5489,
"use_non_contiguous_neighbors": false,
"use_seed": false
},
"comments": "",
Expand Down Expand Up @@ -309,9 +306,9 @@
"DataContainer/Cell Feature Data/NumNeighbors2"
]
},
"comments": "We are going to remove the DataContainer/Cell Feature Data/NumNeighbors data because there is no way to ensure that it is correct after the last filter was executed.",
"comments": "",
"filter": {
"name": "nx::core::DeleteData",
"name": "nx::core::DeleteDataFilter",
"uuid": "bf286740-e987-49fe-a7c8-6e566e3a0606"
},
"isDisabled": false
Expand All @@ -331,15 +328,14 @@
},
"comments": "",
"filter": {
"name": "simplnx::FindNeighborsFilter",
"name": "nx::core::ComputeFeatureNeighborsFilter",
"uuid": "7177e88c-c3ab-4169-abe9-1fdaff20e598"
},
"isDisabled": false
},
{
"args": {
"apply_to_single_phase": false,
"cell_attribute_matrix_path": "DataContainer/Cell Data",
"feature_ids_path": "DataContainer/Cell Data/FeatureIds",
"feature_phases_path": "Data Container/Feature Data/Phases",
"ignored_voxel_arrays": [],
Expand All @@ -350,20 +346,28 @@
},
"comments": "",
"filter": {
"name": "simplnx::RequireMinNumNeighborsFilter",
"name": "nx::core::RequireMinNumNeighborsFilter",
"uuid": "4ab5153f-6014-4e6d-bbd6-194068620389"
},
"isDisabled": false
},
{
"args": {
"removed_data_path": [
"DataContainer/Cell Feature Data/NumNeighbors"
"DataContainer/Cell Feature Data/NumNeighbors",
"DataContainer/Cell Feature Data/Active",
"DataContainer/Cell Feature Data/AvgEulerAngles",
"DataContainer/Cell Feature Data/AvgQuats",
"DataContainer/Cell Feature Data/EquivalentDiameters",
"DataContainer/Cell Feature Data/NumElements",
"DataContainer/Cell Feature Data/ParentIds",
"DataContainer/Cell Feature Data/Phases",
"DataContainer/Cell Feature Data/Volumes"
]
},
"comments": "We are going to remove the DataContainer/Cell Feature Data/NumNeighbors data because there is no way to ensure that it is correct after the last filter was executed.",
"comments": "",
"filter": {
"name": "nx::core::DeleteData",
"name": "nx::core::DeleteDataFilter",
"uuid": "bf286740-e987-49fe-a7c8-6e566e3a0606"
},
"isDisabled": false
Expand Down Expand Up @@ -454,6 +458,5 @@
"isDisabled": false
}
],
"version": 1,
"workflowParams": []
}
"version": 1
}
Loading

0 comments on commit f867a30

Please sign in to comment.