include/Geant4/G4PSTrackLength.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 //
0028
0029 #ifndef G4PSTrackLength_h
0030 #define G4PSTrackLength_h 1
0031
0032 #include "G4VPrimitiveScorer.hh"
0033 #include "G4THitsMap.hh"
0034
0035 ////////////////////////////////////////////////////////////////////////////////
0036 // (Description)
0037 //   This is a primitive scorer class for scoring track length.
0038 //
0039 //
0040 // Created: 2005-11-14  Tsukasa ASO, Akinori Kimura.
0041 // Modified: 2007-02-02 Tsukasa ASO, Add MultiplyKineticEnergy()
0042 //                                  and DivideByVelocity().
0043 //           2010-07-22   Introduce Unit specification.
0044 //
0045 //
0046 ///////////////////////////////////////////////////////////////////////////////
0047
0048 class G4PSTrackLength : public G4VPrimitiveScorer
0049 {
0050  public:
0051   G4PSTrackLength(G4String name, G4int depth = 0);
0052   G4PSTrackLength(G4String name, const G4String& unit, G4int depth = 0);
0053   ~G4PSTrackLength() override = default;
0054
0055   inline void Weighted(G4bool flg = true) { weighted = flg; }
0056   // Multiply track weight
0057
0058   void MultiplyKineticEnergy(G4bool flg = true);
0059   // Multiply Kinetic Energy
0060
0061   void DivideByVelocity(G4bool flg = true);
0062   // Divide by velocity
0063
0064   void Initialize(G4HCofThisEvent*) override;
0065   void clear() override;
0066   void PrintAll() override;
0067
0068   virtual void SetUnit(const G4String& unit);
0069
0070  protected:
0071   G4bool ProcessHits(G4Step*, G4TouchableHistory*) override;
0072   virtual void DefineUnitAndCategory();
0073
0074  private:
0075   G4int HCID;
0076   G4THitsMap<G4double>* EvtMap;
0077   G4bool weighted;
0078   G4bool multiplyKinE;
0079   G4bool divideByVelocity;
0080 };
0081 #endif