Skip to content

Commit 2b33dd8

Browse files
imikejacksonimikejackson
committed
BUG: Implement parameter descriptions (#10)
Each parameter should have a help text filled in.
1 parent 3269a4e commit 2b33dd8

9 files changed

+110
-95
lines changed

‎.github/workflows/windows.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ jobs:
5757
cmake --preset ci-windows-${{matrix.toolset}} -T ${{matrix.toolset}} -DSIMPLNX_EXTRA_PLUGINS="SimplnxReview" -DSIMPLNX_PLUGIN_ENABLE_SimplnxReview=ON -DSIMPLNX_SimplnxReview_SOURCE_DIR=${{github.workspace}} ${{github.workspace}}/../../simplnx
5858
- name: Build
5959
run: |
60-
cmake --build --preset ci-windows-${{matrix.toolset}}
60+
cmake --build ${{github.workspace}}/../../simplnx/build --config Release
6161
- name: Test
6262
run: |
6363
ctest --output-on-failure --test-dir ${{github.workspace}}/../../simplnx/build --build-config Release

‎src/SimplnxReview/Filters/ComputeGroupingDensityFilter.cpp‎

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -57,28 +57,36 @@ Parameters ComputeGroupingDensityFilter::parameters() const
5757
{
5858
Parameters params;
5959
// Create the parameter descriptors that are needed for this filter
60-
params.insertSeparator(Parameters::Separator{"Input Feature Data"});
60+
params.insertSeparator(Parameters::Separator{"Input Parameter(s)"});
61+
params.insertLinkableParameter(std::make_unique<BoolParameter>(k_FindCheckedFeatures_Key, "Find Checked Features", "Find checked features", false));
6162

62-
params.insert(std::make_unique<ArraySelectionParameter>(k_VolumesPath_Key, "Volumes", "", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::float32},
63-
ArraySelectionParameter::AllowedComponentShapes{{1}}));
64-
params.insert(std::make_unique<NeighborListSelectionParameter>(k_ContiguousNLPath_Key, "Contiguous Neighbor List", "", DataPath{}, NeighborListSelectionParameter::AllowedTypes{DataType::int32}));
65-
params.insertLinkableParameter(std::make_unique<BoolParameter>(k_UseNonContiguousNeighbors_Key, "Use Non-Contiguous Neighbors", "", false));
66-
params.insert(
67-
std::make_unique<NeighborListSelectionParameter>(k_NonContiguousNLPath_Key, "Non-Contiguous Neighbor List", "", DataPath{}, NeighborListSelectionParameter::AllowedTypes{DataType::int32}));
68-
params.insert(std::make_unique<ArraySelectionParameter>(k_ParentIdsPath_Key, "Parent Ids", "", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::int32},
63+
params.insertSeparator(Parameters::Separator{"Input Cell Data"});
64+
params.insert(std::make_unique<ArraySelectionParameter>(k_ParentIdsPath_Key, "Parent Ids", "Input Cell level ParentIds", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::int32},
6965
ArraySelectionParameter::AllowedComponentShapes{{1}}));
7066

71-
params.insertSeparator(Parameters::Separator{"Input Parent Data"});
72-
params.insert(std::make_unique<ArraySelectionParameter>(k_ParentVolumesPath_Key, "Parent Volumes", "", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::float32},
73-
ArraySelectionParameter::AllowedComponentShapes{{1}}));
67+
params.insertSeparator(Parameters::Separator{"Input Feature Data"});
68+
params.insert(std::make_unique<ArraySelectionParameter>(k_VolumesArrayPath_Key, "Volumes", "Input Feature Volumes Data Array", DataPath{},
69+
ArraySelectionParameter::AllowedTypes{nx::core::DataType::float32}, ArraySelectionParameter::AllowedComponentShapes{{1}}));
70+
71+
params.insert(std::make_unique<NeighborListSelectionParameter>(k_ContiguousNeighborListArrayPath_Key, "Contiguous Neighbor List", "List of contiguous neighbors for each Feature.", DataPath{},
72+
NeighborListSelectionParameter::AllowedTypes{DataType::int32}));
73+
74+
params.insert(std::make_unique<ArraySelectionParameter>(k_ParentVolumesPath_Key, "Parent Volumes", "Input feature level parent volume data array", DataPath{},
75+
ArraySelectionParameter::AllowedTypes{DataType::float32}, ArraySelectionParameter::AllowedComponentShapes{{1}}));
76+
77+
params.insertSeparator(Parameters::Separator{"Non-Contiguous Neighborhood Option"});
78+
params.insertLinkableParameter(std::make_unique<BoolParameter>(k_UseNonContiguousNeighbors_Key, "Use Non-Contiguous Neighbors", "Use non-contiguous neighborhoods for computations", false));
79+
params.insert(std::make_unique<NeighborListSelectionParameter>(k_NonContiguousNeighborListArrayPath_Key, "Non-Contiguous Neighborhoods", "Input feature level Non-Contiguous neighborhoods",
80+
DataPath{}, NeighborListSelectionParameter::AllowedTypes{DataType::int32}));
7481

7582
params.insertSeparator(Parameters::Separator{"Output Feature Data"});
76-
params.insertLinkableParameter(std::make_unique<BoolParameter>(k_FindCheckedFeatures_Key, "Find Checked Features", "", false));
77-
params.insert(std::make_unique<DataObjectNameParameter>(k_CheckedFeaturesName_Key, "Checked Features Name", "", "Checked Features"));
78-
params.insert(std::make_unique<DataObjectNameParameter>(k_GroupingDensitiesName_Key, "Grouping Densities Name", "", "Grouping Densities"));
83+
84+
params.insert(std::make_unique<DataObjectNameParameter>(k_CheckedFeaturesName_Key, "Checked Features Name", "Output feature level data array to hold 'Checked Features' values", "Checked Features"));
85+
params.insert(
86+
std::make_unique<DataObjectNameParameter>(k_GroupingDensitiesName_Key, "Grouping Densities Name", "Output feature level data array to hold 'Grouping Densities' values", "Grouping Densities"));
7987

8088
// Link params
81-
params.linkParameters(k_UseNonContiguousNeighbors_Key, k_NonContiguousNLPath_Key, true);
89+
params.linkParameters(k_UseNonContiguousNeighbors_Key, k_NonContiguousNeighborListArrayPath_Key, true);
8290
params.linkParameters(k_FindCheckedFeatures_Key, k_CheckedFeaturesName_Key, true);
8391

8492
return params;
@@ -102,12 +110,12 @@ IFilter::PreflightResult ComputeGroupingDensityFilter::preflightImpl(const DataS
102110
{
103111
auto pParentIdsPath = filterArgs.value<DataPath>(k_ParentIdsPath_Key);
104112
auto pParentVolumesPath = filterArgs.value<DataPath>(k_ParentVolumesPath_Key);
105-
auto pContiguousNLPath = filterArgs.value<DataPath>(k_ContiguousNLPath_Key);
106-
auto pVolumesPath = filterArgs.value<DataPath>(k_VolumesPath_Key);
113+
auto pContiguousNLPath = filterArgs.value<DataPath>(k_ContiguousNeighborListArrayPath_Key);
114+
auto pVolumesPath = filterArgs.value<DataPath>(k_VolumesArrayPath_Key);
107115
auto pGroupingDensitiesName = filterArgs.value<std::string>(k_GroupingDensitiesName_Key);
108116

109117
auto pUseNonContiguousNeighbors = filterArgs.value<bool>(k_UseNonContiguousNeighbors_Key);
110-
auto pNonContiguousNLPath = filterArgs.value<DataPath>(k_NonContiguousNLPath_Key);
118+
auto pNonContiguousNLPath = filterArgs.value<DataPath>(k_NonContiguousNeighborListArrayPath_Key);
111119
auto pFindCheckedFeatures = filterArgs.value<bool>(k_FindCheckedFeatures_Key);
112120
auto pCheckedFeaturesName = filterArgs.value<std::string>(k_CheckedFeaturesName_Key);
113121

@@ -177,14 +185,14 @@ Result<> ComputeGroupingDensityFilter::executeImpl(DataStructure& dataStructure,
177185

178186
inputValues.ParentIdsPath = filterArgs.value<DataPath>(k_ParentIdsPath_Key);
179187
inputValues.ParentVolumesPath = filterArgs.value<DataPath>(k_ParentVolumesPath_Key);
180-
inputValues.ContiguousNLPath = filterArgs.value<DataPath>(k_ContiguousNLPath_Key);
181-
inputValues.VolumesPath = filterArgs.value<DataPath>(k_VolumesPath_Key);
188+
inputValues.ContiguousNLPath = filterArgs.value<DataPath>(k_ContiguousNeighborListArrayPath_Key);
189+
inputValues.VolumesPath = filterArgs.value<DataPath>(k_VolumesArrayPath_Key);
182190
inputValues.GroupingDensitiesPath = inputValues.ParentVolumesPath.replaceName(filterArgs.value<std::string>(k_GroupingDensitiesName_Key));
183191

184192
inputValues.UseNonContiguousNeighbors = filterArgs.value<bool>(k_UseNonContiguousNeighbors_Key);
185193
if(inputValues.UseNonContiguousNeighbors)
186194
{
187-
inputValues.NonContiguousNLPath = filterArgs.value<DataPath>(k_NonContiguousNLPath_Key);
195+
inputValues.NonContiguousNLPath = filterArgs.value<DataPath>(k_NonContiguousNeighborListArrayPath_Key);
188196
}
189197
else
190198
{

‎src/SimplnxReview/Filters/ComputeGroupingDensityFilter.hpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ class SIMPLNXREVIEW_EXPORT ComputeGroupingDensityFilter : public IFilter
2424
ComputeGroupingDensityFilter& operator=(ComputeGroupingDensityFilter&&) noexcept = delete;
2525

2626
// Parameter Keys
27-
static inline constexpr StringLiteral k_VolumesPath_Key = "volumes_path";
28-
static inline constexpr StringLiteral k_ContiguousNLPath_Key = "contiguous_neighbor_list_path";
27+
static inline constexpr StringLiteral k_VolumesArrayPath_Key = "volumes_path";
28+
static inline constexpr StringLiteral k_ContiguousNeighborListArrayPath_Key = "contiguous_neighbor_list_path";
2929
static inline constexpr StringLiteral k_UseNonContiguousNeighbors_Key = "use_non_contiguous_neighbors";
30-
static inline constexpr StringLiteral k_NonContiguousNLPath_Key = "non_contiguous_neighbor_list_path";
30+
static inline constexpr StringLiteral k_NonContiguousNeighborListArrayPath_Key = "non_contiguous_neighbor_list_path";
3131
static inline constexpr StringLiteral k_ParentIdsPath_Key = "parent_ids_path";
3232
static inline constexpr StringLiteral k_ParentVolumesPath_Key = "parent_volumes_path";
3333
static inline constexpr StringLiteral k_FindCheckedFeatures_Key = "find_checked_features";

‎src/SimplnxReview/Filters/ComputeLocalAverageCAxisMisalignmentsFilter.cpp‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -62,24 +62,28 @@ Parameters ComputeLocalAverageCAxisMisalignmentsFilter::parameters() const
6262

6363
// Create the parameter descriptors that are needed for this filter
6464
params.insertSeparator(Parameters::Separator{"Input Parameter(s)"});
65-
params.insertLinkableParameter(std::make_unique<BoolParameter>(k_CalcUnbiasedAvg_Key, "Calculate Unbiased Local C-Axis Misalignments", "", false));
66-
params.insertLinkableParameter(std::make_unique<BoolParameter>(k_CalcBiasedAvg_Key, "Calculate Local C-Axis Misalignments", "", false));
65+
params.insertLinkableParameter(std::make_unique<BoolParameter>(k_CalcUnbiasedAvg_Key, "Calculate Unbiased Local C-Axis Mis-alignments", "Calculate Unbiased Local C-Axis Mis-alignments", false));
66+
params.insertLinkableParameter(std::make_unique<BoolParameter>(k_CalcBiasedAvg_Key, "Calculate Local C-Axis Mis-alignments", "Calculate Local C-Axis Mis-alignments", false));
6767

6868
params.insertSeparator(Parameters::Separator{"Input Feature Data"});
69-
params.insert(std::make_unique<ArraySelectionParameter>(k_FeatureParentIdsPath_Key, "Feature Parent Ids", "", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::int32},
70-
ArraySelectionParameter::AllowedComponentShapes{{1}}));
71-
params.insert(std::make_unique<NeighborListSelectionParameter>(k_NeighborListPath_Key, "Neighbor List", "", DataPath{}, NeighborListSelectionParameter::AllowedTypes{DataType::int32}));
69+
params.insert(std::make_unique<ArraySelectionParameter>(k_FeatureParentIdsPath_Key, "Feature Parent Ids", "Input feature based ParentIds data array", DataPath{},
70+
ArraySelectionParameter::AllowedTypes{DataType::int32}, ArraySelectionParameter::AllowedComponentShapes{{1}}));
7271
params.insert(
73-
std::make_unique<NeighborListSelectionParameter>(k_CAxisMisalignmentListPath_Key, "C-Axis Misalignment List", "", DataPath{}, NeighborListSelectionParameter::AllowedTypes{DataType::float32}));
74-
params.insert(std::make_unique<ArraySelectionParameter>(k_AvgCAxisMisalignmentsPath_Key, "Average C-Axis Misalignments", "", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::int32},
75-
ArraySelectionParameter::AllowedComponentShapes{{1}}));
72+
std::make_unique<NeighborListSelectionParameter>(k_NeighborListPath_Key, "Neighbor List", "Feature based Neighbors", DataPath{}, NeighborListSelectionParameter::AllowedTypes{DataType::int32}));
73+
params.insert(std::make_unique<NeighborListSelectionParameter>(k_CAxisMisalignmentListPath_Key, "C-Axis Mis-alignment NeighborList", "Input feature based C-Axis Mis-alignment NeighborList",
74+
DataPath{}, NeighborListSelectionParameter::AllowedTypes{DataType::float32}));
75+
params.insert(std::make_unique<ArraySelectionParameter>(k_AvgCAxisMisalignmentsPath_Key, "Average C-Axis Mis-alignments", "Input feature based Average C-Axis Mis-alignments", DataPath{},
76+
ArraySelectionParameter::AllowedTypes{DataType::int32}, ArraySelectionParameter::AllowedComponentShapes{{1}}));
7677

7778
params.insertSeparator(Parameters::Separator{"Output Feature Data"});
78-
params.insert(std::make_unique<DataGroupSelectionParameter>(k_NewCellFeatureAttributeMatrixPath_Key, "New Cell Feature Attribute Matrix Name", "", DataPath{},
79-
DataGroupSelectionParameter::AllowedTypes{BaseGroup::GroupType::AttributeMatrix}));
80-
params.insert(std::make_unique<DataObjectNameParameter>(k_NumFeaturesPerParentName_Key, "Number of Features Per Parent Array Name", "", "NumFeaturesPerParent"));
81-
params.insert(std::make_unique<DataObjectNameParameter>(k_LocalCAxisMisalignmentsName_Key, "Local C-Axis Misalignments Array Name", "", "LocalCAxisMisalignments"));
82-
params.insert(std::make_unique<DataObjectNameParameter>(k_UnbiasedLocalCAxisMisalignmentsName_Key, "Unbiased Local CAxis Misalignments Array Name", "", "UnbiasedLocalCAxisMisalignments"));
79+
params.insert(std::make_unique<DataGroupSelectionParameter>(k_NewCellFeatureAttributeMatrixPath_Key, "New Feature Attribute Matrix Name", "Output Feature Attribute Matrix to hold results",
80+
DataPath{}, DataGroupSelectionParameter::AllowedTypes{BaseGroup::GroupType::AttributeMatrix}));
81+
params.insert(std::make_unique<DataObjectNameParameter>(k_NumFeaturesPerParentName_Key, "Number of Features Per Parent Array Name", "Output feature data array to hold number of features per parent",
82+
"NumFeaturesPerParent"));
83+
params.insert(std::make_unique<DataObjectNameParameter>(k_LocalCAxisMisalignmentsName_Key, "Local C-Axis Mis-alignments Array Name",
84+
"Output feature data array to hold the local c-axis mis-alignments", "LocalCAxisMisalignments"));
85+
params.insert(std::make_unique<DataObjectNameParameter>(k_UnbiasedLocalCAxisMisalignmentsName_Key, "Unbiased Local CAxis Mis-alignments Array Name",
86+
"Output feature data array to hold the unbiased local c-axis mis-alignments", "UnbiasedLocalCAxisMisalignments"));
8387

8488
// Associate the Linkable Parameter(s) to the children parameters that they control
8589
params.linkParameters(k_CalcBiasedAvg_Key, k_LocalCAxisMisalignmentsName_Key, true);
@@ -124,7 +128,7 @@ IFilter::PreflightResult ComputeLocalAverageCAxisMisalignmentsFilter::preflightI
124128

125129
if(!pCalcBiasedAvgValue && !pCalcUnbiasedAvgValue)
126130
{
127-
return MakePreflightErrorResult(-43160, "Since both Calculate Local C-Axis Misalignments and Calculate Unbiased Local C-Axis Misalignments are false, nothing will be done in this filter, "
131+
return MakePreflightErrorResult(-43160, "Since both Calculate Local C-Axis Mis-alignments and Calculate Unbiased Local C-Axis Misalignments are false, nothing will be done in this filter, "
128132
"consider making one or both true or remove filter from pipeline.");
129133
}
130134

‎src/SimplnxReview/Filters/ComputeMicroTextureRegionsFilter.cpp‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#include "simplnx/DataStructure/DataPath.hpp"
77
#include "simplnx/Filter/Actions/CreateArrayAction.hpp"
88
#include "simplnx/Parameters/ArraySelectionParameter.hpp"
9-
#include "simplnx/Parameters/DataGroupSelectionParameter.hpp"
9+
#include "simplnx/Parameters/DataGroupCreationParameter.hpp"
1010
#include "simplnx/Parameters/DataObjectNameParameter.hpp"
1111
#include "simplnx/Parameters/GeometrySelectionParameter.hpp"
1212

@@ -51,14 +51,18 @@ Parameters ComputeMicroTextureRegionsFilter::parameters() const
5151

5252
// Create the parameter descriptors that are needed for this filter
5353
params.insertSeparator(Parameters::Separator{"Input Data"});
54-
params.insert(std::make_unique<GeometrySelectionParameter>(k_ImageGeomPath_Key, "Selected Image Geometry", "", DataPath{}, GeometrySelectionParameter::AllowedTypes{IGeometry::Type::Image}));
55-
params.insert(std::make_unique<ArraySelectionParameter>(k_FeatureIdsArrayPath_Key, "Cell Feature Ids", "", DataPath{}, nx::core::GetAllDataTypes()));
56-
57-
params.insertSeparator(Parameters::Separator{"Output Data Object(s)"});
58-
params.insert(std::make_unique<DataGroupSelectionParameter>(k_CellFeatureAttributeMatrixPath_Key, "Parent Cell Feature Attribute Matrix", "", DataPath{},
59-
DataGroupSelectionParameter::AllowedTypes{BaseGroup::GroupType::AttributeMatrix}));
60-
params.insert(std::make_unique<DataObjectNameParameter>(k_MicroTextureRegionNumCellsArrayName_Key, "Micro Texture Region Number of Cells Array Name", "", "MT Region Number of Cells"));
61-
params.insert(std::make_unique<DataObjectNameParameter>(k_MicroTextureRegionFractionOccupiedArrayName_Key, "Micro Texture Region Fraction Occupied Array Name", "", "MT Region Fraction Occupied"));
54+
params.insert(
55+
std::make_unique<GeometrySelectionParameter>(k_ImageGeomPath_Key, "Image Geometry", "The selected image geometry", DataPath{}, GeometrySelectionParameter::AllowedTypes{IGeometry::Type::Image}));
56+
params.insert(std::make_unique<ArraySelectionParameter>(k_FeatureIdsArrayPath_Key, "Cell Feature Ids", "Data Array that specifies to which Feature each Element belongs", DataPath{},
57+
ArraySelectionParameter::AllowedTypes{DataType::int32}, ArraySelectionParameter::AllowedComponentShapes{{1}}));
58+
params.insert(std::make_unique<DataGroupSelectionParameter>(k_CellFeatureAttributeMatrixPath_Key, "Parent Feature Attribute Matrix", "Input Feature Attribute Matrix for microtexture regions",
59+
DataPath{}, DataGroupSelectionParameter::AllowedTypes{BaseGroup::GroupType::AttributeMatrix}));
60+
61+
params.insertSeparator(Parameters::Separator{"Output Feature Data"});
62+
params.insert(std::make_unique<DataObjectNameParameter>(k_MicroTextureRegionNumCellsArrayName_Key, "Micro Texture Region Number of Cells Array Name",
63+
"Output Number of cells per microtexture region", "MT Region Number of Cells"));
64+
params.insert(std::make_unique<DataObjectNameParameter>(k_MicroTextureRegionFractionOccupiedArrayName_Key, "Micro Texture Region Fraction Occupied Array Name",
65+
"Output Region Fraction occupied data array", "MT Region Fraction Occupied"));
6266

6367
return params;
6468
}

‎src/SimplnxReview/Filters/ComputeSaltykovSizesFilter.cpp‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,12 @@ Parameters ComputeSaltykovSizesFilter::parameters() const
5757
params.insert(std::make_unique<NumberParameter<uint64>>(k_SeedValue_Key, "Seed", "The seed fed into the random generator", std::mt19937::default_seed));
5858

5959
params.insertSeparator(Parameters::Separator{"Input Feature Data"});
60-
params.insert(std::make_unique<ArraySelectionParameter>(k_EquivalentDiametersArrayPath_Key, "Equivalent Diameters", "", DataPath{}, ArraySelectionParameter::AllowedTypes{DataType::float32},
61-
ArraySelectionParameter::AllowedComponentShapes{{1}}));
60+
params.insert(std::make_unique<ArraySelectionParameter>(k_EquivalentDiametersArrayPath_Key, "Equivalent Diameters", "Input feature based Equivalent Diameters", DataPath{},
61+
ArraySelectionParameter::AllowedTypes{DataType::float32}, ArraySelectionParameter::AllowedComponentShapes{{1}}));
6262

6363
params.insertSeparator(Parameters::Separator{"Output Feature Data"});
64-
params.insert(std::make_unique<DataObjectNameParameter>(k_SaltykovEquivalentDiametersName_Key, "Saltykov Equivalent Diameters Name", "", "Saltykov Equivalent Diameters"));
64+
params.insert(std::make_unique<DataObjectNameParameter>(k_SaltykovEquivalentDiametersName_Key, "Saltykov Equivalent Diameters Name", "Output feature based Equivalent Diameters data array",
65+
"Saltykov Equivalent Diameters"));
6566

6667
return params;
6768
}

0 commit comments

Comments
 (0)