ticl::Trackster Class Reference

#include <Trackster.h>

Public Types
enum	IterationIndex {   TRKEM = 0, EM, TRKHAD, HAD,   MIP, SIM, SIM_CP }
enum	ParticleType {   ParticleType::photon = 0, ParticleType::electron, ParticleType::muon, ParticleType::neutral_pion,   ParticleType::charged_hadron, ParticleType::neutral_hadron, ParticleType::ambiguous, ParticleType::unknown }
enum	PCAOrdering { PCAOrdering::ascending = 0, PCAOrdering::descending }
typedef math::XYZVector	Vector

Public Member Functions
void	addToRawEmEnergy (float value)
void	addToRawEnergy (float value)
const Vector &	barycenter () const
std::vector< std::array< unsigned int, 2 > > &	edges ()
const std::vector< std::array< unsigned int, 2 > > &	edges () const
const std::array< float, 3 > &	eigenvalues () const
const std::array< Vector, 3 > &	eigenvectors () const
const Vector &	eigenvectors (int index) const
void	fillPCAVariables (Eigen::Vector3d &eigenvalues, Eigen::Matrix3d &eigenvectors, Eigen::Vector3d &sigmas, Eigen::Vector3d &sigmasEigen, size_t pcadimension, PCAOrdering order)
const std::array< float, 8 > &	id_probabilities () const
const float	id_probabilities (int index) const
float	id_probability (ParticleType type) const
const float	raw_em_energy () const
const float	raw_em_pt () const
const float	raw_energy () const
const float	raw_pt () const
const float	regressed_energy () const
const edm::ProductID &	seedID () const
const int	seedIndex () const
void	setBarycenter (Vector value)
void	setIdProbability (ParticleType type, float value)
void	setIteration (const Trackster::IterationIndex i)
void	setProbabilities (float *probs)
void	setRawEmEnergy (float value)
void	setRawEmPt (float value)
void	setRawEnergy (float value)
void	setRawPt (float value)
void	setRegressedEnergy (float value)
void	setSeed (edm::ProductID pid, int index)
void	setTimeAndError (float t, float tError)
const std::array< float, 3 > &	sigmas () const
const std::array< float, 3 > &	sigmasPCA () const
const Trackster::IterationIndex	ticlIteration () const
const float	time () const
const float	timeError () const
	Trackster ()
std::vector< float > &	vertex_multiplicity ()
const std::vector< float > &	vertex_multiplicity () const
const float	vertex_multiplicity (int index) const
std::vector< unsigned int > &	vertices ()
const std::vector< unsigned int > &	vertices () const
const unsigned int	vertices (int index) const
void	zeroProbabilities ()

Private Attributes
Vector	barycenter_
std::vector< std::array< unsigned int, 2 > >	edges_
std::array< float, 3 >	eigenvalues_
std::array< Vector, 3 >	eigenvectors_
std::array< float, 8 >	id_probabilities_
uint8_t	iterationIndex_
float	raw_em_energy_
float	raw_em_pt_
float	raw_energy_
float	raw_pt_
float	regressed_energy_
edm::ProductID	seedID_
int	seedIndex_
std::array< float, 3 >	sigmas_
std::array< float, 3 >	sigmasPCA_
float	time_
float	timeError_
std::vector< float >	vertex_multiplicity_
std::vector< unsigned int >	vertices_

Detailed Description

Definition at line 19 of file Trackster.h.

Member Typedef Documentation

Vector

typedef math::XYZVector ticl::Trackster::Vector

Definition at line 21 of file Trackster.h.

Member Enumeration Documentation

IterationIndex

enum ticl::Trackster::IterationIndex

Enumerator
TRKEM
EM
TRKHAD
HAD
MIP
SIM
SIM_CP

Definition at line 23 of file Trackster.h.

{ TRKEM = 0, EM, TRKHAD, HAD, MIP, SIM, SIM_CP };

ParticleType

enum ticl::Trackster::ParticleType

strong

Enumerator
photon
electron
muon
neutral_pion
charged_hadron
neutral_hadron
ambiguous
unknown

Definition at line 26 of file Trackster.h.

                            {
      photon = 0,
      electron,
      muon,
      neutral_pion,
      charged_hadron,
      neutral_hadron,
      ambiguous,
      unknown,
    };

PCAOrdering

enum ticl::Trackster::PCAOrdering

strong

Enumerator
ascending
descending

Definition at line 37 of file Trackster.h.

{ ascending = 0, descending };

Constructor & Destructor Documentation

Trackster()

ticl::Trackster::Trackster ( )

inline

Definition at line 39 of file Trackster.h.

        : iterationIndex_(0),
          seedIndex_(0),
          time_(0.f),
          timeError_(-1.f),
          regressed_energy_(0.f),
          raw_energy_(0.f),
          raw_em_energy_(0.f),
          raw_pt_(0.f),
          raw_em_pt_(0.f),
          barycenter_({0., 0., 0.}),
          eigenvalues_{{0.f, 0.f, 0.f}},
          sigmas_{{0.f, 0.f, 0.f}},
          sigmasPCA_{{0.f, 0.f, 0.f}} {
      zeroProbabilities();
    }

Member Function Documentation

addToRawEmEnergy()

void ticl::Trackster::addToRawEmEnergy ( float  value )

inline

Definition at line 72 of file Trackster.h.

References raw_em_energy_, and relativeConstraints::value.

{ raw_em_energy_ += value; }

addToRawEnergy()

void ticl::Trackster::addToRawEnergy ( float  value )

inline

Definition at line 70 of file Trackster.h.

References raw_energy_, and relativeConstraints::value.

{ raw_energy_ += value; }

barycenter()

const Vector& ticl::Trackster::barycenter ( ) const

inline

Definition at line 134 of file Trackster.h.

References barycenter_.

Referenced by FWTracksterProxyBuilder::build().

{ return barycenter_; }

edges() [1/2]

std::vector<std::array<unsigned int, 2> >& ticl::Trackster::edges ( )

inline

Definition at line 59 of file Trackster.h.

References edges_.

Referenced by FWTracksterHitsProxyBuilder::build(), and FWTracksterLayersProxyBuilder::build().

{ return edges_; }

edges() [2/2]

const std::vector<std::array<unsigned int, 2> >& ticl::Trackster::edges ( ) const

inline

Definition at line 124 of file Trackster.h.

References edges_.

{ return edges_; }

eigenvalues()

const std::array<float, 3>& ticl::Trackster::eigenvalues ( ) const

inline

Definition at line 135 of file Trackster.h.

References eigenvalues_.

Referenced by FWTracksterProxyBuilder::build(), and fillPCAVariables().

{ return eigenvalues_; }

eigenvectors() [1/2]

const std::array<Vector, 3>& ticl::Trackster::eigenvectors ( ) const

inline

Definition at line 136 of file Trackster.h.

References eigenvectors_.

Referenced by fillPCAVariables().

{ return eigenvectors_; }

eigenvectors() [2/2]

const Vector& ticl::Trackster::eigenvectors ( int  index ) const

inline

Definition at line 137 of file Trackster.h.

References eigenvectors_.

{ return eigenvectors_[index]; }

fillPCAVariables()

void ticl::Trackster::fillPCAVariables ( Eigen::Vector3d &  eigenvalues, Eigen::Matrix3d &  eigenvectors, Eigen::Vector3d &  sigmas, Eigen::Vector3d &  sigmasEigen, size_t  pcadimension, PCAOrdering  order  )

inline

Definition at line 76 of file Trackster.h.

References ascending, barycenter_, eigenvalues(), eigenvalues_, eigenvectors(), eigenvectors_, dqmMemoryStats::float, mps_fire::i, eventshapeDQM_cfi::order, perp2(), raw_em_energy_, raw_em_pt_, raw_energy_, raw_pt_, sigmas(), sigmas_, sigmasPCA_, and mathSSE::sqrt().

                                                    {
      int original_index = 0;
      for (size_t i = 0; i < pcadimension; ++i) {
        sigmas_[i] = std::sqrt(sigmas[i]);
        // Reverse the order, since Eigen gives back the eigevalues in
        // **increasing order** while we store them in **descreasing order**.
        original_index = i;
        if (order == PCAOrdering::ascending)
          original_index = pcadimension - i - 1;
        eigenvalues_[i] = (float)eigenvalues[original_index];
        eigenvectors_[i] = ticl::Trackster::Vector(
            eigenvectors(0, original_index), eigenvectors(1, original_index), eigenvectors(2, original_index));
        sigmasPCA_[i] = std::sqrt(sigmasEigen[original_index]);
      }
      original_index = 0;
      if (order == PCAOrdering::ascending)
        original_index = pcadimension - 1;
      if (eigenvectors_[0].z() * barycenter_.z() < 0.0) {
        eigenvectors_[0] = -ticl::Trackster::Vector(
            eigenvectors(0, original_index), eigenvectors(1, original_index), eigenvectors(2, original_index));
      }

      // Now also update the pt part of the Trackster, using the PCA as direction
      raw_pt_ = std::sqrt((eigenvectors_[0].Unit() * raw_energy_).perp2());
      raw_em_pt_ = std::sqrt((eigenvectors_[0].Unit() * raw_em_energy_).perp2());
    }

id_probabilities() [1/2]

const std::array<float, 8>& ticl::Trackster::id_probabilities ( ) const

inline

Definition at line 140 of file Trackster.h.

References id_probabilities_.

{ return id_probabilities_; }

id_probabilities() [2/2]

const float ticl::Trackster::id_probabilities ( int  index ) const

inline

Definition at line 141 of file Trackster.h.

References id_probabilities_.

{ return id_probabilities_[index]; }

id_probability()

float ticl::Trackster::id_probability ( ParticleType  type ) const

inline

Definition at line 144 of file Trackster.h.

References id_probabilities_, and createfilelist::int.

                                                         {
      // probabilities are stored in the same order as defined in the ParticleType enum
      return id_probabilities_[(int)type];
    }

raw_em_energy()

const float ticl::Trackster::raw_em_energy ( ) const

inline

Definition at line 131 of file Trackster.h.

References raw_em_energy_.

{ return raw_em_energy_; }

raw_em_pt()

const float ticl::Trackster::raw_em_pt ( ) const

inline

Definition at line 133 of file Trackster.h.

References raw_em_pt_.

{ return raw_em_pt_; }

raw_energy()

const float ticl::Trackster::raw_energy ( ) const

inline

Definition at line 130 of file Trackster.h.

References raw_energy_.

{ return raw_energy_; }

raw_pt()

const float ticl::Trackster::raw_pt ( ) const

inline

Definition at line 132 of file Trackster.h.

References raw_pt_.

{ return raw_pt_; }

regressed_energy()

const float ticl::Trackster::regressed_energy ( ) const

inline

Definition at line 129 of file Trackster.h.

References regressed_energy_.

Referenced by ticl::TracksterP4FromEnergySum::calcP4().

{ return regressed_energy_; }

seedID()

const edm::ProductID& ticl::Trackster::seedID ( ) const

inline

Definition at line 125 of file Trackster.h.

References seedID_.

Referenced by HGVHistoProducerAlgo::tracksters_to_SimTracksters().

{ return seedID_; }

seedIndex()

const int ticl::Trackster::seedIndex ( ) const

inline

Definition at line 126 of file Trackster.h.

References seedIndex_.

Referenced by HGVHistoProducerAlgo::tracksters_to_SimTracksters().

{ return seedIndex_; }

setBarycenter()

void ticl::Trackster::setBarycenter ( Vector  value )

inline

Definition at line 75 of file Trackster.h.

References barycenter_, and relativeConstraints::value.

{ barycenter_ = value; }

setIdProbability()

void ticl::Trackster::setIdProbability ( ParticleType  type, float  value  )

inline

Definition at line 117 of file Trackster.h.

References id_probabilities_, createfilelist::int, and relativeConstraints::value.

Referenced by ticl::addTrackster().

{ id_probabilities_[int(type)] = value; }

setIteration()

void ticl::Trackster::setIteration ( const Trackster::IterationIndex  i )

inline

Definition at line 56 of file Trackster.h.

References mps_fire::i, and iterationIndex_.

Referenced by ticl::addTrackster().

{ iterationIndex_ = i; }

setProbabilities()

void ticl::Trackster::setProbabilities ( float *  probs )

inline

Definition at line 112 of file Trackster.h.

References id_probabilities_, and AlCaHLTBitMon_ParallelJobs::p.

                                               {
      for (float &p : id_probabilities_) {
        p = *(probs++);
      }
    }

setRawEmEnergy()

void ticl::Trackster::setRawEmEnergy ( float  value )

inline

Definition at line 71 of file Trackster.h.

References raw_em_energy_, and relativeConstraints::value.

{ raw_em_energy_ = value; }

setRawEmPt()

void ticl::Trackster::setRawEmPt ( float  value )

inline

Definition at line 74 of file Trackster.h.

References raw_em_pt_, and relativeConstraints::value.

{ raw_em_pt_ = value; }

setRawEnergy()

void ticl::Trackster::setRawEnergy ( float  value )

inline

Definition at line 69 of file Trackster.h.

References raw_energy_, and relativeConstraints::value.

{ raw_energy_ = value; }

setRawPt()

void ticl::Trackster::setRawPt ( float  value )

inline

Definition at line 73 of file Trackster.h.

References raw_pt_, and relativeConstraints::value.

{ raw_pt_ = value; }

setRegressedEnergy()

void ticl::Trackster::setRegressedEnergy ( float  value )

inline

Definition at line 68 of file Trackster.h.

References regressed_energy_, and relativeConstraints::value.

Referenced by ticl::addTrackster().

{ regressed_energy_ = value; }

setSeed()

void ticl::Trackster::setSeed ( edm::ProductID  pid, int  index  )

inline

Definition at line 60 of file Trackster.h.

References seedID_, and seedIndex_.

Referenced by ticl::addTrackster().

                                                     {
      seedID_ = pid;
      seedIndex_ = index;
    }

setTimeAndError()

void ticl::Trackster::setTimeAndError ( float  t, float  tError  )

inline

Definition at line 64 of file Trackster.h.

References submitPVValidationJobs::t, time_, and timeError_.

                                                       {
      time_ = t;
      timeError_ = tError;
    }

sigmas()

const std::array<float, 3>& ticl::Trackster::sigmas ( ) const

inline

Definition at line 138 of file Trackster.h.

References sigmas_.

Referenced by fillPCAVariables().

{ return sigmas_; }

sigmasPCA()

const std::array<float, 3>& ticl::Trackster::sigmasPCA ( ) const

inline

Definition at line 139 of file Trackster.h.

References sigmasPCA_.

{ return sigmasPCA_; }

ticlIteration()

const Trackster::IterationIndex ticl::Trackster::ticlIteration ( ) const

inline

Definition at line 119 of file Trackster.h.

References iterationIndex_.

{ return (IterationIndex)iterationIndex_; }

time()

const float ticl::Trackster::time ( ) const

inline

Definition at line 127 of file Trackster.h.

References time_.

Referenced by TICLCandidate::addTrackster().

{ return time_; }

timeError()

const float ticl::Trackster::timeError ( ) const

inline

Definition at line 128 of file Trackster.h.

References timeError_.

Referenced by TICLCandidate::addTrackster().

{ return timeError_; }

vertex_multiplicity() [1/3]

std::vector<float>& ticl::Trackster::vertex_multiplicity ( )

inline

Definition at line 58 of file Trackster.h.

References vertex_multiplicity_.

Referenced by ticl::addTrackster(), ticl::TracksterP4FromEnergySum::calcP4(), ticl::PatternRecognitionbyCLUE3D< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyCA< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyFastJet< TILES >::energyRegressionAndID(), TrackstersMergeProducer::energyRegressionAndID(), and HGVHistoProducerAlgo::tracksters_to_SimTracksters().

{ return vertex_multiplicity_; }

vertex_multiplicity() [2/3]

const std::vector<float>& ticl::Trackster::vertex_multiplicity ( ) const

inline

Definition at line 122 of file Trackster.h.

References vertex_multiplicity_.

{ return vertex_multiplicity_; }

vertex_multiplicity() [3/3]

const float ticl::Trackster::vertex_multiplicity ( int  index ) const

inline

Definition at line 123 of file Trackster.h.

References vertex_multiplicity_.

{ return vertex_multiplicity_[index]; }

vertices() [1/3]

std::vector<unsigned int>& ticl::Trackster::vertices ( )

inline

Definition at line 57 of file Trackster.h.

References vertices_.

Referenced by ticl::addTrackster(), FWTracksterHitsProxyBuilder::build(), FWTracksterLayersProxyBuilder::build(), ticl::TracksterP4FromEnergySum::calcP4(), ticl::PatternRecognitionbyCLUE3D< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyCA< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyFastJet< TILES >::energyRegressionAndID(), TrackstersMergeProducer::energyRegressionAndID(), and HGVHistoProducerAlgo::tracksters_to_SimTracksters().

{ return vertices_; }

vertices() [2/3]

const std::vector<unsigned int>& ticl::Trackster::vertices ( ) const

inline

Definition at line 120 of file Trackster.h.

References vertices_.

{ return vertices_; }

vertices() [3/3]

const unsigned int ticl::Trackster::vertices ( int  index ) const

inline

Definition at line 121 of file Trackster.h.

References vertices_.

{ return vertices_[index]; }

zeroProbabilities()

void ticl::Trackster::zeroProbabilities ( )

inline

Definition at line 107 of file Trackster.h.

References id_probabilities_, and AlCaHLTBitMon_ParallelJobs::p.

Referenced by ticl::addTrackster().

                             {
      for (auto &p : id_probabilities_) {
        p = 0.f;
      }
    }

Member Data Documentation

barycenter_

Vector ticl::Trackster::barycenter_

private

Definition at line 193 of file Trackster.h.

Referenced by barycenter(), fillPCAVariables(), and setBarycenter().

edges_

std::vector<std::array<unsigned int, 2> > ticl::Trackster::edges_

private

Definition at line 163 of file Trackster.h.

Referenced by edges().

eigenvalues_

std::array<float, 3> ticl::Trackster::eigenvalues_

private

Definition at line 194 of file Trackster.h.

Referenced by eigenvalues(), and fillPCAVariables().

eigenvectors_

std::array<Vector, 3> ticl::Trackster::eigenvectors_

private

Definition at line 195 of file Trackster.h.

Referenced by eigenvectors(), and fillPCAVariables().

id_probabilities_

std::array<float, 8> ticl::Trackster::id_probabilities_

private

Definition at line 200 of file Trackster.h.

Referenced by id_probabilities(), id_probability(), setIdProbability(), setProbabilities(), and zeroProbabilities().

iterationIndex_

uint8_t ticl::Trackster::iterationIndex_

private

Definition at line 151 of file Trackster.h.

Referenced by setIteration(), and ticlIteration().

raw_em_energy_

float ticl::Trackster::raw_em_energy_

private

Definition at line 188 of file Trackster.h.

Referenced by addToRawEmEnergy(), fillPCAVariables(), raw_em_energy(), and setRawEmEnergy().

raw_em_pt_

float ticl::Trackster::raw_em_pt_

private

Definition at line 190 of file Trackster.h.

Referenced by fillPCAVariables(), raw_em_pt(), and setRawEmPt().

raw_energy_

float ticl::Trackster::raw_energy_

private

Definition at line 187 of file Trackster.h.

Referenced by addToRawEnergy(), fillPCAVariables(), raw_energy(), and setRawEnergy().

raw_pt_

float ticl::Trackster::raw_pt_

private

Definition at line 189 of file Trackster.h.

Referenced by fillPCAVariables(), raw_pt(), and setRawPt().

regressed_energy_

float ticl::Trackster::regressed_energy_

private

Definition at line 186 of file Trackster.h.

Referenced by regressed_energy(), and setRegressedEnergy().

seedID_

edm::ProductID ticl::Trackster::seedID_

private

Definition at line 169 of file Trackster.h.

Referenced by seedID(), and setSeed().

seedIndex_

int ticl::Trackster::seedIndex_

private

Definition at line 175 of file Trackster.h.

Referenced by seedIndex(), and setSeed().

sigmas_

std::array<float, 3> ticl::Trackster::sigmas_

private

Definition at line 196 of file Trackster.h.

Referenced by fillPCAVariables(), and sigmas().

sigmasPCA_

std::array<float, 3> ticl::Trackster::sigmasPCA_

private

Definition at line 197 of file Trackster.h.

Referenced by fillPCAVariables(), and sigmasPCA().

time_

float ticl::Trackster::time_

private

Definition at line 182 of file Trackster.h.

Referenced by setTimeAndError(), and time().

timeError_

float ticl::Trackster::timeError_

private

Definition at line 183 of file Trackster.h.

Referenced by setTimeAndError(), and timeError().

vertex_multiplicity_

std::vector<float> ticl::Trackster::vertex_multiplicity_

private

Definition at line 156 of file Trackster.h.

Referenced by vertex_multiplicity().

vertices_

std::vector<unsigned int> ticl::Trackster::vertices_

private

Definition at line 155 of file Trackster.h.

Referenced by vertices().