Restyle/reformat ShapeEvaluationJob

Author: akenmorris

Studio/Analysis/ShapeEvaluationJob.cpp

@@ -1,44 +1,38 @@
-
+#include "ShapeEvaluationJob.h"
 
 #include <Logging.h>
-#include "ShapeEvaluationJob.h"
+
 namespace shapeworks {
 
 //-----------------------------------------------------------------------------
 ShapeEvaluationJob::ShapeEvaluationJob(JobType job_type, ParticleShapeStatistics stats)
-  : job_type_(job_type), stats_(stats)
-{
-  qRegisterMetaType<shapeworks::ShapeEvaluationJob::JobType>(
-    "shapeworks::ShapeEvaluationWorker::JobType");
+    : job_type_(job_type), stats_(stats) {
+  qRegisterMetaType<shapeworks::ShapeEvaluationJob::JobType>("shapeworks::ShapeEvaluationWorker::JobType");
   qRegisterMetaType<Eigen::VectorXd>("Eigen::VectorXd");
 }
 
 //-----------------------------------------------------------------------------
-void ShapeEvaluationJob::run()
-{
+void ShapeEvaluationJob::run() {
   auto callback = std::bind(&ShapeEvaluationJob::receive_progress, this, std::placeholders::_1);
-  switch (this->job_type_) {
-  case JobType::CompactnessType:
-    Q_EMIT result_ready(this->job_type_, this->stats_.get_compactness(callback));
-    break;
-  case JobType::GeneralizationType:
-    Q_EMIT result_ready(this->job_type_, this->stats_.get_generalization(callback));
-    break;
-  case JobType::SpecificityType:
-    Q_EMIT result_ready(this->job_type_, this->stats_.get_specificity(callback));
-    break;
+  switch (job_type_) {
+    case JobType::CompactnessType:
+      Q_EMIT result_ready(job_type_, stats_.get_compactness(callback));
+      break;
+    case JobType::GeneralizationType:
+      Q_EMIT result_ready(job_type_, stats_.get_generalization(callback));
+      break;
+    case JobType::SpecificityType:
+      Q_EMIT result_ready(job_type_, stats_.get_specificity(callback));
+      break;
   }
 }
 
 //-----------------------------------------------------------------------------
-QString ShapeEvaluationJob::name()
-{
-  return "Shape Evaluation";
-}
+QString ShapeEvaluationJob::name() { return "Shape Evaluation"; }
 
 //-----------------------------------------------------------------------------
-void ShapeEvaluationJob::receive_progress(float progress)
-{
-  Q_EMIT report_progress(this->job_type_, progress);
-}
-}
+void ShapeEvaluationJob::receive_progress(float progress) { Q_EMIT report_progress(job_type_, progress); }
+
+//-----------------------------------------------------------------------------
+
+}  // namespace shapeworks

Studio/Analysis/ShapeEvaluationJob.h

@@ -1,40 +1,38 @@
 #pragma once
 
-#include <ParticleShapeStatistics.h>
-
 #include <Data/Worker.h>
 #include <Job/Job.h>
+#include <ParticleShapeStatistics.h>
 
 namespace shapeworks {
 
-class ShapeEvaluationJob : public Job
-{
+/**
+ * @brief The ShapeEvaluationJob class is a worker class that computes shape evaluation metrics of compactness,
+ * specificity, and generalization.  It runs asynchronously using the Job and Worker interfaces.
+ */
+class ShapeEvaluationJob : public Job {
   Q_OBJECT
-public:
-
-  enum class JobType {
-    CompactnessType, SpecificityType, GeneralizationType
-  };
+ public:
+  enum class JobType { CompactnessType, SpecificityType, GeneralizationType };
 
   ShapeEvaluationJob(JobType job_type, ParticleShapeStatistics stats);
 
   void run() override;
 
   QString name() override;
 
-Q_SIGNALS:
+ Q_SIGNALS:
 
   void report_progress(shapeworks::ShapeEvaluationJob::JobType job_type, float progress);
   void result_ready(shapeworks::ShapeEvaluationJob::JobType job_type, Eigen::VectorXd data);
 
-private:
-
+ private:
   void receive_progress(float progress);
 
   JobType job_type_;
   ParticleShapeStatistics stats_;
 };
-}
+}  // namespace shapeworks
 
 Q_DECLARE_METATYPE(Eigen::VectorXd);
 Q_DECLARE_METATYPE(shapeworks::ShapeEvaluationJob::JobType);