HGTD::Cluster< T > Class Template Reference

#include <Clustering.h>

Collaboration diagram for HGTD::Cluster< T >:

Public Member Functions
	Cluster ()
	Cluster (const std::vector< double > &v, const std::vector< double > &v_sigma)
	Cluster (const std::vector< double > &v, const std::vector< double > &v_sigma, const T &entry)
void	addEntry (const T &entry)
	Add an object of type T to the Cluster. More...
void	addEntryVector (const std::vector< T > &entry_vector)
	This can be used to combine the subsets stored in two vertices all in once while merging. More...
std::vector< T >	getEntries () const
	Return the objects that are part of the Cluster. More...
void	setClusterValue (const std::vector< double > &v, const std::vector< double > &v_sigma)
	The value of a vertex has to be set manually. More...
std::vector< double >	getValues () const
	Return the N-dimensional value of the Cluster. More...
std::vector< double >	getSigmas () const
	Return the N-dimensional resolution of the Cluster. More...
int	getNEntries () const
	Return the number of objects stored in the Cluster. More...
bool	mergeStatus () const
	Return true if the Cluster is the result of a merge. More...
void	setMergeStatus (bool status)
int	getMergeIteration () const
void	setMergeIteration (int iteration)
bool	containsUnknowns () const
void	setUnknownStatus (bool status)

Private Attributes
int	m_debug_level = 0
std::vector< T >	m_entries { }
double	m_combined_value { }
double	m_combined_sigma { }
std::vector< double >	m_combined_value_vector { }
std::vector< double >	m_combined_sigma_vector { }
bool	m_was_merged = false
int	m_merge_iteration = 0
bool	m_contains_unknowns = false

Detailed Description

template<typename T>
class HGTD::Cluster< T >

Definition at line 30 of file Clustering.h.

Constructor & Destructor Documentation

Cluster() [1/3]

template<class T >

HGTD::Cluster< T >::Cluster

Definition at line 172 of file Clustering.h.

    : m_combined_value(-999.), m_combined_sigma(-999.) {}

Cluster() [2/3]

template<typename T >

HGTD::Cluster< T >::Cluster	(	const std::vector< double > &	v,
		const std::vector< double > &	v_sigma
	)

Definition at line 176 of file Clustering.h.

  : m_combined_value_vector(v), m_combined_sigma_vector(v_sigma) {
 
  for (const auto &s : v_sigma) {
    if (s < 0) {
      m_contains_unknowns = true;
    }
  }
}

Cluster() [3/3]

template<typename T >

HGTD::Cluster< T >::Cluster	(	const std::vector< double > &	v,
		const std::vector< double > &	v_sigma,
		const T &	entry
	)

Definition at line 188 of file Clustering.h.

  : m_combined_value_vector(v), m_combined_sigma_vector(v_sigma) {
 
  m_entries.push_back(entry);
 
  for (const auto &s : v_sigma) {
    if (s < 0) {
      m_contains_unknowns = true;
    }
  }
}

Member Function Documentation

addEntry()

template<class T >

void HGTD::Cluster< T >::addEntry

(

const T &

entry

)

Add an object of type T to the Cluster.

Parameters

[in]

entry

Object that should be added to the Cluster.

Definition at line 206 of file Clustering.h.

                                                           {
  m_entries.push_back(entry);
}

addEntryVector()

template<class T >

void HGTD::Cluster< T >::addEntryVector

(

const std::vector< T > &

entry_vector

)

This can be used to combine the subsets stored in two vertices all in once while merging.

Parameters

[in]

entry_vector

Vector of objects (usually extracted from vertex to be merged with).

Definition at line 215 of file Clustering.h.

                                                                {
  if (not entry_vector.empty()) {
    m_entries.insert(m_entries.end(), entry_vector.begin(), entry_vector.end());
  }
}

containsUnknowns()

template<class T >

bool HGTD::Cluster< T >::containsUnknowns

Definition at line 258 of file Clustering.h.

                                                           {
  return m_contains_unknowns;
}

getEntries()

template<class T >

std::vector< T > HGTD::Cluster< T >::getEntries

Return the objects that are part of the Cluster.

Definition at line 210 of file Clustering.h.

                                                             {
  return m_entries;
}

getMergeIteration()

template<class T >

int HGTD::Cluster< T >::getMergeIteration

Definition at line 250 of file Clustering.h.

                                                           {
  return m_merge_iteration;
}

getNEntries()

template<class T >

int HGTD::Cluster< T >::getNEntries

Return the number of objects stored in the Cluster.

Definition at line 202 of file Clustering.h.

                                                     {
  return m_entries.size();
}

getSigmas()

template<class T >

std::vector< double > HGTD::Cluster< T >::getSigmas

Return the N-dimensional resolution of the Cluster.

Definition at line 240 of file Clustering.h.

                                                                 {
  return m_combined_sigma_vector;
}

getValues()

template<class T >

std::vector< double > HGTD::Cluster< T >::getValues

Return the N-dimensional value of the Cluster.

Definition at line 228 of file Clustering.h.

                                                                 {
  // return a warning when this value is a default value
  if (m_combined_value_vector.size() == 0) {
    if (m_debug_level > 0) {
      std::cout
          << "Cluster::getTime: ATTENTION, combi values are not initialized!"
          << std::endl;
    }
  }
  return m_combined_value_vector;
}

mergeStatus()

template<class T >

bool HGTD::Cluster< T >::mergeStatus

Return true if the Cluster is the result of a merge.

Definition at line 248 of file Clustering.h.

{ return m_was_merged; }

setClusterValue()

template<class T >

void HGTD::Cluster< T >::setClusterValue	(	const std::vector< double > &	v,
		const std::vector< double > &	v_sigma
	)

The value of a vertex has to be set manually.

This is because we use a weighted time after vertex fusion, so this has to be accounted for (also gives the option to use different methods).

Parameters

[in]	v	Global position of this Cluster.
[in]	v_sigma	Global resolution of the position of this vertex.

Definition at line 222 of file Clustering.h.

                                                                   {
  m_combined_value_vector = v;
  m_combined_sigma_vector = v_sigma;
}

setMergeIteration()

template<class T >

void HGTD::Cluster< T >::setMergeIteration

(

int

iteration

)

Definition at line 254 of file Clustering.h.

                                                                   {
  m_merge_iteration = iteration;
}

setMergeStatus()

template<class T >

void HGTD::Cluster< T >::setMergeStatus

(

bool

status

)

Definition at line 244 of file Clustering.h.

                                                              {
  m_was_merged = status;
}

setUnknownStatus()

template<class T >

void HGTD::Cluster< T >::setUnknownStatus

(

bool

status

)

Definition at line 262 of file Clustering.h.

                                                                {
  m_contains_unknowns = status;
}

Member Data Documentation

m_combined_sigma

template<typename T >

double HGTD::Cluster< T >::m_combined_sigma { }

private

Definition at line 109 of file Clustering.h.

m_combined_sigma_vector

template<typename T >

std::vector<double> HGTD::Cluster< T >::m_combined_sigma_vector { }

private

Definition at line 111 of file Clustering.h.

m_combined_value

template<typename T >

double HGTD::Cluster< T >::m_combined_value { }

private

Definition at line 108 of file Clustering.h.

m_combined_value_vector

template<typename T >

std::vector<double> HGTD::Cluster< T >::m_combined_value_vector { }

private

Definition at line 110 of file Clustering.h.

m_contains_unknowns

template<typename T >

bool HGTD::Cluster< T >::m_contains_unknowns = false

private

Definition at line 114 of file Clustering.h.

m_debug_level

template<typename T >

int HGTD::Cluster< T >::m_debug_level = 0

private

Definition at line 106 of file Clustering.h.

m_entries

template<typename T >

std::vector<T> HGTD::Cluster< T >::m_entries { }

private

Definition at line 107 of file Clustering.h.

m_merge_iteration

template<typename T >

int HGTD::Cluster< T >::m_merge_iteration = 0

private

Definition at line 113 of file Clustering.h.

m_was_merged

template<typename T >

bool HGTD::Cluster< T >::m_was_merged = false

private

Definition at line 112 of file Clustering.h.

---

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

• Clustering.h