class to extract info from individual clusters and combine for SPTC More...

#include <ClusterInfoExtractor.h>

Inheritance diagram for ClusterInfoExtractor:

Collaboration diagram for ClusterInfoExtractor:

[legend]

Public Member Functions
	ClusterInfoExtractor (std::vector< TrackingUtilities::Named< float * > > &variableSet, bool useTimingInfo, const std::string &prefix="")
	Constructor fills variableSet with variables to be extracted.

void	extractVariables (std::vector< SpacePoint const * > const &spacePoints)
	extract variables from SpacePoints

Protected Member Functions
void	initializeStats (const std::string &identifier, std::vector< TrackingUtilities::Named< float * > > &variables)
	initialize statistics subsets of variables from clusters that get combined for SPTC

void	setStats (const std::string &identifier, std::vector< float > &values)
	calculated statistics and saves them in variable set

void	addVariable (const std::string &identifier, std::vector< TrackingUtilities::Named< float * > > &variables)
	add a variable to the variable set

Protected Attributes
bool	m_UseTimingInfo
	whether to use timing info from cluster

std::string	m_prefix
	prefix that will be added before the variable names

std::unordered_map< std::string, float >	m_variables
	unordered_map to associate float value with a string name

Detailed Description

class to extract info from individual clusters and combine for SPTC

Definition at line 23 of file ClusterInfoExtractor.h.

Constructor & Destructor Documentation

◆ ClusterInfoExtractor()

ClusterInfoExtractor	(	std::vector< TrackingUtilities::Named< float * > > &	variableSet,
		bool	useTimingInfo,
		const std::string &	prefix = "" )

inline

Constructor fills variableSet with variables to be extracted.

Parameters

variableSet	set of variable to be filled
useTimingInfo	whether to use the timing info in clusters
prefix	prefix that will be added before the variable names

Definition at line 30 of file ClusterInfoExtractor.h.

                                                       :
      VariableExtractor(), m_UseTimingInfo(useTimingInfo), m_prefix(prefix)
    {
      initializeStats(m_prefix + "charge", variableSet);
      initializeStats(m_prefix + "seedCharge", variableSet);
      initializeStats(m_prefix + "size", variableSet);
      initializeStats(m_prefix + "energyLoss", variableSet);
      if (m_UseTimingInfo) {
        initializeStats(m_prefix + "time", variableSet);
        initializeStats(m_prefix + "timeSigma", variableSet);
      }
 
    }

Member Function Documentation

◆ addVariable()

void addVariable	(	const std::string &	identifier,
		std::vector< TrackingUtilities::Named< float * > > &	variables )

inlineprotectedinherited

add a variable to the variable set

Definition at line 30 of file VariableExtractor.h.

    {
      //todo: verify if it is faster to check explicitly or not
      auto value = m_variables.emplace(identifier, NAN).first;
      variables.emplace_back(identifier, &(value->second));
    }

◆ extractVariables()

void extractVariables ( std::vector< SpacePoint const * > const & spacePoints )

inline

extract variables from SpacePoints

Definition at line 46 of file ClusterInfoExtractor.h.

    {
      std::vector<SVDCluster const*> clusters;
      clusters.reserve(spacePoints.size() * 2);
 
      for (SpacePoint const* sp : spacePoints) {
        RelationVector<SVDCluster> relatedClusters = sp->getRelationsTo<SVDCluster>("");
        for (const SVDCluster& cluster : relatedClusters) {
          clusters.push_back(&cluster);
        }
      }
 
      // this is fine as it is pointing to the `relatedClusters`, which are in the datastore..
      // cppcheck-suppress invalidLifetime
      std::vector<float> values(clusters.size());
      for (unsigned int i = 0; i < clusters.size(); ++i) {
        values[i] = clusters[i]->getCharge();
      }
      setStats(m_prefix + "charge", values);
 
      for (unsigned int i = 0; i < clusters.size(); ++i) {
        values[i] = clusters[i]->getSeedCharge();
      }
      setStats(m_prefix + "seedCharge", values);
 
 
      for (unsigned int i = 0; i < clusters.size(); ++i) {
        values[i] = clusters[i]->getSize();
      }
      setStats(m_prefix + "size", values);
 
 
      for (unsigned int i = 0; i < clusters.size(); ++i) {
        values[i] = clusters[i]->getCharge() / clusters[i]->getSize();
      }
      setStats(m_prefix + "energyLoss", values);
 
      if (m_UseTimingInfo) {
        for (unsigned int i = 0; i < clusters.size(); ++i) {
          values[i] = clusters[i]->getClsTime();
        }
        setStats(m_prefix + "time", values);
 
        for (unsigned int i = 0; i < clusters.size(); ++i) {
          values[i] = clusters[i]->getClsTimeSigma();
        }
        setStats(m_prefix + "timeSigma", values);
      }
 
    }

◆ initializeStats()

void initializeStats	(	const std::string &	identifier,
		std::vector< TrackingUtilities::Named< float * > > &	variables )

inlineprotected

initialize statistics subsets of variables from clusters that get combined for SPTC

Definition at line 104 of file ClusterInfoExtractor.h.

    {
      addVariable(identifier + "_max", variables);
      addVariable(identifier + "_min", variables);
      addVariable(identifier + "_mean", variables);
      addVariable(identifier + "_std", variables);
      addVariable(identifier + "_sum", variables);
    }

◆ setStats()

void setStats	(	const std::string &	identifier,
		std::vector< float > &	values )

inlineprotected

calculated statistics and saves them in variable set

Definition at line 114 of file ClusterInfoExtractor.h.

    {
      short size = values.size();
      if (values.size() == 0) {
        m_variables.at(identifier + "_max") = NAN;
        m_variables.at(identifier + "_min") = NAN;
        m_variables.at(identifier + "_mean") = NAN;
        m_variables.at(identifier + "_std") = NAN;
        m_variables.at(identifier + "_sum") = NAN;
        return;
      }
      // mean
      float sum = std::accumulate(values.begin(), values.end(), 0.0);
      m_variables.at(identifier + "_sum") = sum;
      float mean = sum / size;
      m_variables.at(identifier + "_mean") = mean;
      // variance and standard deviation
      float variance = std::accumulate(values.begin(), values.end(), 0.0,
      [mean, size](float x, float y) {return x + ((y - mean) * (y - mean)) / (size - 1);});
      float stddev = std::sqrt(variance);
      m_variables.at(identifier + "_std") = stddev;
      //min and max
      float min = *(std::min_element(values.begin(), values.end()));
      float max = *(std::max_element(values.begin(), values.end()));
      m_variables.at(identifier + "_min") = min;
      m_variables.at(identifier + "_max") = max;
    }

Member Data Documentation

◆ m_prefix

std::string m_prefix

protected

prefix that will be added before the variable names

Definition at line 101 of file ClusterInfoExtractor.h.

◆ m_UseTimingInfo

bool m_UseTimingInfo

protected

whether to use timing info from cluster

Definition at line 99 of file ClusterInfoExtractor.h.

◆ m_variables

std::unordered_map<std::string, float> m_variables

protectedinherited

unordered_map to associate float value with a string name

Definition at line 38 of file VariableExtractor.h.

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

tracking/trackFindingVXD/variableExtractors/include/ClusterInfoExtractor.h

Public Member Functions

Protected Member Functions

Protected Attributes