Detailed Description

TH3 object which allow clusterization in cell density.

Created by KVClassFactory on Tue Sep 27 10:46:46 2016 Author: Eric BONNET

Definition at line 18 of file KVClust3D.h.

#include <KVClust3D.h>

Inheritance diagram for KVClust3D:

Public Member Functions
	KVClust3D ()
	Default constructor. More...

	KVClust3D (const char name, const char title, Int_t nbinsx, const Double_t xbins, Int_t nbinsy, const Double_t ybins, Int_t nbinsz, const Double_t *zbins)
	Constructor inherited from TH3D. More...

	KVClust3D (const char name, const char title, Int_t nbinsx, const Float_t xbins, Int_t nbinsy, const Float_t ybins, Int_t nbinsz, const Float_t *zbins)
	Constructor inherited from TH3D. More...

	KVClust3D (const char name, const char title, Int_t nbinsx, Double_t xlow, Double_t xup, Int_t nbinsy, Double_t ylow, Double_t yup, Int_t nbinsz, Double_t zlow, Double_t zup)
	Constructor inherited from TH3D. More...

virtual	~KVClust3D ()

void	Clusterize ()

TH3D *	GetClusterIndex () const

Int_t	GetNclusters () const

Int_t	GetNvoisins () const

Double_t *	GetPop () const

Int_t *	GetSize () const

Double_t	GetThreshold () const
	return the value of the threshold for the content of a cell to be considered has filled More...

Double_t	GetVolumeCell () const

Double_t	GetVolumeVoisin () const

Bool_t	IsLonelyCellsAreKept () const

void	PrintInputs () const

void	PrintResults () const

TH3D *	ProduceTH3D (const Char_t *name) const

void	ResetObjects ()

void	SetDensityThreshold (Double_t)
	Set density threshold on the content of a cell to be considered has filled. More...

void	SetLonelyCells (Bool_t)

void	SetNvoisins (Int_t)

void	SetThreshold (Double_t)
	Set threshold on the content of a cell to be considered has filled. More...

Private Member Functions
void	init ()
	initialization method More...

Private Attributes
TH3D *	fCluster
	3D histogram where index of each cluster is putted as content in the associated cells More...

Bool_t	fKeepLonelyCells
	tells if we keep or not lonely cells, par default kTRUE More...

TArrayI *	fNcells
	exemple sur une dimension les cellules de nx-fNvoisins a nx+fNvoisins sont prises en compte, par defaut =1 More...

Int_t	fNclusters
	number of clusters found by the Clusterize method More...

Int_t	fNvoisins

TArrayD *	fPop
	array where total contents of the clusters are stored More...

Double_t	fThreshold
	threshold on the content of each cell to be considered has filled More...

TH2D *	fVoisins
	internal histogram to gather possible connected clusters More...

Constructor & Destructor Documentation

◆ KVClust3D() [1/4]

KVClust3D::KVClust3D ( )

Default constructor.

Definition at line 38 of file KVClust3D.cpp.

◆ KVClust3D() [2/4]

KVClust3D::KVClust3D	(	const char *	name,
		const char *	title,
		Int_t	nbinsx,
		Double_t	xlow,
		Double_t	xup,
		Int_t	nbinsy,
		Double_t	ylow,
		Double_t	yup,
		Int_t	nbinsz,
		Double_t	zlow,
		Double_t	zup
	)

Constructor inherited from TH3D.

Definition at line 50 of file KVClust3D.cpp.

◆ KVClust3D() [3/4]

KVClust3D::KVClust3D	(	const char *	name,
		const char *	title,
		Int_t	nbinsx,
		const Float_t *	xbins,
		Int_t	nbinsy,
		const Float_t *	ybins,
		Int_t	nbinsz,
		const Float_t *	zbins
	)

Constructor inherited from TH3D.

Definition at line 63 of file KVClust3D.cpp.

◆ KVClust3D() [4/4]

KVClust3D::KVClust3D	(	const char *	name,
		const char *	title,
		Int_t	nbinsx,
		const Double_t *	xbins,
		Int_t	nbinsy,
		const Double_t *	ybins,
		Int_t	nbinsz,
		const Double_t *	zbins
	)

Constructor inherited from TH3D.

Definition at line 76 of file KVClust3D.cpp.

◆ ~KVClust3D()

KVClust3D::~KVClust3D ( )

virtual

Destructor delete fCluster; delete fVoisins; delete fNcells; delete fPop;

Definition at line 93 of file KVClust3D.cpp.

Member Function Documentation

◆ Clusterize()

void KVClust3D::Clusterize ( )

Apply clusterization of the 3D histogram For each cell, with a content greater than the threshold defined before using the SetThreshold() method, test the content of the closest neighbors (8) to see if they are connected At the end, a clone histogram is available, using this method : GetClusterIndex(). The content of its cells corresponds to the index of each found cluster

Definition at line 285 of file KVClust3D.cpp.

◆ GetClusterIndex()

TH3D * KVClust3D::GetClusterIndex ( ) const

return the clone 3D histogram where each cell has for content the index of the cluster it is associated to It's allow, afterward, for the user to calculate other observable associated to each clusters

Definition at line 608 of file KVClust3D.cpp.

◆ GetNclusters()

Int_t KVClust3D::GetNclusters ( ) const

return the number of clusters found by the Clusterize() method

Definition at line 543 of file KVClust3D.cpp.

◆ GetNvoisins()

Int_t KVClust3D::GetNvoisins ( ) const

Definition at line 139 of file KVClust3D.cpp.

◆ GetPop()

Double_t * KVClust3D::GetPop ( ) const

return the array of population (or total number of contents) associated to each cluster found by the Clusterize() method

Definition at line 572 of file KVClust3D.cpp.

◆ GetSize()

Int_t * KVClust3D::GetSize ( ) const

return the array of size (or number of cells) associated to each cluster found by the Clusterize() method

Definition at line 557 of file KVClust3D.cpp.

◆ GetThreshold()

Double_t KVClust3D::GetThreshold ( ) const

return the value of the threshold for the content of a cell to be considered has filled

Definition at line 217 of file KVClust3D.cpp.

◆ GetVolumeCell()

Double_t KVClust3D::GetVolumeCell ( ) const

Definition at line 149 of file KVClust3D.cpp.

◆ GetVolumeVoisin()

Double_t KVClust3D::GetVolumeVoisin ( ) const

Definition at line 159 of file KVClust3D.cpp.

◆ init()

void KVClust3D::init ( void )

private

initialization method

Definition at line 16 of file KVClust3D.cpp.

◆ IsLonelyCellsAreKept()

Bool_t KVClust3D::IsLonelyCellsAreKept ( ) const

Definition at line 119 of file KVClust3D.cpp.

◆ PrintInputs()

void KVClust3D::PrintInputs ( ) const

Definition at line 229 of file KVClust3D.cpp.

◆ PrintResults()

void KVClust3D::PrintResults ( ) const

print results of the Clusterize() method

Definition at line 587 of file KVClust3D.cpp.

◆ ProduceTH3D()

TH3D * KVClust3D::ProduceTH3D ( const Char_t * name ) const

Create TH3D object, clone of the KVClust3D object user has to delete it after its use

Definition at line 251 of file KVClust3D.cpp.

◆ ResetObjects()

void KVClust3D::ResetObjects ( )

Reset object associated to the KVClust3D object Don't reset the object it self

Definition at line 173 of file KVClust3D.cpp.

◆ SetDensityThreshold()

void KVClust3D::SetDensityThreshold ( Double_t value )

Set density threshold on the content of a cell to be considered has filled.

Definition at line 204 of file KVClust3D.cpp.

◆ SetLonelyCells()

void KVClust3D::SetLonelyCells ( Bool_t val )

Definition at line 109 of file KVClust3D.cpp.

◆ SetNvoisins()

void KVClust3D::SetNvoisins ( Int_t val )

Definition at line 129 of file KVClust3D.cpp.

◆ SetThreshold()

void KVClust3D::SetThreshold ( Double_t value )

Set threshold on the content of a cell to be considered has filled.

Definition at line 191 of file KVClust3D.cpp.

Member Data Documentation

◆ fCluster

TH3D* KVClust3D::fCluster

private

3D histogram where index of each cluster is putted as content in the associated cells

Definition at line 25 of file KVClust3D.h.

◆ fKeepLonelyCells

Bool_t KVClust3D::fKeepLonelyCells

private

tells if we keep or not lonely cells, par default kTRUE

Definition at line 26 of file KVClust3D.h.

◆ fNcells

TArrayI* KVClust3D::fNcells

private

exemple sur une dimension les cellules de nx-fNvoisins a nx+fNvoisins sont prises en compte, par defaut =1

array where size of the clusters are stored

Definition at line 29 of file KVClust3D.h.

◆ fNclusters

Int_t KVClust3D::fNclusters

private

number of clusters found by the Clusterize method

Definition at line 22 of file KVClust3D.h.

◆ fNvoisins

Int_t KVClust3D::fNvoisins

private

nombre de plus proches voisins a prendre en compte:

Definition at line 27 of file KVClust3D.h.

◆ fPop

TArrayD* KVClust3D::fPop

private

array where total contents of the clusters are stored

Definition at line 30 of file KVClust3D.h.

◆ fThreshold

Double_t KVClust3D::fThreshold

private

threshold on the content of each cell to be considered has filled

Definition at line 23 of file KVClust3D.h.

◆ fVoisins

TH2D* KVClust3D::fVoisins

private

internal histogram to gather possible connected clusters

Definition at line 24 of file KVClust3D.h.

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ KVClust3D() [1/4]

◆ KVClust3D() [2/4]

◆ KVClust3D() [3/4]

◆ KVClust3D() [4/4]

◆ ~KVClust3D()

Member Function Documentation

◆ Clusterize()

◆ GetClusterIndex()

◆ GetNclusters()

◆ GetNvoisins()

◆ GetPop()

◆ GetSize()

◆ GetThreshold()

◆ GetVolumeCell()

◆ GetVolumeVoisin()

◆ init()

◆ IsLonelyCellsAreKept()

◆ PrintInputs()

◆ PrintResults()

◆ ProduceTH3D()

◆ ResetObjects()

◆ SetDensityThreshold()

◆ SetLonelyCells()

◆ SetNvoisins()

◆ SetThreshold()

Member Data Documentation

◆ fCluster

◆ fKeepLonelyCells

◆ fNcells

◆ fNclusters

◆ fNvoisins

◆ fPop

◆ fThreshold

◆ fVoisins