Merge pull request #1470 from allywarner/GetMeshQualityField_Convert

Closes #1136

Author: dcwhite

src/Core/Algorithms/Legacy/Fields/CMakeLists.txt

@@ -99,6 +99,7 @@ SET(Core_Algorithms_Legacy_Fields_HEADERS
   RegisterWithCorrespondences.h
   SampleField/GeneratePointSamplesFromField.h
   DistanceField/CalculateIsInsideField.h
+  MeshData/GetMeshQualityFieldAlgo.h
 )
 
 SET(Core_Algorithms_Legacy_Fields_SRCS
@@ -180,7 +181,7 @@ SET(Core_Algorithms_Legacy_Fields_SRCS
   Mapping/ApplyMappingMatrix.cc
   #MeshData/GetSurfaceNodeNormals.cc
   #MeshData/GetSurfaceElemNormals.cc
-  #MeshData/GetMeshQualityField.cc
+  MeshData/GetMeshQualityFieldAlgo.cc
   #MeshDerivatives/CalculateMeshConnector.cc
   #MeshDerivatives/CalculateMeshCenter.cc
   #MeshDerivatives/GetCentroids.cc

…y/Fields/MeshData/GetMeshQualityField.cc …elds/MeshData/GetMeshQualityFieldAlgo.ccsrc/Core/Algorithms/Legacy/Fields/MeshData/GetMeshQualityField.cc renamed to src/Core/Algorithms/Legacy/Fields/MeshData/GetMeshQualityFieldAlgo.cc src/Core/Algorithms/Legacy/Fields/MeshData/GetMeshQualityField.cc renamed to src/Core/Algorithms/Legacy/Fields/MeshData/GetMeshQualityFieldAlgo.cc

@@ -26,22 +26,49 @@
    DEALINGS IN THE SOFTWARE.
 */
 
-#include <Core/Algorithms/Fields/MeshData/GetMeshQualityField.h>
-#include <Core/Datatypes/Field.h>
-#include <Core/Datatypes/FieldInformation.h>
+#include <Core/Algorithms/Legacy/Fields/MeshData/GetMeshQualityFieldAlgo.h>
+#include <Core/Datatypes/Legacy/Field/FieldInformation.h>
+#include <Core/Algorithms/Base/AlgorithmVariableNames.h>
+#include <Core/Algorithms/Base/AlgorithmPreconditions.h>
+#include <Core/Datatypes/Legacy/Field/VField.h>
+#include <Core/Datatypes/Legacy/Field/VMesh.h>
 
-namespace SCIRunAlgo {
+using namespace SCIRun;
+using namespace SCIRun::Core::Datatypes;
+using namespace SCIRun::Core::Algorithms;
+using namespace SCIRun::Core::Algorithms::Fields;
+
+ALGORITHM_PARAMETER_DEF(Fields,Metric);
+
+GetMeshQualityFieldAlgo::GetMeshQualityFieldAlgo()
+{
+    addOption(Parameters::Metric,"scaled_jacobian","scaled_jacobian|jacobian|volume|insc_circ_ratio");
+}
+
+AlgorithmOutput GetMeshQualityFieldAlgo::run(const AlgorithmInput& input) const
+{
+    auto input_field = input.get<Field>(Variables::InputField);
+    
+    FieldHandle output_field;
+    
+    if (!run(input_field, output_field))
+        THROW_ALGORITHM_PROCESSING_ERROR("False returned on legacy run call.");
+    
+    AlgorithmOutput output;
+    output[Variables::OutputField] = output_field;
+    
+    return output;
+}
 
 bool
-GetMeshQualityFieldAlgo::run(FieldHandle input, FieldHandle& output)
+GetMeshQualityFieldAlgo::run(FieldHandle input, FieldHandle& output) const
 {
-  algo_start("GetMeshQualityField");
-  std::string metric = get_option("metric");
+    std::string Metric = getOption(Parameters::Metric);
 
-  if (input.get_rep() == 0)
+  if (!input)
   {
     error("No input field");
-    algo_end(); return (false);
+    return false;
   }
 
   FieldInformation fi(input);
@@ -50,40 +77,40 @@ GetMeshQualityFieldAlgo::run(FieldHandle input, FieldHandle& output)
 
   output = CreateField(fi,input->mesh());
 
-  if (output.get_rep() == 0)
+  if (!output)
   {
     error("Could not create output field");
-    algo_end(); return (false);
+    return false;
   }
 
   VField* ofield = output->vfield();
   VMesh*  imesh  = input->vmesh();
 
-  if (metric == "scaled_jacobian")
+  if (Metric == "scaled_jacobian")
   {
     VMesh::Elem::size_type num_values = imesh->num_elems();
     for (VMesh::Elem::index_type j=0; j<num_values; j++)
     {
       ofield->set_value(imesh->scaled_jacobian_metric(j),j);
     }
   }
-  else if (metric == "jacobian")
+  else if (Metric == "jacobian")
   {
     VMesh::Elem::size_type num_values = imesh->num_elems();
     for (VMesh::Elem::index_type j=0; j<num_values; j++)
     {
       ofield->set_value(imesh->jacobian_metric(j),j);
     }  
   }
-  else if (metric == "volume")
+  else if (Metric == "volume")
   {
     VMesh::Elem::size_type num_values = imesh->num_elems();
     for (VMesh::Elem::index_type j=0; j<num_values; j++)
     {
       ofield->set_value(imesh->volume_metric(j),j);
     }  
   }
-  else if (metric == "insc_circ_ratio")
+  else if (Metric == "insc_circ_ratio")
   {
     VMesh::Elem::size_type num_values = imesh->num_elems();
     for (VMesh::Elem::index_type j=0; j<num_values; j++)
@@ -92,9 +119,6 @@ GetMeshQualityFieldAlgo::run(FieldHandle input, FieldHandle& output)
     }  
   }  
 
-  algo_end();
-  return (true);
+    return true;
 }
 
-
-}

src/Core/Algorithms/Legacy/Fields/MeshData/GetMeshQualityFieldAlgo.h

@@ -0,0 +1,59 @@
+/*
+   For more information, please see: http://software.sci.utah.edu
+
+   The MIT License
+
+   Copyright (c) 2015 Scientific Computing and Imaging Institute,
+   University of Utah.
+
+   
+   Permission is hereby granted, free of charge, to any person obtaining a
+   copy of this software and associated documentation files (the "Software"),
+   to deal in the Software without restriction, including without limitation
+   the rights to use, copy, modify, merge, publish, distribute, sublicense,
+   and/or sell copies of the Software, and to permit persons to whom the
+   Software is furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included
+   in all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+   DEALINGS IN THE SOFTWARE.
+*/
+
+#ifndef CORE_ALGORITHMS_LEGACY_FIELDS_MESHDATA_GETMESHQUALITYFIELD_H
+#define CORE_ALGORITHMS_LEGACY_FIELDS_MESHDATA_GETMESHQUALITYFIELD_H 1
+
+//Base class for algorithm
+#include <Core/Algorithms/Base/AlgorithmBase.h>
+#include <Core/Algorithms/Base/AlgorithmVariableNames.h>
+
+//For Windows support
+#include <Core/Algorithms/Legacy/Fields/share.h>
+
+namespace SCIRun {
+    namespace Core {
+        namespace Algorithms {
+            namespace Fields {
+                
+ALGORITHM_PARAMETER_DECL(Metric);
+
+class SCISHARE GetMeshQualityFieldAlgo : public AlgorithmBase
+{
+  public:
+    /// Set defaults
+    GetMeshQualityFieldAlgo();
+    
+    ///Run the algorithm
+    bool run(FieldHandle input, FieldHandle& output) const;
+    virtual AlgorithmOutput run(const AlgorithmInput& input) const;
+};
+
+}}}}
+
+#endif