TrigVSI::VtxMap< WrkVrt, Cord > Class Template Reference

The vertex map class to be used to find multi-track vertices. More...

#include <VtxMap.h>

Collaboration diagram for TrigVSI::VtxMap< WrkVrt, Cord >:

Classes
class	Cell
	The class of a cell in 3D histogram. More...
class	CellCluster
	Stores the result of vertex clustering performed in VtxMap. More...

Public Member Functions
	VtxMap (TH3D *ptr)
	VtxMap (std::unique_ptr< TH3D > &&uptr)
	VtxMap ()
	~VtxMap ()
VtxMap &	operator= (VtxMap &&)=default
	Move assignment operator. More...
	VtxMap (VtxMap &&)=default
void	Fill (const WrkVrt *)
	Fill vertex map with vertex from its pointer. More...
bool	isInMapVolume (const KDPoint< double, 3 > &) const
	Check if the point is inside the map volume. More...
bool	isInMapVolume (double, double, double) const
	Check if the point is inside the map volume. More...
bool	isInMapVolume (int, int, int) const
	Check if the point is inside the map volume. More...
KDPoint< double, 3 >	getBinCenter (int) const
	Get bin center position in KDPoint with specified coordinate. More...
int	getVtxNum (double, double, double) const
	Count vertex number in the cell at the given position. More...
void	lock ()
	Lock the map to prevent adding vertex after clustering. More...
void	unlock ()
	Unlock the map. Not recomended. More...
void	Reset ()
	Reset vertex map hist, cell list and vertex list. More...
void	ClusterizeCells (double, size_t)
	Generate clusters. More...
std::vector< Cluster< int > >	getClustersBin () const
	Return a copy of list of clusters consist of bin ID. More...
size_t	nClusters () const
	Return the number of the clusters. More...
CellCluster	getCluster (size_t)
	Retrieve clustering result as CellCluster object. More...
std::vector< const WrkVrt * >	getVtxInCluster (size_t)
	Retrieve list of vertices in i-th cluster. More...

Private Member Functions
void	Fill (double, double, double)
	Private function to fill vertex map from position. More...
std::vector< int >	getNeighborCells_ (const int &, double)
	Region query function to be passed to DBScan. More...

Private Attributes
std::unique_ptr< TH3D >	m_mapHist
std::unordered_set< int >	m_activeCells
std::unordered_map< int, Cell >	m_cellVtxDict
bool	m_locked = false
DBScan< int >	m_dbscan

Detailed Description

template<typename WrkVrt, typename Cord>
class TrigVSI::VtxMap< WrkVrt, Cord >

The vertex map class to be used to find multi-track vertices.

First, Fill() vertex map and lock() it. Once the map is locked, you can't Fill() it anymore. Then execute ClusterizeCells() to perform clustering. This can't be executed until the map is locked. You can read the result by retrieving cell clusters through getCluster().

Definition at line 40 of file VtxMap.h.

Constructor & Destructor Documentation

VtxMap() [1/4]

template<typename WrkVrt , typename Cord >

TrigVSI::VtxMap< WrkVrt, Cord >::VtxMap ( TH3D *  ptr )

inline

Definition at line 45 of file VtxMap.h.

: m_mapHist( std::unique_ptr<TH3D>(ptr) ){};

VtxMap() [2/4]

template<typename WrkVrt , typename Cord >

TrigVSI::VtxMap< WrkVrt, Cord >::VtxMap ( std::unique_ptr< TH3D > &&  uptr )

inline

Definition at line 46 of file VtxMap.h.

: m_mapHist( std::move(uptr) ){};

VtxMap() [3/4]

template<typename WrkVrt , typename Cord >

TrigVSI::VtxMap< WrkVrt, Cord >::VtxMap ( )

inline

Definition at line 47 of file VtxMap.h.

{};

~VtxMap()

template<typename WrkVrt , typename Cord >

TrigVSI::VtxMap< WrkVrt, Cord >::~VtxMap ( )

inline

Definition at line 48 of file VtxMap.h.

{};

VtxMap() [4/4]

template<typename WrkVrt , typename Cord >

TrigVSI::VtxMap< WrkVrt, Cord >::VtxMap ( VtxMap< WrkVrt, Cord > &&  )

default

Member Function Documentation

ClusterizeCells()

template<typename WrkVrt , typename Cord >

void TrigVSI::VtxMap< WrkVrt, Cord >::ClusterizeCells	(	double	eps,
		size_t	minN
	)

Generate clusters.

This command locks the map so you cannot add any additional vertex after this process. If you need to add some, Reset() or unlock() and execute ClusterizeCells() again.

Parameters

[in]	eps	Radius to search neighbor points.
[in]	minN	Lower threshold to determine the cell as a core.

Definition at line 342 of file VtxMap.h.

{
   m_locked = true;
   DBScan<int>::RegionFunc region_query = [this](const int& glob_bin, double eps)
                                          {
                                             return getNeighborCells_(glob_bin, eps);
                                          };
   m_dbscan = DBScan<int>(m_activeCells, region_query);
   m_dbscan.clusterize(eps, minN);
}

Fill() [1/2]

template<typename WrkVrt , typename Cord >

void TrigVSI::VtxMap< WrkVrt, Cord >::Fill

(

const WrkVrt *

vtx_ptr

)

Fill vertex map with vertex from its pointer.

Do nothing when the map is locked.

Parameters

[in]

vtx_ptr

Vertex to be added to the vertex map.

Definition at line 308 of file VtxMap.h.

{
   if (m_locked)  return;
 
   // Get position of vertex with projection to map region.
   TVector3 vec( vtx_ptr->x(), vtx_ptr->y(), vtx_ptr->z() );
   KDPoint<double,3> pos = Cord::Proj( Cord::XYZtoX123(vec) );
   double x = pos[0];
   double y = pos[1];
   double z = pos[2];
 
   if ( !isInMapVolume(x,y,z) ) return;
 
   Fill(x,y,z);
 
   size_t ibin = m_mapHist->FindFixBin(x, y, z);
   auto cell_itr = m_cellVtxDict.find( ibin );
   if ( cell_itr != m_cellVtxDict.end() && cell_itr->second.getId() == static_cast<int>(ibin) ) {
      cell_itr->second.emplace_back( vtx_ptr );
   }
   else {
      m_cellVtxDict.emplace( ibin, Cell(ibin, getBinCenter(ibin), vtx_ptr) );
   }
}

Fill() [2/2]

template<typename WrkVrt , typename Cord >

void TrigVSI::VtxMap< WrkVrt, Cord >::Fill ( double  x, double  y, double  z  )

private

Private function to fill vertex map from position.

Takes the position in specified coordinate as inputs.

Definition at line 294 of file VtxMap.h.

{
   if (m_locked)  return;
   m_mapHist->Fill(x, y, z);
   m_activeCells.emplace( m_mapHist->FindFixBin(x, y, z) );
}

getBinCenter()

template<typename WrkVrt , typename Cord >

KDPoint< double, 3 > TrigVSI::VtxMap< WrkVrt, Cord >::getBinCenter ( int  ibin ) const

inline

Get bin center position in KDPoint with specified coordinate.

Definition at line 275 of file VtxMap.h.

{
   int xbin; int ybin; int zbin;
   m_mapHist->GetBinXYZ(ibin, xbin, ybin, zbin);
   double x = m_mapHist->GetXaxis()->GetBinCenter(xbin);
   double y = m_mapHist->GetYaxis()->GetBinCenter(ybin);
   double z = m_mapHist->GetZaxis()->GetBinCenter(zbin);
 
   KDPoint<double, 3> pos_tmp({x,y,z});
   return pos_tmp;
}

getCluster()

template<typename WrkVrt , typename Cord >

VtxMap< WrkVrt, Cord >::CellCluster TrigVSI::VtxMap< WrkVrt, Cord >::getCluster

(

size_t

icls

)

Retrieve clustering result as CellCluster object.

Definition at line 420 of file VtxMap.h.

{
   const Cluster<int>& cls = m_dbscan.getCluster(icls);
   std::vector<Cell*> v_tmp;
 
   std::vector<int> cell_ids = cls.getPoints();
   for (const auto ibin : cell_ids) {
      Cell& cell = m_cellVtxDict[ibin];
      if ( ibin != cell.getId() ) continue;
      v_tmp.emplace_back( &cell );
   }
   VtxMap<WrkVrt,Cord>::CellCluster cls_tmp( std::move(v_tmp) );
   return cls_tmp;
}

getClustersBin()

template<typename WrkVrt , typename Cord >

std::vector<Cluster<int> > TrigVSI::VtxMap< WrkVrt, Cord >::getClustersBin ( ) const

inline

Return a copy of list of clusters consist of bin ID.

Definition at line 186 of file VtxMap.h.

{ return  m_dbscan.getClusters(); };

getNeighborCells_()

template<typename WrkVrt , typename Cord >

std::vector< int > TrigVSI::VtxMap< WrkVrt, Cord >::getNeighborCells_ ( const int &  glob_bin, double  eps  )

private

Region query function to be passed to DBScan.

Definition at line 358 of file VtxMap.h.

{
   std::vector<int> tmp;
   int d = static_cast<int>(eps);
 
   int binx = 0;
   int biny = 0;
   int binz = 0;
   m_mapHist->GetBinXYZ(glob_bin, binx, biny, binz);
 
   KDPoint<int,3> v_ibin;
 
   if ( !(isInMapVolume(binx, biny, binz)) ) return tmp;
 
   for (int ix = binx - d; ix <= binx + d; ix++) {
      for (int iy = biny - d; iy <= biny + d; iy++) {
         for (int iz = binz - d; iz <= binz + d; iz++) {
            //
            v_ibin[0] = ix; v_ibin[1] = iy; v_ibin[2] = iz;
 
            // Convert coordinate with projection function
            v_ibin = Cord::ProjBin(v_ibin, m_mapHist);
 
            // If current cell is self, skip it.
            if ( v_ibin[0] == binx && v_ibin[1] == biny && v_ibin[2] == binz ) continue;
 
            // If cerrent cell is not in map volme, skip it.
            if ( !(isInMapVolume(v_ibin[0], v_ibin[1], v_ibin[2])) ) continue;
 
            // If there is no entry in current cell, skip it.
            if ( m_mapHist->GetBinContent(m_mapHist->GetBin(v_ibin[0], v_ibin[1], v_ibin[2])) < 1. ) continue;
            tmp.emplace_back(m_mapHist->GetBin(v_ibin[0], v_ibin[1], v_ibin[2]));
            //
         }
      }
   }
   //
   return tmp;
}

getVtxInCluster()

template<typename WrkVrt , typename Cord >

std::vector< const WrkVrt * > TrigVSI::VtxMap< WrkVrt, Cord >::getVtxInCluster

(

size_t

icls

)

Retrieve list of vertices in i-th cluster.

Definition at line 403 of file VtxMap.h.

{
   Cluster<int> cls = m_dbscan.getClusters().at(icls);
 
   std::vector<const WrkVrt*> v_tmp;
   for (const auto& ibin : cls.Points()) {
      std::vector<const WrkVrt*> v_vtx = m_cellVtxDict[ibin].getVtxList();
      v_tmp.insert( v_tmp.end(), v_vtx.begin(), v_vtx.end() );
   }
   return v_tmp;
}

getVtxNum()

template<typename WrkVrt , typename Cord >

int TrigVSI::VtxMap< WrkVrt, Cord >::getVtxNum ( double  x, double  y, double  z  ) const

inline

Count vertex number in the cell at the given position.

Return -1 when given position is out from the range ( Without considering projection).

Definition at line 263 of file VtxMap.h.

{
   if ( !isInMapVolume(x, y, z) ) return -1;
   int ibin = m_mapHist->FindFixBin(x, y, z);
   return m_mapHist->GetBinContent(ibin);
}

isInMapVolume() [1/3]

template<typename WrkVrt , typename Cord >

bool TrigVSI::VtxMap< WrkVrt, Cord >::isInMapVolume ( const KDPoint< double, 3 > &  point ) const

inline

Check if the point is inside the map volume.

Parameters

[in]

point

KDPoint to check.

This check does not consider the projection.

Definition at line 219 of file VtxMap.h.

{
   return VtxMap<WrkVrt,Cord>::isInMapVolume(point[0], point[1], point[2]);
}

isInMapVolume() [2/3]

template<typename WrkVrt , typename Cord >

bool TrigVSI::VtxMap< WrkVrt, Cord >::isInMapVolume ( double  x1, double  x2, double  x3  ) const

inline

Check if the point is inside the map volume.

Parameters

[in]	x1	x1 component in specified coordinate.
[in]	x2	x2 component in specified coordinate.
[in]	x3	x3 component in specified coordinate.

This check does not consider the projection.

Definition at line 233 of file VtxMap.h.

{
   if ( m_mapHist->GetXaxis()->FindFixBin(x1) < 1 || m_mapHist->GetXaxis()->FindFixBin(x1) > m_mapHist->GetNbinsX() ) return false;
   if ( m_mapHist->GetYaxis()->FindFixBin(x2) < 1 || m_mapHist->GetYaxis()->FindFixBin(x2) > m_mapHist->GetNbinsY() ) return false;
   if ( m_mapHist->GetZaxis()->FindFixBin(x3) < 1 || m_mapHist->GetZaxis()->FindFixBin(x3) > m_mapHist->GetNbinsZ() ) return false;
   return true;
}

isInMapVolume() [3/3]

template<typename WrkVrt , typename Cord >

bool TrigVSI::VtxMap< WrkVrt, Cord >::isInMapVolume ( int  ibinx, int  ibiny, int  ibinz  ) const

inline

Check if the point is inside the map volume.

Parameters

[in]	ibinx	ibin in x1 axis.
[in]	ibiny	ibin in x2 axis.
[in]	ibinz	ibin in x3 axis.

Definition at line 249 of file VtxMap.h.

{
   if ( ibinx < 1 || ibinx > m_mapHist->GetNbinsX() ) return false;
   if ( ibiny < 1 || ibiny > m_mapHist->GetNbinsY() ) return false;
   if ( ibinz < 1 || ibinz > m_mapHist->GetNbinsZ() ) return false;
   return true;
}

lock()

template<typename WrkVrt , typename Cord >

void TrigVSI::VtxMap< WrkVrt, Cord >::lock ( )

inline

Lock the map to prevent adding vertex after clustering.

Definition at line 169 of file VtxMap.h.

{ m_locked = true;  };

nClusters()

template<typename WrkVrt , typename Cord >

size_t TrigVSI::VtxMap< WrkVrt, Cord >::nClusters ( ) const

inline

Return the number of the clusters.

Definition at line 188 of file VtxMap.h.

{ return m_dbscan.nClusters(); };

operator=()

template<typename WrkVrt , typename Cord >

VtxMap& TrigVSI::VtxMap< WrkVrt, Cord >::operator= ( VtxMap< WrkVrt, Cord > &&  )

default

Move assignment operator.

Reset()

template<typename WrkVrt , typename Cord >

void TrigVSI::VtxMap< WrkVrt, Cord >::Reset ( )

inline

Reset vertex map hist, cell list and vertex list.

Definition at line 174 of file VtxMap.h.

      {
         m_mapHist->Reset();
         m_activeCells.clear();
         m_cellVtxDict.clear();
         m_locked = false;
         m_dbscan = DBScan<int>();
      }

unlock()

template<typename WrkVrt , typename Cord >

void TrigVSI::VtxMap< WrkVrt, Cord >::unlock ( )

inline

Unlock the map. Not recomended.

Definition at line 171 of file VtxMap.h.

{ m_locked = false; };

Member Data Documentation

m_activeCells

template<typename WrkVrt , typename Cord >

std::unordered_set<int> TrigVSI::VtxMap< WrkVrt, Cord >::m_activeCells

private

Definition at line 198 of file VtxMap.h.

m_cellVtxDict

template<typename WrkVrt , typename Cord >

std::unordered_map<int, Cell> TrigVSI::VtxMap< WrkVrt, Cord >::m_cellVtxDict

private

Definition at line 199 of file VtxMap.h.

m_dbscan

template<typename WrkVrt , typename Cord >

DBScan<int> TrigVSI::VtxMap< WrkVrt, Cord >::m_dbscan

private

Definition at line 201 of file VtxMap.h.

m_locked

template<typename WrkVrt , typename Cord >

bool TrigVSI::VtxMap< WrkVrt, Cord >::m_locked = false

private

Definition at line 200 of file VtxMap.h.

m_mapHist

template<typename WrkVrt , typename Cord >

std::unique_ptr<TH3D> TrigVSI::VtxMap< WrkVrt, Cord >::m_mapHist

private

Definition at line 197 of file VtxMap.h.

---

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

• VtxMap.h