dnadamage/include/DamageClassifier.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 /// \file DamageClassifier.hh
0029 /// \brief Definition of the DamageClassifier class
0030
0031 #ifndef DAMAGECLASSIFIER_HH
0032 #define DAMAGECLASSIFIER_HH
0033
0034 #include <map>
0035 #include <vector>
0036 #include "Damage.hh"
0037 #include "ClassifiedDamage.hh"
0038
0039 /// \brief defines the tool to make cluster of damage
0040 class DamageClassifier
0041 {
0042 public:
0043   /// \brief constructor
0044   DamageClassifier() = default;
0045   /// \brief destructor
0046   ~DamageClassifier() = default;
0047
0048   // Make a cluster of damage
0049   std::vector<ClassifiedDamage> MakeCluster(std::vector<Damage>&,unsigned int pDSBLength,bool pBase);
0050
0051   // Return the number of SSB inside a list of classified damage
0052   unsigned int GetNumSSB(const std::vector<ClassifiedDamage>&) const;
0053   // Return the number of DSB (simple + complex) inside a list of classified damage
0054   unsigned int GetNumDSB(const std::vector<ClassifiedDamage>&) const;
0055   // Return the number of complex DSB inside a list of classified damage
0056   unsigned int GetNumComplexDSB(const std::vector<ClassifiedDamage>&) const;
0057
0058   // Le Tuan Anh: Return the number of DSB (simple + complex) with the contribution
0059   //of at least 1 direct damage inside a list of classified damage
0060   unsigned int GetNumDSBwithDirectDamage(const std::vector<ClassifiedDamage>&) const;
0061   // Le Tuan Anh: Return the number of DSB (simple + complex) with the contribution
0062   //of at least 1 indirect damage inside a list of classified damage
0063   unsigned int GetNumDSBwithIndirectDamage(const std::vector<ClassifiedDamage>&) const;
0064   // Le Tuan Anh: Return the number of DSB (simple + complex) with the contribution of
0065   //both direct and indirect damage inside a list of classified damage
0066   unsigned int GetNumDSBwithBothDirectIndirectDamage(const std::vector<ClassifiedDamage>&) const;
0067
0068 // Utils to sort a vector of damage in maps to easily have access by event or by chromosome ID
0069 // First key is event, second is chromosome ID
0070 std::map<unsigned int,std::map<unsigned int,std::vector<Damage>>>
0071 SortDamageByEvent(const std::vector<Damage>&);
0072 // First key is chromosome ID, second is event
0073 std::map<unsigned int,std::map<unsigned int,std::vector<Damage>>>
0074 SortDamageByChromo(const std::vector<Damage>&);
0075
0076 };
0077
0078 #endif //