ClusteringAlgo Class Reference

#include <ClusteringAlgo.hh>

Collaboration diagram for ClusteringAlgo:

Public Member Functions
	ClusteringAlgo (G4double pEps, G4int pMinPts, G4double pSPointsProb, G4double pEMinDamage, G4double pEMaxDamage)
	~ClusteringAlgo ()
G4double	GetEps ()
void	SetEps (G4double val)
G4int	GetMinPts ()
void	SetMinPts (G4int val)
G4double	GetSPointsProb ()
void	SetSPointsProb (G4double val)
G4double	GetEMinDamage ()
void	SetEMinDamage (G4double val)
G4double	GetEMaxDamage ()
void	SetEMaxDamage (G4double val)
void	RegisterDamage (G4ThreeVector, G4double)
std::map< G4int, G4int >	RunClustering ()
void	Purge ()
G4int	GetSSB () const
G4int	GetComplexSSB () const
G4int	GetDSB () const
std::map< G4int, G4int >	GetClusterSizeDistribution ()

Private Member Functions
G4bool	IsInSensitiveArea ()
G4bool	IsEdepSufficient (G4double)
bool	FindCluster (SBPoint *pPt)
bool	AreOnTheSameCluster (G4ThreeVector, G4ThreeVector, G4double)
void	MergeClusters ()
void	IncludeUnassociatedPoints ()

Private Attributes
G4double	fEps
G4int	fMinPts
G4double	fSPointsProb
G4double	fEMinDamage
G4double	fEMaxDamage
std::vector< SBPoint * >	fpSetOfPoints
std::vector< ClusterSBPoints * >	fpClusters
unsigned int	fNextSBPointID
ClusteringAlgoMessenger *	fpClustAlgoMessenger

Detailed Description

Definition at line 49 of file ClusteringAlgo.hh.

Constructor & Destructor Documentation

ClusteringAlgo()

ClusteringAlgo::ClusteringAlgo	(	G4double	pEps,
		G4int	pMinPts,
		G4double	pSPointsProb,
		G4double	pEMinDamage,
		G4double	pEMaxDamage
	)

Definition at line 51 of file ClusteringAlgo.cc.

:fEps(pEps),fMinPts(pMinPts),
 fSPointsProb(pSPointsProb),fEMinDamage(pEMinDamage),fEMaxDamage(pEMaxDamage)
{
  fNextSBPointID = 0;
  fpClustAlgoMessenger = new ClusteringAlgoMessenger(this);
}

~ClusteringAlgo()

ClusteringAlgo::~ClusteringAlgo

(

)

Definition at line 62 of file ClusteringAlgo.cc.

{
  delete fpClustAlgoMessenger;
  Purge();
}

Here is the call graph for this function:

Member Function Documentation

AreOnTheSameCluster()

bool ClusteringAlgo::AreOnTheSameCluster ( G4ThreeVector  pPt1, G4ThreeVector  pPt2, G4double  pMinDist  )

private

Definition at line 255 of file ClusteringAlgo.cc.

{
  G4double x1=pPt1.x()/nm;
  G4double y1=pPt1.y()/nm;
  G4double z1=pPt1.z()/nm;

  G4double x2=pPt2.x()/nm;
  G4double y2=pPt2.y()/nm;
  G4double z2=pPt2.z()/nm;

  // if the two points are closed enough
  if(((x1-x2)*(x1-x2)+(y1-y2)*(y1-y2)+(z1-z2)*(z1-z2))<=
      (pMinDist/nm*pMinDist/nm))
  {
    return true;
  }else
  {
    return false;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

FindCluster()

bool ClusteringAlgo::FindCluster ( SBPoint *  pPt )

private

Definition at line 235 of file ClusteringAlgo.cc.

{
  assert(!pPt->HasCluster());
  std::vector<ClusterSBPoints*>::iterator itCluster;
  for(itCluster = fpClusters.begin();
      itCluster != fpClusters.end();
      ++itCluster)
  {
    //if((*itCluster)->hasIn(pPt, fEps))
    if((*itCluster)->HasInBarycenter(pPt, fEps))
    {
      (*itCluster)->AddSBPoint(pPt);
      return true;
    }
  }  
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetClusterSizeDistribution()

map< G4int, G4int > ClusteringAlgo::GetClusterSizeDistribution

(

)

Definition at line 333 of file ClusteringAlgo.cc.

{
  std::map<G4int,G4int>  sizeDistribution;
  sizeDistribution[1]=GetSSB();
  std::vector<ClusterSBPoints*>::const_iterator itCluster;
  for(itCluster = fpClusters.begin();
      itCluster != fpClusters.end();
      itCluster++)
  {
    sizeDistribution[(*itCluster)->GetSize()]++;
  }
  return sizeDistribution;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetComplexSSB()

G4int ClusteringAlgo::GetComplexSSB

(

)

const

Definition at line 297 of file ClusteringAlgo.cc.

{
  G4int nbSSB = 0;
  std::vector<ClusterSBPoints*>::const_iterator itCluster;
  for(itCluster = fpClusters.begin();
      itCluster != fpClusters.end();
      ++itCluster)
  {
    if((*itCluster)->IsSSB())
    {
      nbSSB ++;
    }
  }
  return nbSSB;
}

Here is the caller graph for this function:

GetDSB()

G4int ClusteringAlgo::GetDSB

(

)

const

Definition at line 315 of file ClusteringAlgo.cc.

{
  G4int nbDSB = 0;
  std::vector<ClusterSBPoints*>::const_iterator itCluster;
  for(itCluster = fpClusters.begin();
      itCluster != fpClusters.end();
      ++itCluster)
  {
    if((*itCluster)->IsDSB())
    {
      nbDSB ++;
    }
  }
  return nbDSB;
}

Here is the caller graph for this function:

GetEMaxDamage()

G4double ClusteringAlgo::GetEMaxDamage ( )

inline

Definition at line 90 of file ClusteringAlgo.hh.

  {
    return fEMaxDamage;
  };

GetEMinDamage()

G4double ClusteringAlgo::GetEMinDamage ( )

inline

Definition at line 82 of file ClusteringAlgo.hh.

  {
    return fEMinDamage;
  };

GetEps()

G4double ClusteringAlgo::GetEps ( )

inline

Definition at line 58 of file ClusteringAlgo.hh.

  {
    return fEps;
  };

GetMinPts()

G4int ClusteringAlgo::GetMinPts ( )

inline

Definition at line 66 of file ClusteringAlgo.hh.

  {
    return fMinPts;
  };

GetSPointsProb()

G4double ClusteringAlgo::GetSPointsProb ( )

inline

Definition at line 74 of file ClusteringAlgo.hh.

  {
    return fSPointsProb;
  };

GetSSB()

G4int ClusteringAlgo::GetSSB

(

)

const

Definition at line 279 of file ClusteringAlgo.cc.

{
  G4int nbSSB = 0;
  std::vector<SBPoint*>::const_iterator itSDSPt;
  for(itSDSPt = fpSetOfPoints.begin();
      itSDSPt != fpSetOfPoints.end();
      ++itSDSPt)
  {
    if(!(*itSDSPt)->HasCluster())
    {
      nbSSB++;
    }
  }
  return nbSSB;
}

Here is the caller graph for this function:

IncludeUnassociatedPoints()

void ClusteringAlgo::IncludeUnassociatedPoints ( )

private

Definition at line 216 of file ClusteringAlgo.cc.

{
  std::vector<SBPoint*>::iterator itVisitorPt;
  int nbPtSansCluster = 0;
  // Associate all point not in a cluster if possible ( to the first found cluster)
  for(itVisitorPt = fpSetOfPoints.begin();
      itVisitorPt != fpSetOfPoints.end();
      ++itVisitorPt)
  {
    if(!(*itVisitorPt)->HasCluster())
    {
      nbPtSansCluster ++;
      FindCluster(*itVisitorPt);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

IsEdepSufficient()

G4bool ClusteringAlgo::IsEdepSufficient ( G4double  pEdep )

private

Definition at line 79 of file ClusteringAlgo.cc.

{
  if(pEdep<fEMinDamage)
  {
    return false;
  }

  else if(pEdep>fEMaxDamage)
  {
    return true;
  }
  else
  {
    G4double proba = (pEdep/eV - fEMinDamage/eV)/
        (fEMaxDamage/eV-fEMinDamage/eV);
    return (proba>G4UniformRand());
  }

}

Here is the caller graph for this function:

IsInSensitiveArea()

G4bool ClusteringAlgo::IsInSensitiveArea ( )

private

Definition at line 71 of file ClusteringAlgo.cc.

{
  return fSPointsProb > G4UniformRand();
}

Here is the caller graph for this function:

MergeClusters()

void ClusteringAlgo::MergeClusters ( )

private

Definition at line 186 of file ClusteringAlgo.cc.

{
  std::vector<ClusterSBPoints*>::iterator itCluster1, itCluster2;
  for(itCluster1 = fpClusters.begin();
      itCluster1 != fpClusters.end();
      ++itCluster1)
  {
    G4ThreeVector baryCenterClust1 = (*itCluster1)->GetBarycenter();
    itCluster2 = itCluster1;
    itCluster2++;
    while(itCluster2 != fpClusters.end())
    {
      G4ThreeVector baryCenterClust2 = (*itCluster2)->GetBarycenter();
      // if we can merge both cluster
      if(AreOnTheSameCluster(baryCenterClust1, baryCenterClust2,fEps))
      {
        (*itCluster1)->MergeWith(*itCluster2);
        delete *itCluster2;
        fpClusters.erase(itCluster2);
        return MergeClusters();
      }else
      {
        itCluster2++;
      }
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Purge()

void ClusteringAlgo::Purge

(

)

Definition at line 349 of file ClusteringAlgo.cc.

{
  fNextSBPointID = 0;
  std::vector<ClusterSBPoints*>::iterator itCluster;
  for(itCluster = fpClusters.begin();
      itCluster != fpClusters.end();
      ++itCluster)
  {
    delete *itCluster;
    *itCluster = NULL;
  }  
  fpClusters.clear();
  std::vector<SBPoint*>::iterator itPt;
  for(itPt = fpSetOfPoints.begin();
      itPt != fpSetOfPoints.end();
      ++itPt)
  {
    delete *itPt;
    *itPt = NULL;
  }
  fpSetOfPoints.clear();
}

Here is the caller graph for this function:

RegisterDamage()

void ClusteringAlgo::RegisterDamage	(	G4ThreeVector	pPos,
		G4double	pEdep
	)

Definition at line 105 of file ClusteringAlgo.cc.

{
  if(IsEdepSufficient(pEdep))
  {
    if(IsInSensitiveArea())
    {
      fpSetOfPoints.push_back( new SBPoint(fNextSBPointID++, pPos, pEdep));
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

RunClustering()

map< G4int, G4int > ClusteringAlgo::RunClustering

(

)

Definition at line 118 of file ClusteringAlgo.cc.

{

  // quick sort style
  // create cluster
  std::vector<SBPoint*>::iterator itVisitorPt, itObservedPt;
  for(itVisitorPt = fpSetOfPoints.begin();
      itVisitorPt != fpSetOfPoints.end();
      ++itVisitorPt  )
  {
    itObservedPt = itVisitorPt;
    itObservedPt ++;
    while(itObservedPt != fpSetOfPoints.end() )
    {
      // if at least one of the two points has not a cluster
      if(!((*itObservedPt)->HasCluster() && (*itVisitorPt)->HasCluster()))
      {
        if(AreOnTheSameCluster( (*itObservedPt)->GetPosition(),
                                (*itVisitorPt)->GetPosition(),fEps))
        {
          // if none has a cluster. Create a new one
          if(!(*itObservedPt)->HasCluster() && !(*itVisitorPt)->HasCluster())
          {
            // create the new cluster
            set<SBPoint*> clusterPoints;
            clusterPoints.insert((*itObservedPt));
            clusterPoints.insert((*itVisitorPt));
            ClusterSBPoints* lCluster = new ClusterSBPoints(clusterPoints);
            assert(lCluster);
            fpClusters.push_back(lCluster);
            assert(lCluster);
            // inform SB point that they are part of a cluster now
            assert(lCluster);
            (*itObservedPt)->SetCluster(lCluster);
            assert(lCluster);
            (*itVisitorPt)->SetCluster(lCluster);
          }else
          {
            // add the point to the existing cluster
            if((*itObservedPt)->HasCluster())
            {
              (*itObservedPt)->GetCluster()->AddSBPoint((*itVisitorPt));
              (*itVisitorPt)->SetCluster((*itObservedPt)->GetCluster());
            }

            if((*itVisitorPt)->HasCluster())
            {
              (*itVisitorPt)->GetCluster()->AddSBPoint((*itObservedPt));
              (*itObservedPt)->SetCluster((*itVisitorPt)->GetCluster());
            }
          }
        }
      }
      ++itObservedPt;
    }
  }

  // associate isolated points and merge clusters
  IncludeUnassociatedPoints();
  MergeClusters();

  // return cluster size distribution
  return GetClusterSizeDistribution();
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetEMaxDamage()

void ClusteringAlgo::SetEMaxDamage ( G4double  val )

inline

Definition at line 94 of file ClusteringAlgo.hh.

  {
    fEMaxDamage=val;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

SetEMinDamage()

void ClusteringAlgo::SetEMinDamage ( G4double  val )

inline

Definition at line 86 of file ClusteringAlgo.hh.

  {
    fEMinDamage=val;
  };

Here is the caller graph for this function:

SetEps()

void ClusteringAlgo::SetEps ( G4double  val )

inline

Definition at line 62 of file ClusteringAlgo.hh.

  {
    fEps=val;
  };

Here is the caller graph for this function:

SetMinPts()

void ClusteringAlgo::SetMinPts ( G4int  val )

inline

Definition at line 70 of file ClusteringAlgo.hh.

  {
    fMinPts=val;
  };

Here is the caller graph for this function:

SetSPointsProb()

void ClusteringAlgo::SetSPointsProb ( G4double  val )

inline

Definition at line 78 of file ClusteringAlgo.hh.

  {
    fSPointsProb=val;
  };

Here is the caller graph for this function:

Member Data Documentation

fEMaxDamage

G4double ClusteringAlgo::fEMaxDamage

private

Definition at line 138 of file ClusteringAlgo.hh.

fEMinDamage

G4double ClusteringAlgo::fEMinDamage

private

Definition at line 137 of file ClusteringAlgo.hh.

fEps

G4double ClusteringAlgo::fEps

private

Definition at line 134 of file ClusteringAlgo.hh.

fMinPts

G4int ClusteringAlgo::fMinPts

private

Definition at line 135 of file ClusteringAlgo.hh.

fNextSBPointID

unsigned int ClusteringAlgo::fNextSBPointID

private

Definition at line 145 of file ClusteringAlgo.hh.

fpClustAlgoMessenger

ClusteringAlgoMessenger* ClusteringAlgo::fpClustAlgoMessenger

private

Definition at line 147 of file ClusteringAlgo.hh.

fpClusters

std::vector<ClusterSBPoints*> ClusteringAlgo::fpClusters

private

Definition at line 143 of file ClusteringAlgo.hh.

fpSetOfPoints

std::vector<SBPoint*> ClusteringAlgo::fpSetOfPoints

private

Definition at line 141 of file ClusteringAlgo.hh.

fSPointsProb

G4double ClusteringAlgo::fSPointsProb

private

Definition at line 136 of file ClusteringAlgo.hh.

---

The documentation for this class was generated from the following files:

• ClusteringAlgo.hh
• ClusteringAlgo.cc