clustering/include/ClusterSBPoints.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 // This example is provided by the Geant4-DNA collaboration
0027 // Any report or published results obtained using the Geant4-DNA software
0028 // shall cite the following Geant4-DNA collaboration publication:
0029 // Med. Phys. 37 (2010) 4692-4708
0030 // The Geant4-DNA web site is available at http://geant4-dna.org
0031 //
0032 // Authors: Henri Payno and Yann Perrot
0033 //
0034 //
0035 /// \file ClusterSBPoints.hh
0036 /// \brief Definition of the ClusterSBPoints class
0037
0038 #ifndef CLUSTER_SB_POINT_HH
0039 #define CLUSTER_SB_POINT_HH
0040
0041 #include "SBPoint.hh"
0042
0043 #include <set>
0044 #include <vector>
0045
0046 /// \brief define a cluster of SB Points
0047 class ClusterSBPoints
0048 {
0049   public:
0050     ClusterSBPoints(std::set<SBPoint*> pPoints);
0051     ~ClusterSBPoints();
0052
0053     bool IsDSB() const { return fIsDoubleSB; }
0054
0055     bool IsSSB() const { return !IsDSB(); }
0056
0057     unsigned int GetSize() const { return fpRegisteredSBPoints.size(); }
0058
0059     void AddSBPoint(SBPoint* pSBPoint);
0060     G4ThreeVector GetBarycenter() const;
0061
0062     G4double GetEdep() const;
0063
0064     void FindAllPointsPossible(std::vector<SBPoint*>* ptToCheck, G4int minPts, G4double minDist);
0065
0066     /// \brief will set to all store SBPoint they are part of this cluster
0067     void NoticeInternalPts();
0068
0069     bool HasIn(const SBPoint*, G4double);
0070     bool HasInBarycenter(const SBPoint*, G4double);
0071
0072     void MergeWith(ClusterSBPoints*);
0073
0074     std::set<SBPoint*> GetRegistredSBPoints() const { return fpRegisteredSBPoints; }
0075
0076     void Clear();
0077
0078   private:
0079     void UpdateDoubleStrand();
0080
0081     unsigned int fSize;
0082     bool fIsDoubleSB;  // is a double strand break ?
0083
0084     std::set<SBPoint*> fpRegisteredSBPoints;
0085 };
0086
0087 #endif  // CLUSTER_SB_POINT_HH