From 87f49f14c734f84bfba598a251659a87d18c0a82 Mon Sep 17 00:00:00 2001 From: Michael Jackson Date: Tue, 24 Oct 2023 12:15:22 -0400 Subject: [PATCH] Minor adjustments to human readable text Signed-off-by: Michael Jackson --- .../src/ComplexCore/Filters/AddBadDataFilter.cpp | 4 ++-- .../Filters/Algorithms/ScalarSegmentFeatures.cpp | 4 +++- .../Filters/FindFeatureClusteringFilter.cpp | 2 +- .../src/ComplexCore/Filters/InitializeData.cpp | 4 ++-- .../src/ComplexCore/Filters/KMeansFilter.cpp | 4 ++-- .../src/ComplexCore/Filters/KMedoidsFilter.cpp | 4 ++-- .../Filters/PointSampleTriangleGeometryFilter.cpp | 4 ++-- .../UncertainRegularGridSampleSurfaceMeshFilter.cpp | 11 +++++++---- .../Filters/Algorithms/EBSDSegmentFeatures.cpp | 5 +++-- .../OrientationAnalysis/Filters/MergeTwinsFilter.cpp | 4 ++-- 10 files changed, 26 insertions(+), 20 deletions(-) diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/AddBadDataFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/AddBadDataFilter.cpp index c1cd8f9874..b22968fc56 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/AddBadDataFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/AddBadDataFilter.cpp @@ -56,8 +56,8 @@ Parameters AddBadDataFilter::parameters() const // Create the parameter descriptors that are needed for this filter params.insertSeparator(Parameters::Separator{"Seeded Randomness"}); params.insertLinkableParameter(std::make_unique(k_UseSeed_Key, "Use Seed for Random Generation", "When true the user will be able to put in a seed for random generation", false)); - params.insert(std::make_unique>(k_SeedValue_Key, "Seed", "The seed fed into the random generator", std::mt19937::default_seed)); - params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "_Add_Bad_Data_Seed_Value_")); + params.insert(std::make_unique>(k_SeedValue_Key, "Seed Value", "The seed fed into the random generator", std::mt19937::default_seed)); + params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "AddBadData SeedValue")); params.insertSeparator(Parameters::Separator{"Optional Variables"}); params.insertLinkableParameter(std::make_unique(k_PoissonNoise_Key, "Add Random Noise", "If true the user may set the poisson volume fraction", false)); diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/Algorithms/ScalarSegmentFeatures.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/Algorithms/ScalarSegmentFeatures.cpp index 10d8f80881..5772796031 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/Algorithms/ScalarSegmentFeatures.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/Algorithms/ScalarSegmentFeatures.cpp @@ -225,7 +225,9 @@ Result<> ScalarSegmentFeatures::operator()() activeArray->getDataStore()->fill(1); (*activeArray)[0] = 0; - // By default we randomize grains + // Randomize the feature Ids for purely visual clarify. Having random Feature Ids + // allows users visualizing the data to better discern each grain otherwise the coloring + // would look like a smooth gradient. This is a user input parameter if(m_InputValues->pShouldRandomizeFeatureIds) { const int64 rangeMin = 0; diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/FindFeatureClusteringFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/FindFeatureClusteringFilter.cpp index b0fa1dbdab..20620ed6b2 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/FindFeatureClusteringFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/FindFeatureClusteringFilter.cpp @@ -66,7 +66,7 @@ Parameters FindFeatureClusteringFilter::parameters() const params.insertLinkableParameter( std::make_unique(k_SetRandomSeed_Key, "Set Random Seed", "When checked, allows the user to set the seed value used to randomly generate the points in the RDF", true)); params.insert(std::make_unique(k_SeedValue_Key, "Seed Value", "The seed value used to randomly generate the points in the RDF", std::mt19937::default_seed)); - params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "_Find_Feature_Clustering_Seed_Value_")); + params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "FindFeatureClustering SeedValue")); params.insertSeparator(Parameters::Separator{"Cell Feature Data"}); params.insert(std::make_unique(k_EquivalentDiametersArrayPath_Key, "Equivalent Diameters", "Diameter of a sphere with the same volume as the Feature", DataPath{}, diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/InitializeData.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/InitializeData.cpp index 6ba4934a14..d7eb9a1b3f 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/InitializeData.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/InitializeData.cpp @@ -189,8 +189,8 @@ Parameters InitializeData::parameters() const // TODO: restrict types params.insertSeparator(Parameters::Separator{"Seeded Randomness"}); params.insertLinkableParameter(std::make_unique(k_UseSeed_Key, "Use Seed for Random Generation", "When true the user will be able to put in a seed for random generation", false)); - params.insert(std::make_unique>(k_SeedValue_Key, "Seed", "The seed fed into the random generator", std::mt19937::default_seed)); - params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "_Initialize_Data_Seed_Value_")); + params.insert(std::make_unique>(k_SeedValue_Key, "Seed Value", "The seed fed into the random generator", std::mt19937::default_seed)); + params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "InitializeData SeedValue")); params.insertSeparator(Parameters::Separator{"Input Parameters"}); params.insert(std::make_unique(k_MinPoint_Key, "Min Point", "The minimum x, y, z bound in cells", std::vector{0, 0, 0}, diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMeansFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMeansFilter.cpp index aa1c1990cd..0fae499098 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMeansFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMeansFilter.cpp @@ -66,8 +66,8 @@ Parameters KMeansFilter::parameters() const // Create the parameter descriptors that are needed for this filter params.insertSeparator(Parameters::Separator{"Seeded Randomness"}); params.insertLinkableParameter(std::make_unique(k_UseSeed_Key, "Use Seed for Random Generation", "When true the user will be able to put in a seed for random generation", false)); - params.insert(std::make_unique>(k_SeedValue_Key, "Seed", "The seed fed into the random generator", std::mt19937::default_seed)); - params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "_K_Means_Seed_Value_")); + params.insert(std::make_unique>(k_SeedValue_Key, "Seed Value", "The seed fed into the random generator", std::mt19937::default_seed)); + params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "KMeans SeedValue")); params.insertSeparator(Parameters::Separator{"Input Parameters"}); params.insertLinkableParameter(std::make_unique(k_UseMask_Key, "Use Mask", "Specifies whether or not to use a mask array", false)); diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMedoidsFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMedoidsFilter.cpp index 5369cd41f9..09239e9717 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMedoidsFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMedoidsFilter.cpp @@ -66,8 +66,8 @@ Parameters KMedoidsFilter::parameters() const // Create the parameter descriptors that are needed for this filter params.insertSeparator(Parameters::Separator{"Seeded Randomness"}); params.insertLinkableParameter(std::make_unique(k_UseSeed_Key, "Use Seed for Random Generation", "When true the user will be able to put in a seed for random generation", false)); - params.insert(std::make_unique>(k_SeedValue_Key, "Seed", "The seed fed into the random generator", std::mt19937::default_seed)); - params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "_K_Medoids_Seed_Value_")); + params.insert(std::make_unique>(k_SeedValue_Key, "Seed Value", "The seed fed into the random generator", std::mt19937::default_seed)); + params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "KMedoids SeedValue")); params.insertSeparator(Parameters::Separator{"Input Parameters"}); params.insertLinkableParameter(std::make_unique(k_UseMask_Key, "Use Mask", "Specifies whether or not to use a mask array", false)); diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/PointSampleTriangleGeometryFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/PointSampleTriangleGeometryFilter.cpp index 04ba29eb9a..06d2b7afda 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/PointSampleTriangleGeometryFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/PointSampleTriangleGeometryFilter.cpp @@ -55,8 +55,8 @@ Parameters PointSampleTriangleGeometryFilter::parameters() const params.insertSeparator(Parameters::Separator{"Seeded Randomness"}); params.insertLinkableParameter(std::make_unique(k_UseSeed_Key, "Use Seed for Random Generation", "When true the user will be able to put in a seed for random generation", false)); - params.insert(std::make_unique>(k_SeedValue_Key, "Seed", "The seed fed into the random generator", std::mt19937::default_seed)); - params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "_Point_Sample_Triangle_Geometry_Seed_Value_")); + params.insert(std::make_unique>(k_SeedValue_Key, "Seed Value", "The seed fed into the random generator", std::mt19937::default_seed)); + params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "PointSampleTriangleGeometry SeedValue")); params.insertSeparator(Parameters::Separator{"Input Parameters"}); // Create the parameter descriptors that are needed for this filter diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/UncertainRegularGridSampleSurfaceMeshFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/UncertainRegularGridSampleSurfaceMeshFilter.cpp index 12162b3866..392607ced4 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/UncertainRegularGridSampleSurfaceMeshFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/UncertainRegularGridSampleSurfaceMeshFilter.cpp @@ -47,7 +47,7 @@ std::string UncertainRegularGridSampleSurfaceMeshFilter::humanName() const //------------------------------------------------------------------------------ std::vector UncertainRegularGridSampleSurfaceMeshFilter::defaultTags() const { - return {className(), "Sampling", "Spacing"}; + return {className(), "Sampling", "Spacing", "Surface Mesh", "Grid Interpolation"}; } //------------------------------------------------------------------------------ @@ -58,9 +58,9 @@ Parameters UncertainRegularGridSampleSurfaceMeshFilter::parameters() const // Create the parameter descriptors that are needed for this filter params.insertSeparator(Parameters::Separator{"Seeded Randomness"}); params.insertLinkableParameter(std::make_unique(k_UseSeed_Key, "Use Seed for Random Generation", "When true the user will be able to put in a seed for random generation", false)); - params.insert(std::make_unique>(k_SeedValue_Key, "Seed", "The seed fed into the random generator", std::mt19937::default_seed)); - params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", - "_Uncertain_Regular_Grid_Sample_Surface_Mesh_Seed_Value_")); + params.insert(std::make_unique>(k_SeedValue_Key, "Seed Value", "The seed fed into the random generator", std::mt19937::default_seed)); + params.insert( + std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "UncertainRegularGridSampleSurfaceMesh SeedValue")); params.insertSeparator(Parameters::Separator{"Input Parameters"}); params.insert(std::make_unique(k_Dimensions_Key, "Number of Cells per Axis", "The dimensions of the created Image geometry", std::vector{128, 128, 128}, @@ -83,6 +83,9 @@ Parameters UncertainRegularGridSampleSurfaceMeshFilter::parameters() const params.insert(std::make_unique(k_CellAMName_Key, "Cell Data Name", "The name for the cell data Attribute Matrix within the Image geometry", "Cell Data")); params.insert(std::make_unique(k_FeatureIdsArrayName_Key, "Feature Ids Name", "The name for the feature ids array in cell data Attribute Matrix", "Feature Ids")); + // Associate the Linkable Parameter(s) to the children parameters that they control + params.linkParameters(k_UseSeed_Key, k_SeedValue_Key, true); + return params; } diff --git a/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/Algorithms/EBSDSegmentFeatures.cpp b/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/Algorithms/EBSDSegmentFeatures.cpp index b6672dbe88..e4663fc758 100644 --- a/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/Algorithms/EBSDSegmentFeatures.cpp +++ b/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/Algorithms/EBSDSegmentFeatures.cpp @@ -52,10 +52,11 @@ Result<> EBSDSegmentFeatures::operator()() return {nonstd::make_unexpected(std::vector{Error{-87000, "The number of Features was 0 or 1 which means no Features were detected. A threshold value may be set too high"}})}; } - // By default we randomize grains + // Randomize the feature Ids for purely visual clarify. Having random Feature Ids + // allows users visualizing the data to better discern each grain otherwise the coloring + // would look like a smooth gradient. This is a user input parameter if(m_InputValues->shouldRandomizeFeatureIds) { - // Generate the random voxel indices that will be used for the seed points to start a new grain growth/agglomeration auto totalPoints = m_QuatsArray->getNumberOfTuples(); const int64 rangeMin = 0; diff --git a/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/MergeTwinsFilter.cpp b/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/MergeTwinsFilter.cpp index 9af18c4530..d679fccb6b 100644 --- a/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/MergeTwinsFilter.cpp +++ b/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/MergeTwinsFilter.cpp @@ -57,8 +57,8 @@ Parameters MergeTwinsFilter::parameters() const // Create the parameter descriptors that are needed for this filter params.insertSeparator(Parameters::Separator{"Seeded Randomness"}); params.insertLinkableParameter(std::make_unique(k_UseSeed_Key, "Use Seed for Random Generation", "When true the user will be able to put in a seed for random generation", false)); - params.insert(std::make_unique>(k_SeedValue_Key, "Seed", "The seed fed into the random generator", std::mt19937::default_seed)); - params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "_Merge_Twins_Seed_Value_")); + params.insert(std::make_unique>(k_SeedValue_Key, "Seed Value", "The seed fed into the random generator", std::mt19937::default_seed)); + params.insert(std::make_unique(k_SeedArrayName_Key, "Stored Seed Value Array Name", "Name of array holding the seed value", "MergeTwins SeedValue")); params.insertSeparator(Parameters::Separator{"Input Parameters"}); params.insertLinkableParameter(std::make_unique(k_UseNonContiguousNeighbors_Key, "Use Non-Contiguous Neighbors",