From 287b427e61e05b3d78702af879387d7d23e08155 Mon Sep 17 00:00:00 2001 From: Michael Jackson Date: Fri, 6 Oct 2023 09:46:36 -0400 Subject: [PATCH] DOC: Small documentation fixes. (#732) Signed-off-by: Michael Jackson --- .../src/ComplexCore/Filters/FindFeatureClusteringFilter.cpp | 4 ++-- .../ComplexCore/src/ComplexCore/Filters/KMeansFilter.cpp | 1 - .../ComplexCore/src/ComplexCore/Filters/KMedoidsFilter.cpp | 2 -- .../src/ITKImageProcessing/Filters/ITKMhaFileReader.cpp | 2 +- .../Filters/FindSlipTransmissionMetricsFilter.cpp | 2 +- .../src/OrientationAnalysis/Filters/GenerateFZQuaternions.cpp | 2 +- 6 files changed, 5 insertions(+), 8 deletions(-) diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/FindFeatureClusteringFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/FindFeatureClusteringFilter.cpp index ffab7e3d70..c733c0781d 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/FindFeatureClusteringFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/FindFeatureClusteringFilter.cpp @@ -77,10 +77,10 @@ Parameters FindFeatureClusteringFilter::parameters() const params.insertSeparator(Parameters::Separator{"Cell Ensemble Data"}); params.insert(std::make_unique(k_CellEnsembleAttributeMatrixName_Key, "Cell Ensemble Attribute Matrix", "The path to the cell ensemble attribute matrix where the RDF and RDF min and max distance arrays will be stored", DataPath{})); - params.insertSeparator(Parameters::Separator{"Cell Feature Data"}); + params.insertSeparator(Parameters::Separator{"Created Cell Feature Data"}); params.insert( std::make_unique(k_ClusteringListArrayName_Key, "Clustering List", "Distance of each Features's centroid to ever other Features's centroid", "ClusteringList")); - params.insertSeparator(Parameters::Separator{"Cell Ensemble Data"}); + params.insertSeparator(Parameters::Separator{"Created Cell Ensemble Data"}); params.insert(std::make_unique(k_RDFArrayName_Key, "Radial Distribution Function", "A histogram of the normalized frequency at each bin", "RDF")); params.insert(std::make_unique(k_MaxMinArrayName_Key, "Max and Min Separation Distances", "The max and min distance found between Features", "RDFMaxMinDistances")); // Associate the Linkable Parameter(s) to the children parameters that they control diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMeansFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMeansFilter.cpp index 25e471c9f0..e16c93e094 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMeansFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMeansFilter.cpp @@ -71,7 +71,6 @@ Parameters KMeansFilter::parameters() const params.insert(std::make_unique(k_MaskArrayPath_Key, "Mask", "DataPath to the boolean mask array. Values that are true will mark that cell/point as usable.", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::boolean})); - params.insertSeparator(Parameters::Separator{"Input Parameters"}); params.insert(std::make_unique(k_InitClusters_Key, "Number of Clusters", "This will be the tuple size for Cluster Attribute Matrix and the values within", 0)); params.insert( std::make_unique(k_DistanceMetric_Key, "Distance Metric", "Distance Metric type to be used for calculations", to_underlying(KUtilities::DistanceMetric::Euclidean), diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMedoidsFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMedoidsFilter.cpp index f93e2ab1f0..79f3c449aa 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMedoidsFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/KMedoidsFilter.cpp @@ -70,8 +70,6 @@ Parameters KMedoidsFilter::parameters() const params.insertLinkableParameter(std::make_unique(k_UseMask_Key, "Use Mask", "Specifies whether or not to use a mask array", false)); params.insert(std::make_unique(k_MaskArrayPath_Key, "Mask", "DataPath to the boolean mask array. Values that are true will mark that cell/point as usable.", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::boolean})); - - params.insertSeparator(Parameters::Separator{"Input Parameters"}); params.insert(std::make_unique(k_InitClusters_Key, "Number of Clusters", "This will be the tuple size for Cluster Attribute Matrix and the values within", 0)); params.insert( std::make_unique(k_DistanceMetric_Key, "Distance Metric", "Distance Metric type to be used for calculations", to_underlying(KUtilities::DistanceMetric::Euclidean), diff --git a/src/Plugins/ITKImageProcessing/src/ITKImageProcessing/Filters/ITKMhaFileReader.cpp b/src/Plugins/ITKImageProcessing/src/ITKImageProcessing/Filters/ITKMhaFileReader.cpp index 09d48d9d81..066237fdf5 100644 --- a/src/Plugins/ITKImageProcessing/src/ITKImageProcessing/Filters/ITKMhaFileReader.cpp +++ b/src/Plugins/ITKImageProcessing/src/ITKImageProcessing/Filters/ITKMhaFileReader.cpp @@ -209,7 +209,7 @@ Parameters ITKMhaFileReader::parameters() const { Parameters params; - params.insertSeparator(Parameters::Separator{"Filter Parameters"}); + params.insertSeparator(Parameters::Separator{"Input Parameters"}); params.insert(std::make_unique(ITKImageReader::k_FileName_Key, "Input MHA File", "The input .mha file that will be read.", fs::path(""), FileSystemPathParameter::ExtensionsType{{".mha"}}, FileSystemPathParameter::PathType::InputFile, false)); params.insertLinkableParameter( diff --git a/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/FindSlipTransmissionMetricsFilter.cpp b/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/FindSlipTransmissionMetricsFilter.cpp index 38d69f5aed..7bfbfdc117 100644 --- a/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/FindSlipTransmissionMetricsFilter.cpp +++ b/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/FindSlipTransmissionMetricsFilter.cpp @@ -64,7 +64,7 @@ Parameters FindSlipTransmissionMetricsFilter::parameters() const params.insert(std::make_unique(k_CrystalStructuresArrayPath_Key, "Crystal Structures", "Enumeration representing the crystal structure for each phase", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::uint32}, ArraySelectionParameter::AllowedComponentShapes{{1}})); - params.insertSeparator(Parameters::Separator{"Feature Data"}); + params.insertSeparator(Parameters::Separator{"Created Feature Data"}); params.insert(std::make_unique(k_F1ListArrayName_Key, "F1 List", "DataArray Name to store the calculated F1s Values", "F1 List")); params.insert(std::make_unique(k_F1sptListArrayName_Key, "F1spt List", "DataArray Name to store the calculated F1spts Values", "F1spt List")); params.insert(std::make_unique(k_F7ListArrayName_Key, "F7 List", "DataArray Name to store the calculated F7s Values", "F7 List")); diff --git a/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/GenerateFZQuaternions.cpp b/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/GenerateFZQuaternions.cpp index dabd22418c..798ea2d03f 100644 --- a/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/GenerateFZQuaternions.cpp +++ b/src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/GenerateFZQuaternions.cpp @@ -162,7 +162,7 @@ Parameters GenerateFZQuaternions::parameters() const params.insert(std::make_unique(k_CrystalStructuresArrayPath_Key, "Crystal Structures", "Enumeration representing the crystal structure for each Ensemble", DataPath({"Ensemble Data", "CrystalStructures"}), ArraySelectionParameter::AllowedTypes{DataType::uint32}, ArraySelectionParameter::AllowedComponentShapes{{1}})); - params.insertSeparator(Parameters::Separator{"Element Data"}); + params.insertSeparator(Parameters::Separator{"Created Element Data"}); params.insert(std::make_unique(k_FZQuatsArrayPath_Key, "Created FZ Quaternions", "The name of the array containing the Quaternion that represents an orientation within the fundamental zone for each Element", "")); // Associate the Linkable Parameter(s) to the children parameters that they control