Skip to content

Commit

Permalink
ENH: All filter's class names end with "Filter". (#931)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
  • Loading branch information
imikejackson committed Apr 29, 2024
1 parent 7f055a5 commit 3de11c6
Show file tree
Hide file tree
Showing 832 changed files with 8,948 additions and 8,686 deletions.
2 changes: 1 addition & 1 deletion conda/meta.yaml
@@ -1,5 +1,5 @@
{% set name = "simplnx" %}
{% set version = "1.3.0" %}
{% set version = "1.4.0" %}

package:
name: {{ name|lower }}
Expand Down
2 changes: 1 addition & 1 deletion conda/recipe.yaml
@@ -1,5 +1,5 @@
context:
version: "1.3.0"
version: "1.4.0"
name: simplnx

package:
Expand Down
4 changes: 2 additions & 2 deletions docs/Porting_Filters.md
Expand Up @@ -154,7 +154,7 @@ of how to perform this transfer of data.
There are several classes that can be used to help the developer write parallel algorithms.
`simplnx/Utilities/ParallelAlgorithm` and `simplnx/Utilities/ParallelTaskAlgorithm` are the two main classes depending
on the situation. `AlignSections.cpp` and `CropImageGeometry.cpp` both use a task based
on the situation. `AlignSections.cpp` and `CropImageGeometryFilter.cpp` both use a task based
parallelism. `RotateSampleRefFrameFilter.cpp` shows an example
of using ParallelData3DAlgorithm.
Expand Down Expand Up @@ -258,4 +258,4 @@ these should be used as needed by the filter.

## Processing a Geometry In Place

Sometimes a filter needs allow the user to process it's geometry "in place" in order to ease the number of filters that are needed to remove temporary DataObjects. If your filter needs this kind of capability, then take a look at the "CropImageGeometry" or "RotateSampleRefFrame" filters.
Sometimes a filter needs allow the user to process it's geometry "in place" in order to ease the number of filters that are needed to remove temporary DataObjects. If your filter needs this kind of capability, then take a look at the "CropImageGeometryFilter" or "RotateSampleRefFrame" filters.
4 changes: 2 additions & 2 deletions pipelines/Combo-EBSD-osc_r0c0.d3dpipeline
Expand Up @@ -278,7 +278,7 @@
},
"comments": "",
"filter": {
"name": "simplnx::ConditionalSetValue",
"name": "simplnx::ConditionalSetValueFilter",
"uuid": "bad9b7bd-1dc9-4f21-a889-6520e7a41881"
},
"isDisabled": false
Expand Down Expand Up @@ -344,7 +344,7 @@
},
"comments": "",
"filter": {
"name": "simplnx::FindNeighbors",
"name": "simplnx::FindNeighborsFilter",
"uuid": "7177e88c-c3ab-4169-abe9-1fdaff20e598"
},
"isDisabled": false
Expand Down
8 changes: 4 additions & 4 deletions pipelines/PorosityAnalysis.d3dpipeline
Expand Up @@ -108,7 +108,7 @@
},
"comments": "",
"filter": {
"name": "simplnx::CopyFeatureArrayToElementArray",
"name": "simplnx::CopyFeatureArrayToElementArrayFilter",
"uuid": "4c8c976a-993d-438b-bd8e-99f71114b9a1"
},
"isDisabled": false
Expand All @@ -129,7 +129,7 @@
},
"comments": "",
"filter": {
"name": "simplnx::CreateDataArray",
"name": "simplnx::CreateDataArrayFilter",
"uuid": "67041f9b-bdc6-4122-acc6-c9fe9280e90d"
},
"isDisabled": false
Expand All @@ -144,7 +144,7 @@
},
"comments": "",
"filter": {
"name": "simplnx::ConditionalSetValue",
"name": "simplnx::ConditionalSetValueFilter",
"uuid": "bad9b7bd-1dc9-4f21-a889-6520e7a41881"
},
"isDisabled": false
Expand Down Expand Up @@ -212,7 +212,7 @@
},
"comments": "",
"filter": {
"name": "simplnx::DeleteData",
"name": "simplnx::DeleteDataFilter",
"uuid": "bf286740-e987-49fe-a7c8-6e566e3a0606"
},
"isDisabled": false
Expand Down
4 changes: 2 additions & 2 deletions scripts/filter.cpp.in
Expand Up @@ -45,15 +45,15 @@ IFilter::UniquePointer @FILTER_NAME@::clone() const
return std::make_unique<@FILTER_NAME@>();
}

IFilter::PreflightResult @FILTER_NAME@::preflightImpl(const DataStructure& data, const Arguments& args) const
IFilter::PreflightResult @FILTER_NAME@::preflightImpl(const DataStructure& dataStructure, const Arguments& args) const
{
/****************************************************************************
* Write any preflight sanity checking codes in this function
***************************************************************************/
return {};
}

Result<> @FILTER_NAME@::executeImpl(DataStructure& data, const Arguments& args) const
Result<> @FILTER_NAME@::executeImpl(DataStructure& dataStructure, const Arguments& args) const
{
/****************************************************************************
* Write your algorithm implementation in this function
Expand Down
4 changes: 2 additions & 2 deletions scripts/filter.hpp.in
Expand Up @@ -55,15 +55,15 @@ protected:
* @param args
* @return
*/
PreflightResult preflightImpl(const DataStructure& data, const Arguments& args) const override;
PreflightResult preflightImpl(const DataStructure& dataStructure, const Arguments& args) const override;

/**
* @brief
* @param data
* @param args
* @return
*/
Result<> executeImpl(DataStructure& data, const Arguments& args) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& args) const override;
};
} // namespace nx::core

Expand Down
2 changes: 1 addition & 1 deletion scripts/generate_simpl_conversion_code.py
Expand Up @@ -46,7 +46,7 @@ def create_filter_conversion(simpl_filter: SIMPLFilterInfo, complex_filter_name:
converter_code.append('\n')
converter_code.append(f'Result<Arguments> {complex_filter_name}::FromSIMPLJson(const nlohmann::json& json)\n')
converter_code.append('{\n')
converter_code.append(' Arguments args = CreateDataArray().getDefaultArguments();\n')
converter_code.append(' Arguments args = CreateDataArrayFilter().getDefaultArguments();\n')
converter_code.append('\n')
converter_code.append(' std::vector<Result<>> results;\n')
converter_code.append('\n')
Expand Down
40 changes: 20 additions & 20 deletions scripts/simpl_filters.json
Expand Up @@ -165,7 +165,7 @@
"uuid": "{738c8da9-45d0-53dd-aa54-3f3a337b70d7}"
},
{
"name": "AlignGeometries",
"name": "AlignGeometriesFilter",
"parameters": [
{
"name": "AlignmentType",
Expand Down Expand Up @@ -237,7 +237,7 @@
"uuid": "{c681caf4-22f2-5885-bbc9-a0476abc72eb}"
},
{
"name": "ApproximatePointCloudHull",
"name": "ApproximatePointCloudHullFilter",
"parameters": [
{
"name": "GridResolution",
Expand Down Expand Up @@ -747,7 +747,7 @@
"uuid": "{351c38c9-330d-599c-8632-19d74868be86}"
},
{
"name": "ExtractInternalSurfacesFromTriangleGeometry",
"name": "ExtractInternalSurfacesFromTriangleGeometryFilter",
"parameters": [
{
"name": "TriangleDataContainerName",
Expand Down Expand Up @@ -1135,7 +1135,7 @@
"uuid": "{6cc3148c-0bad-53b4-9568-ee1971cadb00}"
},
{
"name": "FindNeighborListStatistics",
"name": "FindNeighborListStatisticsFilter",
"parameters": [
{
"name": "FindLength",
Expand Down Expand Up @@ -2371,7 +2371,7 @@
"uuid": "{5a2b714e-bae9-5213-8171-d1e190609e2d}"
},
{
"name": "RemoveFlaggedVertices",
"name": "RemoveFlaggedVerticesFilter",
"parameters": [
{
"name": "VertexGeometry",
Expand All @@ -2389,7 +2389,7 @@
"uuid": "{379ccc67-16dd-530a-984f-177db2314bac}"
},
{
"name": "RobustAutomaticThreshold",
"name": "RobustAutomaticThresholdFilter",
"parameters": [
{
"name": "InputArrayPath",
Expand Down Expand Up @@ -8983,7 +8983,7 @@
"uuid": "{697ed3de-db33-5dd1-a64b-04fb71e7d63e}"
},
{
"name": "FindNeighbors",
"name": "FindNeighborsFilter",
"parameters": [
{
"name": "StoreBoundaryCells",
Expand Down Expand Up @@ -9402,7 +9402,7 @@
"uuid": "{52b2918a-4fb5-57aa-97d4-ccc084b89572}"
},
{
"name": "CropImageGeometry",
"name": "CropImageGeometryFilter",
"parameters": [
{
"name": "XMin",
Expand Down Expand Up @@ -11083,7 +11083,7 @@
"uuid": "{64d20c7b-697c-5ff1-9d1d-8a27b071f363}"
},
{
"name": "FindSurfaceFeatures",
"name": "FindSurfaceFeaturesFilter",
"parameters": [
{
"name": "",
Expand Down Expand Up @@ -11414,7 +11414,7 @@
"uuid": "{801008ce-1dcb-5604-8f16-a86526e28cf9}"
},
{
"name": "IdentifySample",
"name": "IdentifySampleFilter",
"parameters": [
{
"name": "FillHoles",
Expand All @@ -11432,7 +11432,7 @@
"uuid": "{0e8c0818-a3fb-57d4-a5c8-7cb8ae54a40a}"
},
{
"name": "MinNeighbors",
"name": "MinNeighborsFilter",
"parameters": [
{
"name": "MinNumNeighbors",
Expand Down Expand Up @@ -11637,7 +11637,7 @@
"uuid": "{334034e9-405f-51a3-9c3c-8d9c955835d9}"
},
{
"name": "ConditionalSetValue",
"name": "ConditionalSetValueFilter",
"parameters": [
{
"name": "ReplaceValue",
Expand Down Expand Up @@ -11707,7 +11707,7 @@
"uuid": "{f4ba5fa4-bb5c-5dd1-9429-0dd86d0ecb37}"
},
{
"name": "CopyFeatureArrayToElementArray",
"name": "CopyFeatureArrayToElementArrayFilter",
"parameters": [
{
"name": "",
Expand Down Expand Up @@ -11781,7 +11781,7 @@
"uuid": "{93375ef0-7367-5372-addc-baa019b1b341}"
},
{
"name": "CreateDataArray",
"name": "CreateDataArrayFilter",
"parameters": [
{
"name": "ScalarType",
Expand Down Expand Up @@ -11825,7 +11825,7 @@
"uuid": "{816fbe6b-7c38-581b-b149-3f839fb65b93}"
},
{
"name": "CreateFeatureArrayFromElementArray",
"name": "CreateFeatureArrayFromElementArrayFilter",
"parameters": [
{
"name": "",
Expand Down Expand Up @@ -12007,7 +12007,7 @@
"uuid": "{c5bb92df-c1bb-5e57-a2bf-280303a81935}"
},
{
"name": "CreateImageGeometry",
"name": "CreateImageGeometryFilter",
"parameters": [
{
"name": "SelectedDataContainer",
Expand Down Expand Up @@ -12047,7 +12047,7 @@
"uuid": "{e6b9a566-c5eb-5e3a-87de-7fe65d1d12b6}"
},
{
"name": "CropVertexGeometry",
"name": "CropVertexGeometryFilter",
"parameters": [
{
"name": "DataContainerName",
Expand Down Expand Up @@ -12405,7 +12405,7 @@
"uuid": "{9e98c3b0-5707-5a3b-b8b5-23ef83b02896}"
},
{
"name": "InitializeData",
"name": "InitializeDataFilter",
"parameters": [
{
"name": "",
Expand Down Expand Up @@ -12491,7 +12491,7 @@
"uuid": "{34a19028-c50b-5dea-af0e-e06c798d3686}"
},
{
"name": "MoveData",
"name": "MoveDataFilter",
"parameters": [
{
"name": "WhatToMove",
Expand Down Expand Up @@ -13205,7 +13205,7 @@
"uuid": "{f4a7c2df-e9b0-5da9-b745-a862666d6c99}"
},
{
"name": "ChangeAngleRepresentation",
"name": "ChangeAngleRepresentationFilter",
"parameters": [
{
"name": "ConversionType",
Expand Down

0 comments on commit 3de11c6

Please sign in to comment.