| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // This example is provided by the Geant4-DNA collaboration
27 // Any report or published results obtained using the Geant4-DNA software
28 // shall cite the following Geant4-DNA collaboration publication:
29 // Med. Phys. 37 (2010) 4692-4708
30 // The Geant4-DNA web site is available at http://geant4-dna.org
31 //
32 // Authors: Henri Payno and Yann Perrot
33 //
34 //
35 /// \file ClusteringAlgo.hh
36 /// \brief Definition of the ClustreringAlgo class
37
38 #ifndef ClusteringAlgo_H
39 #define ClusteringAlgo_H 1
40
41 #include "ClusterSBPoints.hh"
42 #include "SBPoint.hh"
43
44 #include <map>
45
46 class ClusteringAlgoMessenger;
47
48 class ClusteringAlgo
49 {
50 public:
51 ClusteringAlgo(G4double pEps, G4int pMinPts, G4double pSPointsProb, G4double pEMinDamage,
52 G4double pEMaxDamage);
53 ~ClusteringAlgo();
54
55 // Get Set methods
56 G4double GetEps() { return fEps; };
57 void SetEps(G4double val) { fEps = val; };
58 G4int GetMinPts() { return fMinPts; };
59 void SetMinPts(G4int val) { fMinPts = val; };
60 G4double GetSPointsProb() { return fSPointsProb; };
61 void SetSPointsProb(G4double val) { fSPointsProb = val; };
62 G4double GetEMinDamage() { return fEMinDamage; };
63 void SetEMinDamage(G4double val) { fEMinDamage = val; };
64 G4double GetEMaxDamage() { return fEMaxDamage; };
65 void SetEMaxDamage(G4double val) { fEMaxDamage = val; };
66
67 // Register a damage (position, edep)
68 void RegisterDamage(G4ThreeVector, G4double);
69
70 // Clustering Algorithm
71 std::map<G4int, G4int> RunClustering();
72
73 // Clean all data structures
74 void Purge();
75
76 // Return the number of simple break
77 G4int GetSSB() const;
78 // Return the number of complex simple break
79 G4int GetComplexSSB() const;
80 // Return the number of double strand break
81 G4int GetDSB() const;
82 // Return a map representing cluster size distribution
83 // first G4int : cluster size (1 = SSB)
84 // second G4int : counts
85 std::map<G4int, G4int> GetClusterSizeDistribution();
86
87 private:
88 // Functions to check if SB candidate
89 G4bool IsInSensitiveArea();
90 G4bool IsEdepSufficient(G4double);
91 // Check if a SB point can be merged to a cluster, and do it
92 bool FindCluster(SBPoint* pPt);
93 // Check if two points can be merged
94 bool AreOnTheSameCluster(G4ThreeVector, G4ThreeVector, G4double);
95 // Merge clusters
96 void MergeClusters();
97 // Add SSB to clusters
98 void IncludeUnassociatedPoints();
99
100 // Parameters to run clustering algorithm
101 G4double fEps; // distance to merge SBPoints
102 G4int fMinPts; // number of SBPoints to create a cluster
103 G4double fSPointsProb; // probability for a point to be in the sensitive area
104 G4double fEMinDamage; // min energy to create a damage
105 G4double fEMaxDamage; // energy to have a probability to create a damage = 1
106
107 // Data structure containing all SB points
108 std::vector<SBPoint*> fpSetOfPoints;
109 // Datya structure containing all clusters
110 std::vector<ClusterSBPoints*> fpClusters;
111 // ID of the next SB point
112 unsigned int fNextSBPointID;
113
114 ClusteringAlgoMessenger* fpClustAlgoMessenger;
115 };
116
117 #endif
118