LISTSERV 16.5 - LCD-CVS Archives

+ /** + * Class constructor. + * @param[in] x, y, z The global position of the box's center. + * @param[in] dx, dy, dz The half lengths of the box. + * @param[in] by, by, bz The B-field coordinates for the region. + */

+ /** + * Implementation of G4MagneticField class's primary method to get B-field at a point. + * @param[in] point The 3D point at which B-field components will be read. + * @param[out] bfield The output B-field components at the point. + */

+ * A 3D B-field map defined as a grid of points with associated B-field values. Values are + * interpolated to obtain B-field information at points in between. + * @note Original PurgMagTabulatedField3D code developed by: S.Larsson and J. Generowicz.

+ /** + * Class constructor. + * @param[in] filename The name of the file defining the B-field grid. + * @param[in] xOffset, yOffset, zOffset The offset of the grid's coordinate system. + */

+ /** + * Implementation of primary virtual method from G4MagneticField intercace. + * @param[in] Point The point in 3D space. + * @param[out] Bfield The output B-field data at the point. + */

+private: + + /** + * Create an overlay from multiple magnetic field objects. + * @param[in] The list of magnetic fields. + * @return The overlay created from the list of fields. + */ + MagneticFieldOverlay* makeOverlay(std::vector<G4MagneticField*> fields); + + /** + * Get the overlay as a Geant4 implementation class. + * @param[in] fields The list of magnetic fields. + * @return The overlay as a G4MagneticField. + */

+ * The implementation of a calorimeter that accumulates energy depositions by event + * and processes them depending on the particular XML configuration of the detector. + * @todo Remove class alterations made for use by OpticalCalorimeter only e.g. things having to do + * with multiple hit output collections.

+ + /** + * Class constructor. + * @param[in] sdName The name of the sensitive detector. + * @param[in] hcName The name of the output hit collection. + * @param[in] sdSeg The detector's segmentation object for dividing into artificial cells. + * @param[in] compare The hit comparator to be used by this detector. + */

+ /** + * Class constructor. + * @param[in] sdName The name of the sensitive detector. + * @param[in] hcName The name of the output hit collections. + * @param[in] sdSeg The detector's segmentation object for dividing into artificial cells. + * @param[in] compare The hit comparator to be used by this detector. + */

+ /** + * Implementation of Geant4's G4VSensitiveDetector::Initialize method. + * @param[in] hc The hit collection of the event. + */ + virtual void Initialize(G4HCofThisEvent* hc); + + /** + * Implementation of Geant4's G4VSensitiveDetector::EndOfEvent method. + * @param[in] hc The hit collection of the event. + */ + virtual void EndOfEvent(G4HCofThisEvent* hc); + + /** + * Get the segmentation of this detector or 0 if unset. + * @return The detector's segmentation. + */

+ + /** + * Find a hit in the given hit collection using the current HitComparator. + * @param[in] The hit to find. + * @param[in] The index of the hits collection. + * @return The found hit or 0 if not found. + */

+ + /** + * Get the total energy deposition in this detector by hits collection index. + * @param[in] nhC The index of the hits collection. + * @return The total energy deposition in the given hits collection. + */

+ /** + * Get a list of CalorimeterHit objects created by this detector. + * @return The list of CalorimeterHit objects. + */ + CalorimeterHitList getCalorimeterHitList(); + + /** + * Get a list of CalorimeterHit objects by hits collection index. + * @param[in] nHC The index of the hit collection. + */ + CalorimeterHitList getCalorimeterHitList(G4int nHC);

lcdd/include/lcdd/detectors

Segmentation.hh 1.1 -> 1.2

diff -u -r1.1 -r1.2
--- Segmentation.hh	1 Jul 2013 21:00:41 -0000	1.1
+++ Segmentation.hh	2 Jul 2013 01:46:54 -0000	1.2
@@ -1,4 +1,4 @@

-// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/Segmentation.hh,v 1.1 2013/07/01 21:00:41 jeremy Exp $

+// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/Segmentation.hh,v 1.2 2013/07/02 01:46:54 jeremy Exp $

 
 #ifndef LCDD_DETECTORS_SEGMENTATION_HH
 #define LCDD_DETECTORS_SEGMENTATION_HH 1

@@ -12,16 +12,24 @@

 #include <vector>
 
 /**

- * @brief Segmentation base class.

+ * This is the base class for calorimeter Segmentation implementations.

  * @todo Add method setVolume(G4LogicalVolume*) for setting up segmentation with current step volume.
  */
 class Segmentation
 {
 public:

+
+	/**
+	 * Defines the basic type of Segmentation, e.g. projective or non-projective.
+	 */

     enum EType
     {
         eProjective = 1, eNonprojective
     };

+
+    /**
+     * Type definition for list of bin names.
+     */

     typedef std::vector<std::string> BinNames;
 
 public:

@@ -31,22 +39,28 @@

 public:
 
     /**

-     * Compute the global hit position from a step.

+     * Compute the global hit position from a step using this Segmentation.
+     * @param[in] aStep The Geant4 step.

      */
     virtual G4ThreeVector getGlobalHitPos(const G4Step* aStep);
 
     /**
      * Set the identifier bin values from a step.

+     * @param[in] aStep The Geant4 step.

*/

-    virtual void setBins(const G4Step*) = 0;

+    virtual void setBins(const G4Step* aStep) = 0;

/**

-     * Add valid bin names to this segmentation.

+     * Add the list of valid bin names.
+     * @note This should only be called once.

      */
     virtual void setBinNames() = 0;
 
     /**
      * Compute the bin given a coordinate in one dimension.

+     * @param[in] localDim The 1D coordinate value.
+     * @param[in] gridDim  The dimension of the readout grid.
+     * @return The value of the bin at that coordinate.

      */
     static int computeBin(double localDim, double gridDim)
     {

@@ -55,25 +69,43 @@

     }
 
     /**

-     * Compute the coordinate in one dimension given a bin value.

+     * Compute the coordinate of a cell center at a given a bin value.
+     * @param[in] bin  The bin value.
+     * @param[in] incr The grid size.
+     * @return The coordinate of the cell center.

      */
     static double computeDim(const int &bin, const double &incr)
     {
         return (double(bin) + .5) * incr;
     }

-    // DEPRECATED
-    // Used by G4OpticalCalorimeter only.

+    /**
+     * @deprecated Only used by G4OpticalCalorimeter.
+     * @todo Move to G4OpticalCalorimeter.
+     */

     virtual G4ThreeVector getGlobalHitPosPreStep(const G4StepPoint* aPreStepPoint);

-    // DEPRECATED
-    // Used by G4OpticalCalorimeter only.

+    /**
+     * @deprecated Only used by G4OpticalCalorimeter.
+     * @todo Move to G4OpticalCalorimeter.
+     */

     G4ThreeVector getLocalHitPos(const G4ThreeVector& localStepPos);

+    /**
+     * Reset the current bin values to all zeros.
+     */

     void resetBins();

+    /**
+     * Get the type of the segmentation.
+     * @return The segmentation type as an enum.
+     */

     EType getType();

+    /**
+     * Get a string for this segmentation type.
+     * @return The segmentation type as a string.
+     */

     inline const G4String& getTypeString()
     {
         static G4String typestr;

@@ -88,57 +120,99 @@

         return typestr;
     }

+    /**
+     * Get a bin value from an index.
+     * @param[in] idx The index of the bin.
+     * @return The bin value.
+     * @todo Change this method's name to "getBinValue".
+     */

     inline int getBin(int idx)
     {
         return m_bins.at(idx);
     }

+    /**
+     * Get the name of a bin from an index.
+     * @param[in] idx The bin index.
+     * @return The name of the bin.
+     */

     inline const std::string& getBinName(int idx)
     {
         return m_binNames.at(idx);
     }

+    /**
+     * Add a bin name to the end of the list.
+     * @param[in] The name of the bin.
+     */

     inline void addBinName(const std::string& binName)
     {
         m_binNames.push_back(binName);
     }

+    /**
+     * Set the bin value.
+     * @param[in] binIdx The index of the bin.
+     * @param[in] binVal The value of the bin.
+     * @todo Change method name to "setBinValue".
+     */

     void setBin(int binIdx, int binVal);

+    /**
+     * Get the number of bins defined by this Segmentation.
+     * @return The number of bins.
+     */

     int getNumberOfBins();

+    /**
+     * Get a list of current bin values.
+     * @return A list of bin values.
+     */

     const std::vector<int>& getBins();

+    /**
+     * Get a list of bin names.
+     * @return The list of bin names.
+     */

     const std::vector<std::string>& getBinNames()
     {
         return m_binNames;
     }

-    // Print the bins.

+    /**
+     * Print this object's bin values to an output stream.
+     * @param[in] os The output stream.
+     */

     void printOutBins(std::ostream& os)
     {
         printOutBins(os, m_bins);
     }

+    /**
+     * Print the bin values to an output stream.
+     * @param[in] os   The output stream.
+     * @param[in] bins The list of bin values.
+     */

     static void printOutBins(std::ostream& os, const std::vector<int>& bins);
 
     /*
      * Check whether the solid is valid for this segmentation.

+     * @return True if solid is valid; false if not.

      */
     virtual bool isValidSolid(G4VSolid*);
 
 private:

-    // bin values

+    /** The current bin values. */

     std::vector<int> m_bins;

-    // bin names

+    /** The list of bin names. */

     BinNames m_binNames;

-    // number of numbers

+    /** The number of bins. */

     int m_numBins;

-    // type of segmentation

+    /** The type of Segmentation. */

     EType m_type;
 };

Commit in `lcdd` on MAIN
`include/lcdd/bfield/BoxDipole.hh`	+15	-1	1.2 -> 1.3
`/Cartesian3DMagneticFieldMap.hh`	+14	-2	1.3 -> 1.4
`/Dipole.hh`	+9	-2	1.1 -> 1.2
`/FieldManager.hh`	+37	-4	1.2 -> 1.3
`/MagneticFieldOverlay.hh`	+9	-4	1.3 -> 1.4
`include/lcdd/detectors/CalorimeterHitProcessor.hh`	+3	-3	1.3 -> 1.4
`/CalorimeterSD.hh`	+95	-10	1.1 -> 1.2
`/Segmentation.hh`	+89	-15	1.1 -> 1.2
`src/lcdd/detectors/CalorimeterSD.cc`	+8	-8	1.1 -> 1.2
	+279	-49