Refs #9379 fix doxygen warnings

mantidproject · May 1, 2014 · 0e41c18 · 0e41c18
1 parent bda53fa
commit 0e41c18
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 18 deletions.
diff --git a/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/Integrate3DEvents.h b/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/Integrate3DEvents.h
@@ -77,7 +77,7 @@ class DLLExport Integrate3DEvents
                                  double       peak_radius,
                                  double       back_inner_radius,
                                  double       back_outer_radius,
-                                 std::vector<double> & new_sigmas,
+                                 std::vector<double> & axes_radii,
                                  double     & inti,
                                  double     & sigi );
 
@@ -126,7 +126,7 @@ class DLLExport Integrate3DEvents
                                  double                      peak_radius,
                                  double                      back_inner_radius,
                                  double                      back_outer_radius,
-                                 std::vector<double>       & new_sigmas,
+                                 std::vector<double>       & axes_radii,
                                  double                    & inti,
                                  double                    & sigi );
 

diff --git a/Code/Mantid/Framework/MDEvents/src/Integrate3DEvents.cpp b/Code/Mantid/Framework/MDEvents/src/Integrate3DEvents.cpp
@@ -110,6 +110,8 @@ void Integrate3DEvents::addEvents( std::vector<V3D> const & event_qs )
  * @param back_outer_radius   Size of half the major axis of the OUTER 
  *                            ellipsoidal boundary of the background region
  *
+ * @param axes_radii          The radii used for integration in the
+ *                            directions of the three principal axes.
  * @param inti                Returns the net integrated intensity
  * @param sigi                Returns an estimate of the standard deviation
  *                            of the net integrated intensity
@@ -121,7 +123,7 @@ void Integrate3DEvents::ellipseIntegrateEvents(
                                             double           peak_radius,
                                             double           back_inner_radius,
                                             double           back_outer_radius,
-                                            std::vector<double> & new_sigmas,
+                                            std::vector<double> & axes_radii,
                                             double         & inti,
                                             double         & sigi )
 {
@@ -174,7 +176,7 @@ void Integrate3DEvents::ellipseIntegrateEvents(
   ellipseIntegrateEvents(some_events, eigen_vectors, sigmas,
                          specify_size,   peak_radius, 
                          back_inner_radius, back_outer_radius,
-                         new_sigmas, inti, sigi);
+                         axes_radii, inti, sigi);
 }
 
 
@@ -430,6 +432,8 @@ void Integrate3DEvents::addEvent( V3D event_Q )
  * @param back_outer_radius   Size of half the major axis of the OUTER 
  *                            ellipsoidal boundary of the background region
  *
+ * @param axes_radii          The radii used for integration in the
+ *                            directions of the three principal axes.
  * @param inti                Returns the net integrated intensity
  * @param sigi                Returns an estimate of the standard deviation
  *                            of the net integrated intensity
@@ -443,7 +447,7 @@ void Integrate3DEvents::ellipseIntegrateEvents(
                                  double                      peak_radius,
                                  double                      back_inner_radius,
                                  double                      back_outer_radius,
-                                 std::vector<double>       & new_sigmas,
+                                 std::vector<double>       & axes_radii,
                                  double                    & inti,
                                  double                    & sigi )
 {
@@ -488,24 +492,24 @@ void Integrate3DEvents::ellipseIntegrateEvents(
     }
   }
 
-  new_sigmas.clear();
+  axes_radii.clear();
   for (int i = 0; i < 3; i++ )
   {
-    new_sigmas.push_back( r3*sigmas[i] );
+    axes_radii.push_back( r3*sigmas[i] );
   }
-  double back2 = numInEllipsoid( ev_list, directions, new_sigmas );
+  double back2 = numInEllipsoid( ev_list, directions, axes_radii );
 
   for (int i = 0; i < 3; i++ )
   {
-    new_sigmas[i] = r2*sigmas[i];
+    axes_radii[i] = r2*sigmas[i];
   }
-  double back1 = numInEllipsoid( ev_list, directions, new_sigmas );
+  double back1 = numInEllipsoid( ev_list, directions, axes_radii );
 
   for (int i = 0; i < 3; i++ )
   {
-    new_sigmas[i] = r1*sigmas[i];
+    axes_radii[i] = r1*sigmas[i];
   }
-  double peak_w_back = numInEllipsoid( ev_list, directions, new_sigmas );
+  double peak_w_back = numInEllipsoid( ev_list, directions, axes_radii );
 
   double backgrd = back2 - back1;
 

diff --git a/Code/Mantid/Framework/MDEvents/src/IntegrateEllipsoids.cpp b/Code/Mantid/Framework/MDEvents/src/IntegrateEllipsoids.cpp
@@ -368,23 +368,23 @@ namespace MDEvents
       if ( Geometry::IndexingUtils::ValidIndex( hkl, 1.0 ) ) 
       {
         V3D peak_q( peaks[i].getQLabFrame() );
-        std::vector<double> new_sigmas;
+        std::vector<double> axes_radii;
         integrator.ellipseIntegrateEvents( peak_q, 
           specify_size, peak_radius, back_inner_radius, back_outer_radius,
-          new_sigmas, inti, sigi );
+          axes_radii, inti, sigi );
         peaks[i].setIntensity( inti );
         peaks[i].setSigmaIntensity( sigi );
         g_log.debug() << "Radii of three axes of ellipsoid for integrating peak "
         		<< i << " = ";
         for (int i3 = 0; i3 < 3; i3++ )
         {
-          g_log.debug() << new_sigmas[i3] << "  ";
+          g_log.debug() << axes_radii[i3] << "  ";
         }
         g_log.debug() << std::endl;
 
-        PeakRadiusVector1[i] = new_sigmas[0];
-        PeakRadiusVector2[i] = new_sigmas[1];
-        PeakRadiusVector3[i] = new_sigmas[2];
+        PeakRadiusVector1[i] = axes_radii[0];
+        PeakRadiusVector2[i] = axes_radii[1];
+        PeakRadiusVector3[i] = axes_radii[2];
       }
       else
       {