ENH: ApplyTransformationToGeometry: Better error messages, Update documentation. (BlueQuartzSoftware#835)

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

Author: imikejackson

src/Plugins/SimplnxCore/docs/ApplyTransformationToGeometryFilter.md

@@ -2,41 +2,37 @@
 
 ## Group (Subgroup)
 
-Rotation & Transformation
+Rotation, Scale & Transformation
 
 ## Description
 
-This **Filter** applies a spatial transformation to either and unstructured **Geometry** or an ImageGeometry. An "
-unstructured" **Geometry** is any geometry that requires explicit definition of **Vertex** positions. Specifically, *
-*Vertex**, **Edge**, **Triangle**, **Quadrilateral**, and **Tetrahedral** **Geometries** may be transformed by this *
-*Filter**. The transformation is applied in place, so the input **Geometry** will be modified.
+### Unstructured Grid Geometries
 
-If the user selects an **Image Geometry** then they will need to select which kind of **Interpolation Method* will be
-used when transferring the data from the old geometry to the newly transformed geometry. If the user selects *any other*
-kind of geometry then the user should select the "No Interpolation" selection to disable the requirement for a *Cell Attribute Matrix*.
+This **Filter** applies a spatial transformation to either and unstructured **Geometry** or an **Image Geometry**. An "unstructured" **Geometry** is any geometry that requires explicit definition of **Vertex** positions. Specifically, **Vertex**, **Edge**, **Triangle**, **Quadrilateral**, and **Tetrahedral** **Geometries** may be transformed by this **Filter**. The transformation is applied in place, so the input **Geometry** will be modified.
+
+- **NO** interpolation will take place as the only changes that take place are the actual coordinates of the vertices.
+
+### Image Geometry
+
+If the user selects an **Image Geometry** then there are 2 additional required filter parameters that need to be set:
+
+- **Interpolation Method**: This will be used when transferring the data from the old geometry to the newly transformed geometry.
+- **Cell Attribute Matrix**: This Attribute Matrix holds the data that is associated with each cell of the image geometry.
 
 The linear/Bi-Linear/Tri-Linear Interpolation is adapted from the equations presented
 in [https://www.cs.purdue.edu/homes/cs530/slides/04.DataStructure.pdf, page 36}](https://www.cs.purdue.edu/homes/cs530/slides/04.DataStructure.pdf)
 
 ### Caveats
 
-- If the user selects an **unstructured** based geometry, **NO** interpolation will take place as the only changes that
-take place are the actual coordinates of the vertices.
-
-- If the user selects an **Image Geometry** then the user should select one of the *Interpolation* methods and then also
-select the appropriate *Cell Attribute Matrix*.
-
-The **Scale** and **Rotation** transformation types will automatically translate the volume to (0, 0, 0), apply the scaling/rotation,
-and then translate the volume back to its original location.  If the **Manual Transformation Matrix** or **Pre-Computed Transformation
-Matrix** types are selected, then it is up to the user to make sure that those translations are included, if necessary.
+- The **Scale** and **Rotation** transformation types will automatically translate the volume to (0, 0, 0), apply the scaling/rotation, and then translate the volume back to its original location.  If the **Manual Transformation Matrix** or **Pre-Computed Transformation Matrix** types are selected, then it is up to the user to make sure that those translations are included, if necessary.
 
-## Example Transformations
+## Example Image Geometry Transformations
 
 | Description | Example Output Image |
 |-------------|----------------------|
-| Untransformed |  ![](Images/ApplyTransformation_AsRead.png) |
-| After Rotation of <001> 45 Degrees | ![](Images/ApplyTransformation_Rotated.png) |
-| Scaled (2.0, 2.0, 1.0)  | ![](Images/ApplyTransformation_Scaled.png) |
+| Input Image |  ![Input Image](Images/ApplyTransformation_AsRead.png) |
+| After Rotation of 45 Degrees around the <001> axis | ![Rotation of 45 Degrees around the <0,0,1> axis](Images/ApplyTransformation_Rotated.png) |
+| Scaled by 2x in the X and Y axis  | ![Scaled by 2x in the X and Y axis.](Images/ApplyTransformation_Scaled.png) |
 
 ## Transformation Information
 
@@ -55,9 +51,9 @@ The user may select from a variety of options for the type of transformation to
 
 ## Example Pipelines
 
-+ Pipelines/SimplnxCore/Examples/apply_transformation_basic.d3dpipeline
-+ Pipelines/SimplnxCore/Examples/apply_transformation_image.d3dpipeline
-+ Pipelines/SimplnxCore/Examples/apply_transformation_node.d3dpipeline
+- Pipelines/SimplnxCore/Examples/apply_transformation_basic.d3dpipeline
+- Pipelines/SimplnxCore/Examples/apply_transformation_image.d3dpipeline
+- Pipelines/SimplnxCore/Examples/apply_transformation_node.d3dpipeline
 
 ## License & Copyright
 

src/Plugins/SimplnxCore/src/SimplnxCore/Filters/ApplyTransformationToGeometryFilter.cpp

@@ -68,7 +68,7 @@ std::string ApplyTransformationToGeometryFilter::humanName() const
 //------------------------------------------------------------------------------
 std::vector<std::string> ApplyTransformationToGeometryFilter::defaultTags() const
 {
-  return {className(), "DREAM3D Review", "Rotation/Transforming"};
+  return {className(), "Scale", "Flip", "Mirror", "Rotation", "Transforming"};
 }
 
 //------------------------------------------------------------------------------
@@ -171,8 +171,9 @@ IFilter::PreflightResult ApplyTransformationToGeometryFilter::preflightImpl(cons
     {
     case k_NoTransformIdx: // No-Op
     {
-      resultOutputActions.warnings().push_back(Warning{82001, "No transformation has been selected, so this filter will perform no operations"});
+      resultOutputActions.warnings().push_back(Warning{82001, "No transformation has been selected. This filter will NOT modify any data."});
       transformationMatrixDesc = "No transformation matrix selected.";
+      break;
     }
     case k_PrecomputedTransformationMatrixIdx: // Transformation matrix from array
     {
@@ -237,16 +238,28 @@ IFilter::PreflightResult ApplyTransformationToGeometryFilter::preflightImpl(cons
 
     preflightUpdatedValues.push_back({"Generated Transformation Matrix", transformationMatrixDesc});
 
+    std::stringstream errorMessage;
+    errorMessage << "You have selected to transform an 'Image Geometry', please correct the following issues:\n";
+    bool imageGeomInterpolationError = false;
+
     auto pInterpolationTypeValue = filterArgs.value<ChoicesParameter::ValueType>(k_InterpolationType_Key);
-    // auto pDataArraySelectionValue = filterArgs.value<MultiArraySelectionParameter::ValueType>(k_DataArraySelection_Key);
+    if(pInterpolationTypeValue == k_NoInterpolationIdx)
+    {
+      errorMessage << "* Select either 'Nearest Neighbor Resampling' or 'Linear Interpolation' from the 'Image Geometry Resampling/Interpolation' parameter section.\n";
+      imageGeomInterpolationError = true;
+    }
 
-    // For nearest neighbor we can use any data array as we are only going to copy from a hit cell, no interpolation
     const auto* srcCellAttrMatrixPtr = dataStructure.getDataAs<AttributeMatrix>(pCellAttributeMatrixPath);
     if(nullptr == srcCellAttrMatrixPtr)
     {
-      return {MakeErrorResult<OutputActions>(
-          -82006, fmt::format("DataPath '{}' is not an Cell AttributeMatrix. Please select the Cell level AttributeMatrix of the Image Geometry", pCellAttributeMatrixPath.toString()))};
+      errorMessage << "* Select the Image Geometry's cell level Attribute Matrix. This will contain all the data that will be interpolated onto the new Image Geometry.";
+      imageGeomInterpolationError = true;
     }
+    if(imageGeomInterpolationError)
+    {
+      return {MakeErrorResult<OutputActions>(-82006, errorMessage.str())};
+    }
+
     std::vector<std::string> selectedCellArrayNames = srcCellAttrMatrixPtr->getDataMap().getNames();
 
     if(pInterpolationTypeValue == k_LinearInterpolationIdx)
@@ -417,7 +430,7 @@ IFilter::PreflightResult ApplyTransformationToGeometryFilter::preflightImpl(cons
     // An image geometry was not chosen, so throw a warning communicating to the user that the cell attribute matrix will not be used
     if(!pCellAttributeMatrixPath.getTargetName().empty())
     {
-      auto warning = Warning{-5555, fmt::format("The Selected Geometry is not an image geometry, so the Attribute Matrix '{}' will not be used when applying this transformation.",
+      auto warning = Warning{-5555, fmt::format("The selected geometry is not an 'Image Geometry'. NO interpolation is performed on the data. The 'Cell Attribute Matrix' DataPath can be empty.",
                                                 pCellAttributeMatrixPath.getTargetName())};
       resultOutputActions.warnings().push_back(warning);
     }