[yoda-svn] r411 - trunk/include/YODA

[blackhole at projects.hepforge.org]

Author: buckley
Date: Tue Dec  6 17:51:15 2011
New Revision: 411

Log:
Doxy tweaks

Modified:
   trunk/include/YODA/Dbn3D.h
   trunk/include/YODA/ProfileBin2D.h

Modified: trunk/include/YODA/Dbn3D.h
==============================================================================
--- trunk/include/YODA/Dbn3D.h	Tue Dec  6 17:34:38 2011	(r410)
+++ trunk/include/YODA/Dbn3D.h	Tue Dec  6 17:51:15 2011	(r411)
@@ -5,15 +5,17 @@
 #include "YODA/Dbn1D.h"
 
 namespace YODA {
-  
+
+
+  /// A representation of the vital statistics of a 3D distribution
   class Dbn3D {
   public:
-  
+
     /// @name COnstructors
     //@{
 
     /// Default constructor
-    Dbn3D() { 
+    Dbn3D() {
       reset();
     }
 
@@ -29,7 +31,7 @@
       _sumWYZ(sumWYZ),
       _sumWXYZ(sumWYZ)
     { }
-   
+
     /// Copy constructor
     Dbn3D(const Dbn3D& toCopy) {
       _dbnX = toCopy._dbnX;
@@ -38,7 +40,7 @@
     }
 
     //@}
-   
+
     /// @name Modifiers
     //@{
 
@@ -51,7 +53,7 @@
       _sumWXZ += weight*valX*valZ;
       _sumWYZ += weight*valY*valZ;
       _sumWXYZ += weight*valX*valY*valZ;
-    } 
+    }
 
     /// Reset to the unfilled state
     void reset() {
@@ -283,7 +285,7 @@
     //@}
 
   protected:
-  
+
     /// Add two dbns
     Dbn3D& add(const Dbn3D& d) {
       _dbnX += d._dbnX;
@@ -310,7 +312,7 @@
   private:
     /// @name Storage
     // @{
-  
+
     /// The x moments and the pure-weight quantities are stored in a 1D 'x' distribution
     Dbn1D _dbnX;
 
@@ -327,7 +329,7 @@
     double _sumWXYZ;
     //@}
   };
-  
+
   /// Add two dbns
   inline Dbn3D operator + (const Dbn3D& a, const Dbn3D& b) {
     Dbn3D rtn = a;

Modified: trunk/include/YODA/ProfileBin2D.h
==============================================================================
--- trunk/include/YODA/ProfileBin2D.h	Tue Dec  6 17:34:38 2011	(r410)
+++ trunk/include/YODA/ProfileBin2D.h	Tue Dec  6 17:51:15 2011	(r411)
@@ -6,15 +6,23 @@
 #include "YODA/Exceptions.h"
 
 namespace YODA {
-    
+
+
+  /// @brief A Bin1D specialised for handling profile-type information
+  ///
+  /// This is a 1D bin type, which supports all the operations defined for
+  /// a generic Bin1D object, but also supplies the specific member functions
+  /// for profile-type data, as opposed to histogram-type. This means that
+  /// extra internal distribution statistics are stored for the extra
+  /// "y-direction" specified in the profile fill operation.
   class ProfileBin2D : public Bin2D<Dbn3D> {
   public:
-      
+
     /// @name Constructors
     //@{
 
     /// Constructor giving lowedgesX/Y
-    ProfileBin2D(double lowX, double lowY, double highX, double highY) 
+    ProfileBin2D(double lowX, double lowY, double highX, double highY)
       : Bin2D(lowX, lowY, highX, highY)
     { }
 
@@ -54,14 +62,14 @@
     void fillBin(double z, double weight=1.0){
       fill(midpoint().first, midpoint().second, z, weight);
     }
-    
+
     //@}
 
   public:
-    
+
     /// @name Bin content info
     //@{
-      
+
     double mean() const {
       return _dbn.zMean();
     }
@@ -97,7 +105,7 @@
     //@}
 
   public:
-    
+
     /// Add two bins (for use by Profile2D)
     ProfileBin2D& operator += (const ProfileBin2D& toAdd) {
       return add(toAdd);
@@ -108,7 +116,7 @@
     }
 
   protected:
-    
+
     /// Add two bins
     ProfileBin2D& add(const ProfileBin2D& pb) {
       Bin2D<Dbn3D>::add(pb);