BUG: Fixes incorrect number of features in the feature Attribute Matrix

The number of tuples of the Feature Attribute Matrix was always +1 due to how
a counter was being incremented.

A new unit test was created to more thoroughly test both the Ebsd and CAxis segment features filters

Author: imikejackson

src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/EBSDSegmentFeaturesFilter.cpp

@@ -64,7 +64,7 @@ Parameters EBSDSegmentFeaturesFilter::parameters() const
   params.insertSeparator(Parameters::Separator{"Input Parameter(s)"});
   params.insert(std::make_unique<Float32Parameter>(k_MisorientationTolerance_Key, "Misorientation Tolerance (Degrees)",
                                                    "Tolerance (in degrees) used to determine if neighboring Cells belong to the same Feature", 5.0f));
-  params.insert(std::make_unique<BoolParameter>(k_RandomizeFeatureIds_Key, "Randomize Feature IDs", "Specifies if feature IDs should be randomized during calculations", false));
+  params.insert(std::make_unique<BoolParameter>(k_RandomizeFeatureIds_Key, "Randomize Feature Ids", "Specifies if feature IDs should be randomized during calculations", false));
   params.insert(std::make_unique<ChoicesParameter>(k_NeighborScheme_Key, "Neighbor Scheme", "How many neighbors to use", segment_features::k_6NeighborIndex, segment_features::k_OperationChoices));
 
   params.insertSeparator(Parameters::Separator{"Optional Data Mask"});

src/Plugins/OrientationAnalysis/test/CAxisSegmentFeaturesTest.cpp

@@ -152,6 +152,8 @@ if(EXISTS "${DREAM3D_DATA_DIR}" AND SIMPLNX_DOWNLOAD_TEST_FILES)
   download_test_data(DREAM3D_DATA_DIR ${DREAM3D_DATA_DIR} ARCHIVE_NAME 7_2_AvgCAxis.tar.gz SHA512 054d1fbb92baacfa79f0bd326ae32b5bfc67d0935413ea8f194980527ff9694bd21a49f73e43d59b731a567ea89190523176bf5c98e8585e7b206265d5b05143)
   download_test_data(DREAM3D_DATA_DIR ${DREAM3D_DATA_DIR} ARCHIVE_NAME 7_ComputeAvgOrientation.tar.gz SHA512 5ee425b9a45da4daab1d43a870b54d57ac8d8e300acda162fa7a974a22b9f5662a98e768cebac1844eb87fcb2bb01624ffaf117d3aacc722aa8701712cbf3c52)
   download_test_data(DREAM3D_DATA_DIR ${DREAM3D_DATA_DIR} ARCHIVE_NAME 7_read_oem_ebsd_h5_files.tar.gz SHA512 95fa4cc0fb6bce26bfd6d28c0205a9e0f6497ad876a7cc4381117e668836936b35683ed5ec757cadd124a6c6fec7b38fe11f72512105bbd677bcf4210892ac19)
+  download_test_data(DREAM3D_DATA_DIR ${DREAM3D_DATA_DIR} ARCHIVE_NAME compute_feature_neighbor_caxis_misalignments.tar.gz SHA512 955cd35b7ae24579ef9c533df34e1118012a8e5e2a71f8613117c714fc220c5dfa78d91a2964b41752e70684b79d4aa790e488e9a7be4c9dcf7b642ee2897ceb)
+  download_test_data(DREAM3D_DATA_DIR ${DREAM3D_DATA_DIR} ARCHIVE_NAME segment_features_test_data.tar.gz SHA512 a345212de5bb969490d66a4ae1066a7ab3c85890d9dc7f26554b421fb2171626f15a842ff76573b1f9f71625828a46bb304df6416a2894dba7a84c0014f0c00a)
 
 endif()
 

src/Plugins/OrientationAnalysis/test/CMakeLists.txt

@@ -40,7 +40,7 @@ Uuid RandomizeFeatureIdsFilter::uuid() const
 //------------------------------------------------------------------------------
 std::string RandomizeFeatureIdsFilter::humanName() const
 {
-  return "Randomize Feature IDs";
+  return "Randomize Feature Ids";
 }
 
 //------------------------------------------------------------------------------

src/Plugins/OrientationAnalysis/test/EBSDSegmentFeaturesFilterTest.cpp

@@ -64,7 +64,7 @@ Parameters ScalarSegmentFeaturesFilter::parameters() const
 
   params.insertSeparator(Parameters::Separator{"Input Parameter(s)"});
   params.insert(std::make_unique<NumberParameter<int>>(k_ScalarToleranceKey, "Scalar Tolerance", "Tolerance for segmenting input Cell Data", 1));
-  params.insert(std::make_unique<BoolParameter>(k_RandomizeFeatures_Key, "Randomize Feature IDs", "Specifies if feature IDs should be randomized during calculations", false));
+  params.insert(std::make_unique<BoolParameter>(k_RandomizeFeatures_Key, "Randomize Feature Ids", "Specifies if feature IDs should be randomized during calculations", false));
 
   params.insert(std::make_unique<ChoicesParameter>(k_NeighborScheme_Key, "Neighbor Scheme", "How many neighbors to use", segment_features::k_6NeighborIndex, segment_features::k_OperationChoices));
 

src/Plugins/SimplnxCore/src/SimplnxCore/Filters/RandomizeFeatureIdsFilter.cpp

@@ -131,7 +131,7 @@ set(${PLUGIN_NAME}UnitTest_SRCS
   ReverseTriangleWindingTest.cpp
   RobustAutomaticThresholdTest.cpp
   RotateSampleRefFrameTest.cpp
-  ScalarSegmentFeaturesFilterTest.cpp
+  ScalarSegmentFeaturesTest.cpp
   SetImageGeomOriginScalingFilterTest.cpp
   SharedFeatureFaceTest.cpp
   SilhouetteTest.cpp

src/Plugins/SimplnxCore/src/SimplnxCore/Filters/ScalarSegmentFeaturesFilter.cpp

@@ -31,7 +31,7 @@ const std::string k_ExemplaryCombinationFaceOnlyFeatureIdsName = "Exemplary Comb
 const std::string k_ExemplaryCombinationAllConnectedFeatureIdsName = "Exemplary Combination FeatureIds - All Connected";
 } // namespace
 
-TEST_CASE("SimplnxCore::ScalarSegmentFeatures", "[Reconstruction][ScalarSegmentFeatures]")
+TEST_CASE("SimplnxCore::ScalarSegmentFeatures", "[SimplnxCore][ScalarSegmentFeatures]")
 {
   UnitTest::LoadPlugins();
 

src/Plugins/SimplnxCore/test/CMakeLists.txt

@@ -148,7 +148,7 @@ Result<> SegmentFeatures::execute(IGridGeometry* gridGeom)
   // Initialize a sequence of execution modifiers
   int32 gnum = 1;
   int64 nextSeed = 0;
-  int64 seed = getSeed(gnum, nextSeed);
+  int64 seed = 0; // Always use the very first value of the array that we are using to segment
   usize size = 0;
 
   // Initialize containers
@@ -205,18 +205,18 @@ Result<> SegmentFeatures::execute(IGridGeometry* gridGeom)
       totalVoxelsSegmented += size;
     }
 
+    // Send a progress message
+    throttledMessenger.sendThrottledMessage([&]() { return fmt::format("{:.2f}% - Features Found: {}", 100.0f * static_cast<float>(totalVoxelsSegmented) / static_cast<float>(totalVoxels), gnum); });
+    // Increment or set values for the next iteration
     voxelsList.assign(size + 1, -1);
     gnum++;
-
-    throttledMessenger.sendThrottledMessage([&]() { return fmt::format("{:.2f}% - Features Found: {}", 100.0f * static_cast<float>(totalVoxelsSegmented) / static_cast<float>(totalVoxels), gnum); });
-
+    // Get the next seed value
+    seed = getSeed(gnum, nextSeed); // If seed ends up being -1, then we will exit the loop.
     nextSeed = seed + 1;
-    seed = getSeed(gnum, nextSeed);
   }
 
-  m_MessageHelper.sendMessage(fmt::format("Total Features Found: {}", gnum));
-
-  m_FoundFeatures = gnum;
+  m_FoundFeatures = gnum - 1; // Decrement the gnum because it will end up 1 larger than it should have been.
+  m_MessageHelper.sendMessage(fmt::format("Total Features Found: {}", m_FoundFeatures));
   return {};
 }