ENH: Convert AttributeArray DataType allows user to delete input arra…

…y. (#746)

Signed-off-by: Michael Jackson <[email protected]>

src/Plugins/ComplexCore/docs/ConvertDataFilter.md

@@ -1,4 +1,4 @@
-# Convert Attribute Data Type
+# Convert AttributeArray DataType
 
 ## Group (Subgroup)
 

src/Plugins/ComplexCore/src/ComplexCore/Filters/ConvertDataFilter.cpp

@@ -6,7 +6,9 @@
 #include "complex/DataStructure/DataPath.hpp"
 #include "complex/DataStructure/IDataArray.hpp"
 #include "complex/Filter/Actions/CreateArrayAction.hpp"
+#include "complex/Filter/Actions/DeleteDataAction.hpp"
 #include "complex/Parameters/ArraySelectionParameter.hpp"
+#include "complex/Parameters/BoolParameter.hpp"
 #include "complex/Parameters/ChoicesParameter.hpp"
 #include "complex/Parameters/DataObjectNameParameter.hpp"
 
@@ -52,6 +54,8 @@ Parameters ConvertDataFilter::parameters() const
   params.insertSeparator(Parameters::Separator{"Input Parameters"});
   params.insert(std::make_unique<ChoicesParameter>(k_ScalarType_Key, "Scalar Type", "Convert to this data type", 0, GetAllDataTypesAsStrings()));
   params.insert(std::make_unique<ArraySelectionParameter>(k_ArrayToConvert_Key, "Data Array to Convert", "The complete path to the Data Array to Convert", DataPath{}, GetAllDataTypes()));
+  params.insert(std::make_unique<BoolParameter>(k_DeleteOriginal_Key, "Remove Original Array", "Whether or not to remove the original array after conversion", false));
+
   params.insertSeparator(Parameters::Separator{"Created Data Objects"});
   params.insert(std::make_unique<DataObjectNameParameter>(k_ConvertedArray_Key, "Converted Data Array", "The name of the converted Data Array", "Converted_"));
 
@@ -71,24 +75,31 @@ IFilter::PreflightResult ConvertDataFilter::preflightImpl(const DataStructure& d
   auto pScalarTypeIndex = filterArgs.value<ChoicesParameter::ValueType>(k_ScalarType_Key);
   auto pInputArrayPath = filterArgs.value<ArraySelectionParameter::ValueType>(k_ArrayToConvert_Key);
   auto pConvertedArrayName = filterArgs.value<DataObjectNameParameter::ValueType>(k_ConvertedArray_Key);
-  DataPath convertedArrayPath = pInputArrayPath.getParent().createChildPath(pConvertedArrayName);
+  auto pRemoveOriginal = filterArgs.value<bool>(k_DeleteOriginal_Key);
+
+  DataPath const convertedArrayPath = pInputArrayPath.getParent().createChildPath(pConvertedArrayName);
 
-  DataType pScalarType = StringToDataType(GetAllDataTypesAsStrings()[pScalarTypeIndex]);
+  DataType const pScalarType = StringToDataType(GetAllDataTypesAsStrings()[pScalarTypeIndex]);
 
   PreflightResult preflightResult;
   complex::Result<OutputActions> resultOutputActions;
 
-  auto* inputArray = dataStructure.getDataAs<IDataArray>(pInputArrayPath);
-  if(inputArray == nullptr)
+  auto* inputArrayPtr = dataStructure.getDataAs<IDataArray>(pInputArrayPath);
+  if(inputArrayPtr == nullptr)
   {
     return {nonstd::make_unexpected(std::vector<Error>{Error{-15201, fmt::format("Cannot find input data array at path '{}'", pInputArrayPath.toString())}})};
   }
 
   resultOutputActions.value().appendAction(
-      std::make_unique<CreateArrayAction>(pScalarType, inputArray->getIDataStoreRef().getTupleShape(), inputArray->getIDataStoreRef().getComponentShape(), convertedArrayPath));
+      std::make_unique<CreateArrayAction>(pScalarType, inputArrayPtr->getIDataStoreRef().getTupleShape(), inputArrayPtr->getIDataStoreRef().getComponentShape(), convertedArrayPath));
 
   std::vector<PreflightValue> preflightUpdatedValues;
 
+  if(pRemoveOriginal)
+  {
+    resultOutputActions.value().appendDeferredAction(std::make_unique<DeleteDataAction>(pInputArrayPath, DeleteDataAction::DeleteType::JustObject));
+  }
+
   // Return both the resultOutputActions and the preflightUpdatedValues via std::move()
   return {std::move(resultOutputActions), std::move(preflightUpdatedValues)};
 }

src/Plugins/ComplexCore/src/ComplexCore/Filters/ConvertDataFilter.hpp

@@ -27,6 +27,7 @@ class COMPLEXCORE_EXPORT ConvertDataFilter : public IFilter
   static inline constexpr StringLiteral k_ScalarType_Key = "scalar_type";
   static inline constexpr StringLiteral k_ArrayToConvert_Key = "array_to_convert";
   static inline constexpr StringLiteral k_ConvertedArray_Key = "converted_array";
+  static inline constexpr StringLiteral k_DeleteOriginal_Key = "delete_original_array";
 
   /**
    * @brief Returns the name of the filter.

src/Plugins/ComplexCore/src/ComplexCore/Filters/SplitAttributeArrayFilter.cpp

@@ -43,7 +43,7 @@ std::string SplitAttributeArrayFilter::humanName() const
 //------------------------------------------------------------------------------
 std::vector<std::string> SplitAttributeArrayFilter::defaultTags() const
 {
-  return {className(), "Core", "Split"};
+  return {className(), "Core", "Split", "Data", "Multi-Component"};
 }
 
 //------------------------------------------------------------------------------