HGCal_testbeam/include/SiPMSD.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 #ifndef SIPMSD_HH
0027 #define SIPMSD_HH
0028
0029 #include "SiPMHit.hh"
0030
0031 #include "G4VSensitiveDetector.hh"
0032 #include "G4Types.hh"
0033
0034 #include <map>
0035
0036 /**
0037  * @brief Sensitive detector for SiPMs
0038  *
0039  * Processes step information and stores it in SiPM hits.
0040  * Information is stored in units of:
0041  * - keV for energy
0042  * - cm for position
0043  *
0044  */
0045
0046 class SiPMSD : public G4VSensitiveDetector {
0047 public:
0048   explicit SiPMSD(G4String name);
0049   ~SiPMSD();
0050   /// Hits are processed and added to the temporary map of hit ID to hit
0051   /// pointer. Energy is stored in units of keV, and position in cm.
0052   G4bool ProcessHits(G4Step *step, G4TouchableHistory *ROhist);
0053
0054   void Initialize(G4HCofThisEvent *HCE);
0055   /// Temporary map of hits is stored in hit collection, to be retrieved
0056   /// for analysis by the event action
0057   void EndOfEvent(G4HCofThisEvent *HCE);
0058
0059 private:
0060   /// Hit collection stored in the event, filled in at the end of event based
0061   /// on temporary hits
0062   SiPMHitCollection *fHitCollection = nullptr;
0063   /// ID of hit collection
0064   G4int fHCID = -1;
0065   /// Temporary map of hits (ID: hit) collected within one event
0066   std::map<G4int, SiPMHit *> fTmpHits;
0067 };
0068 #endif /* SIPMSD_HH */