clustering/include/ClusteringAlgo.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 ClusteringAlgo.hh
0027 /// \brief Definition of the ClusteringAlgo class
0028
0029 // This example is provided by the Geant4-DNA collaboration
0030 // Any report or published results obtained using the Geant4-DNA software
0031 // shall cite the following Geant4-DNA collaboration publication:
0032 // Med. Phys. 37 (2010) 4692-4708
0033 // The Geant4-DNA web site is available at http://geant4-dna.org
0034 //
0035 // Authors: Henri Payno and Yann Perrot
0036 //
0037 //
0038
0039 #ifndef ClusteringAlgo_H
0040 #define ClusteringAlgo_H 1
0041
0042 #include "ClusterSBPoints.hh"
0043 #include "SBPoint.hh"
0044
0045 #include <map>
0046
0047 class ClusteringAlgoMessenger;
0048
0049 class ClusteringAlgo
0050 {
0051   public:
0052     ClusteringAlgo(G4double pEps, G4int pMinPts, G4double pSPointsProb, G4double pEMinDamage,
0053                    G4double pEMaxDamage);
0054     ~ClusteringAlgo();
0055
0056     // Get Set methods
0057     G4double GetEps() { return fEps; };
0058     void SetEps(G4double val) { fEps = val; };
0059     G4int GetMinPts() { return fMinPts; };
0060     void SetMinPts(G4int val) { fMinPts = val; };
0061     G4double GetSPointsProb() { return fSPointsProb; };
0062     void SetSPointsProb(G4double val) { fSPointsProb = val; };
0063     G4double GetEMinDamage() { return fEMinDamage; };
0064     void SetEMinDamage(G4double val) { fEMinDamage = val; };
0065     G4double GetEMaxDamage() { return fEMaxDamage; };
0066     void SetEMaxDamage(G4double val) { fEMaxDamage = val; };
0067
0068     // Register a damage (position, edep)
0069     void RegisterDamage(G4ThreeVector, G4double);
0070
0071     // Clustering Algorithm
0072     std::map<G4int, G4int> RunClustering();
0073
0074     // Clean all data structures
0075     void Purge();
0076
0077     // Return the number of simple break
0078     G4int GetSSB() const;
0079     // Return the number of complex simple break
0080     G4int GetComplexSSB() const;
0081     // Return the number of double strand break
0082     G4int GetDSB() const;
0083     // Return a map representing cluster size distribution
0084     // first G4int : cluster size (1 = SSB)
0085     // second G4int : counts
0086     std::map<G4int, G4int> GetClusterSizeDistribution();
0087
0088   private:
0089     // Functions to check if SB candidate
0090     G4bool IsInSensitiveArea();
0091     G4bool IsEdepSufficient(G4double);
0092     // Check if a SB point can be merged to a cluster, and do it
0093     bool FindCluster(SBPoint* pPt);
0094     // Check if two points can be merged
0095     bool AreOnTheSameCluster(G4ThreeVector, G4ThreeVector, G4double);
0096     // Merge clusters
0097     void MergeClusters();
0098     // Add SSB to clusters
0099     void IncludeUnassociatedPoints();
0100
0101     // Parameters to run clustering algorithm
0102     G4double fEps;  // distance to merge SBPoints
0103     G4int fMinPts;  // number of SBPoints to create a cluster
0104     G4double fSPointsProb;  // probability for a point to be in the sensitive area
0105     G4double fEMinDamage;  // min energy to create a damage
0106     G4double fEMaxDamage;  // energy to have a probability to create a damage = 1
0107
0108     // Data structure containing all SB points
0109     std::vector<SBPoint*> fpSetOfPoints;
0110     // Datya structure containing all clusters
0111     std::vector<ClusterSBPoints*> fpClusters;
0112     // ID of the next SB point
0113     unsigned int fNextSBPointID;
0114
0115     ClusteringAlgoMessenger* fpClustAlgoMessenger;
0116 };
0117
0118 #endif