Par04/include/Par04SensitiveDetector.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 /// \file Par04SensitiveDetector.hh
0027 /// \brief Definition of the Par04SensitiveDetector class
0028
0029 #ifndef PAR04SENSITIVEDETECTOR_HH
0030 #define PAR04SENSITIVEDETECTOR_HH
0031
0032 #include "Par04Hit.hh"  // for Par04Hit (ptr only), Par04...
0033
0034 #include "G4SystemOfUnits.hh"  // for m
0035 #include "G4ThreeVector.hh"  // for G4ThreeVector
0036 #include "G4VFastSimSensitiveDetector.hh"  // for G4VFastSimSensitiveDetector
0037 #include "G4VSensitiveDetector.hh"  // for G4VSensitiveDetector
0038
0039 #include <CLHEP/Units/SystemOfUnits.h>  // for m, pi
0040 #include <G4String.hh>  // for G4String
0041 #include <G4Types.hh>  // for G4bool, G4int
0042 #include <unordered_map>
0043 class G4FastHit;
0044 class G4FastTrack;
0045 class G4HCofThisEvent;
0046 class G4Step;
0047 class G4TouchableHistory;
0048
0049 /**
0050  * @brief Sensitive detector.
0051  *
0052  * Describes how to store the energy deposited within the detector.
0053  * It derives from two classes: G4VSensitiveDetector and
0054  * G4VFastSimSensitiveDetector. Addition of G4VFastSimSensitiveDetector is
0055  * necessary in order to handle the energy deposits from the fast simulation.
0056  *
0057  * Two ProcessHits() methods are introduced to handle energy deposited from full
0058  * (detailed) simulation, and from fast simulation. The common part is handled
0059  * by RetrieveAdnSetupHit() method.
0060  *
0061  */
0062
0063 class Par04SensitiveDetector : public G4VSensitiveDetector, public G4VFastSimSensitiveDetector
0064 {
0065   public:
0066     Par04SensitiveDetector(G4String aName);
0067     Par04SensitiveDetector(G4String aName, G4ThreeVector aNbOfCells, G4ThreeVector aNSizeOfCells);
0068     virtual ~Par04SensitiveDetector();
0069     /// Create hit collection
0070     virtual void Initialize(G4HCofThisEvent* HCE) final;
0071     /// Process energy deposit from the full simulation.
0072     virtual G4bool ProcessHits(G4Step* aStep, G4TouchableHistory* aROhist) final;
0073     /// Process energy deposit from the fast simulation.
0074     virtual G4bool ProcessHits(const G4FastHit* aHit, const G4FastTrack* aTrack,
0075                                G4TouchableHistory* aROhist) final;
0076     /// Process energy deposit - common part for full and fast simulation
0077     /// It is invoked from ProcessHits() methods, and sets basic hit properties
0078     /// (position, etc.), common for hit from fast and full simulation.
0079     Par04Hit* RetrieveAndSetupHit(G4ThreeVector aPosition);
0080     /// Rewrite hits map to a vector
0081     virtual void EndOfEvent(G4HCofThisEvent* aHC) final;
0082
0083   private:
0084     /// Collection of hits
0085     Par04HitsCollection* fHitsCollection = nullptr;
0086     /// Map of hits to be used in runtime
0087     std::unordered_map<G4int, std::unique_ptr<Par04Hit>> fHitsMap;
0088     /// ID of collection of hits
0089     G4int fHitCollectionID = -1;
0090     /// Number of mesh readout cells in cylindrical coordinates
0091     G4ThreeVector fMeshNbOfCells = {10, 10, 10};
0092     /// Size of mesh readout cells in cylindrical coordinates.
0093     G4ThreeVector fMeshSizeOfCells = {1 * m, 2 * CLHEP::pi / 10., 1 * m};
0094     /// Retrieved once per event: position of entering particle
0095     G4ThreeVector fEntrancePosition = {-1, -1, -1};
0096     /// Retrieved once per event: direction of entering particle
0097     G4ThreeVector fEntranceDirection = {-1, -1, -1};
0098 };
0099
0100 #endif /* PAR04SENSITIVEDETECTOR_HH */