Trk::TrackSummary Class Reference

A summary of the information contained by a track. More...

#include <TrackSummary.h>

Inheritance diagram for Trk::TrackSummary:

Collaboration diagram for Trk::TrackSummary:

Public Member Functions
	TrackSummary ()
	needed by POOL More...
	TrackSummary (const std::vector< int > &information, std::bitset< numberOfDetectorTypes > &hitPattern)
	ctor should probably only be called by TrkSummaryTool. More...
	TrackSummary (const TrackSummary &rhs)
	copy ctor More...
TrackSummary &	operator= (const TrackSummary &)
	assignment operator More...
	TrackSummary (TrackSummary &&rhs) noexcept=default
	Move ctor. More...
TrackSummary &	operator= (TrackSummary &&) noexcept=default
	Move assignment operator. More...
	~TrackSummary ()
TrackSummary &	operator+= (const TrackSummary &ts)
	adds the values of the passed TrackSummary to this TrackSummary. More...
int	get (const SummaryType &type) const
	returns the summary information for the passed SummaryType. More...
unsigned long	getHitPattern () const
bool	isHit (const DetectorType &type) const
	returns true if the detector type 'type' is hit. More...
const MuonTrackSummary *	muonTrackSummary () const
	returns a pointer to the MuonTrackSummary if available More...
MuonTrackSummary *	muonTrackSummary ()
	returns pointer to a modifiable (non-const) MuonTrackSummary if available More...
bool	update (Trk::SummaryType type, int new_value)
	Update unset summary information. More...

Static Public Member Functions
static std::size_t	numberOfInstantiations ()

Static Public Attributes
static const int	SummaryTypeNotSet = -1
	Value set in the cxx file to -1. More...
static std::atomic_size_t	s_numberOfInstantiations

Private Attributes
std::vector< int >	m_information
	vector containing the persistent summary information. More...
unsigned long	m_idHitPattern
	contains the 'hit pattern' More...
std::unique_ptr< MuonTrackSummary >	m_muonTrackSummary
	pointer to the MuonTrackSummary More...

Friends
class	InDet::InDetTrackSummaryHelperTool
class	Muon::MuonTrackSummaryHelperTool
class	Trk::TrackSummaryTool
class	::TrackSummaryCnv_p1
class	::TrackSummaryCnv_p2

Detailed Description

A summary of the information contained by a track.

If there is information missing, or if I could add useful methods then let me know. I have deliberately tried to keep this as simple as possible, whilst allowing for future expansion.

A recent addition is the isHit() method. This is analogous to the old 'hit patterns' in that you can use it to check if a specific sub-detector element has been hit by the track.

For example, you could do: if (summary.isHit(Trk::pixelBarrel0) ) callSomething();

Please note that this class does NO error checking - i.e. it would be possible for someone to fill this object in an inconsistent manner and it would not be caught.

Author

Edwar.nosp@m.d.Mo.nosp@m.yse@c.nosp@m.ern..nosp@m.ch

Definition at line 286 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

Constructor & Destructor Documentation

TrackSummary() [1/4]

Trk::TrackSummary::TrackSummary

(

)

needed by POOL

Definition at line 16 of file TrackSummary.cxx.

  : Trk::ObjectCounter<Trk::TrackSummary>()
  , m_information(numberOfTrackSummaryTypes, SummaryTypeNotSet)
  , m_idHitPattern(0)
  , m_muonTrackSummary(nullptr)
{
}

TrackSummary() [2/4]

Trk::TrackSummary::TrackSummary	(	const std::vector< int > &	information,
		std::bitset< numberOfDetectorTypes > &	hitPattern
	)

ctor should probably only be called by TrkSummaryTool.

Parameters

information	The vector passed should be complete i.e. it should be the size required by m_numSummaryTypes, and any undefined values should be set to -1. The vector should be filled using SummaryType to select the position of the information.
hitPattern	this bitset should be filled using the DetectorType enum. True indicates that a sub-detector was hit

Definition at line 24 of file TrackSummary.cxx.

  : Trk::ObjectCounter<Trk::TrackSummary>()
  , m_information(information)
  , m_idHitPattern(hitPattern.to_ulong())
  , m_muonTrackSummary(nullptr)
{
}

TrackSummary() [3/4]

Trk::TrackSummary::TrackSummary

(

const TrackSummary &

rhs

)

copy ctor

Definition at line 33 of file TrackSummary.cxx.

  : Trk::ObjectCounter<Trk::TrackSummary>(rhs)
  , m_information(rhs.m_information)
  , m_idHitPattern(rhs.m_idHitPattern)
{
  if (rhs.m_muonTrackSummary) {
    m_muonTrackSummary =
      std::make_unique<MuonTrackSummary>(*rhs.m_muonTrackSummary);
  } else {
    m_muonTrackSummary = nullptr;
  }
}

TrackSummary() [4/4]

Trk::TrackSummary::TrackSummary ( TrackSummary &&  rhs )

defaultnoexcept

Move ctor.

~TrackSummary()

Trk::TrackSummary::~TrackSummary ( )

default

Member Function Documentation

get()

int Trk::TrackSummary::get

(

const SummaryType &

type

)

const

returns the summary information for the passed SummaryType.

Parameters

type	Use the provided enums to access it, i.e. by summary.get(numberOfPixelHits)

Returns

returns -1 if the enum is undefined (i.e. the information was not available in the Track, or (more likely) Trk::TrkTrackSummaryTool is not filling it yet)

getHitPattern()

unsigned long Trk::TrackSummary::getHitPattern

(

)

const

isHit()

bool Trk::TrackSummary::isHit

(

const DetectorType &

type

)

const

returns true if the detector type 'type' is hit.

Parameters

type	Please use the DetectorType enum to access the information (the internal positions may change!)

Returns

true if sub-detector 'type' is hit

muonTrackSummary() [1/2]

MuonTrackSummary* Trk::TrackSummary::muonTrackSummary

(

)

returns pointer to a modifiable (non-const) MuonTrackSummary if available

muonTrackSummary() [2/2]

const MuonTrackSummary* Trk::TrackSummary::muonTrackSummary

(

)

const

returns a pointer to the MuonTrackSummary if available

numberOfInstantiations()

static std::size_t Trk::ObjectCounter< Trk::TrackSummary >::numberOfInstantiations

inlinestaticinherited

Definition at line 25 of file TrkObjectCounter.h.

  {
#ifndef NDEBUG
    return s_numberOfInstantiations.load();
#endif
    return 0;
  }

operator+=()

Trk::TrackSummary & Trk::TrackSummary::operator+=

(

const TrackSummary &

ts

)

adds the values of the passed TrackSummary to this TrackSummary.

Mainly intended for adding Muon and ID TrackSummaries, when making a combined Track for example WARNING: may not make much sense for e.g. Trk::numberOfContribPixelLayers

Definition at line 62 of file TrackSummary.cxx.

{
  if (this != &ts) {
    for (int i = 0; i < numberOfTrackSummaryTypes; ++i) {
      // if added number is <0, leave as is (this also catches the case where
      // both are <0)
      if (ts.m_information[i] < 0) {
        continue;
      }
 
      if (m_information[i] < 0) {
        m_information[i]++;
      }
      m_information[i] += ts.m_information[i];
    }
    if (!m_muonTrackSummary) {
      m_muonTrackSummary.reset(ts.m_muonTrackSummary
                                 ? new MuonTrackSummary(*ts.m_muonTrackSummary)
                                 : nullptr);
    }
  }
  return *this;
}

operator=() [1/2]

Trk::TrackSummary & Trk::TrackSummary::operator=

(

const TrackSummary &

rhs

)

assignment operator

Definition at line 47 of file TrackSummary.cxx.

{
  if (&rhs != this) {
    m_information = rhs.m_information;
    m_idHitPattern = rhs.m_idHitPattern;
    m_muonTrackSummary.reset(rhs.m_muonTrackSummary
                               ? new MuonTrackSummary(*rhs.m_muonTrackSummary)
                               : nullptr);
  }
  return *this;
}

operator=() [2/2]

TrackSummary& Trk::TrackSummary::operator= ( TrackSummary &&  )

defaultnoexcept

Move assignment operator.

update()

bool Trk::TrackSummary::update	(	Trk::SummaryType	type,
		int	new_value
	)

Update unset summary information.

Parameters

type	the type of the summary information to be updated.
new_value	the value to be set for the given type.

Returns

false in case the information was set alread.

Friends And Related Function Documentation

::TrackSummaryCnv_p1

friend class ::TrackSummaryCnv_p1

friend

Definition at line 360 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

::TrackSummaryCnv_p2

friend class ::TrackSummaryCnv_p2

friend

Definition at line 361 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

InDet::InDetTrackSummaryHelperTool

friend class InDet::InDetTrackSummaryHelperTool

friend

Definition at line 289 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

Muon::MuonTrackSummaryHelperTool

friend class Muon::MuonTrackSummaryHelperTool

friend

Definition at line 290 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

Trk::TrackSummaryTool

friend class Trk::TrackSummaryTool

friend

Definition at line 291 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

Member Data Documentation

m_idHitPattern

unsigned long Trk::TrackSummary::m_idHitPattern

private

contains the 'hit pattern'

Definition at line 367 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

m_information

std::vector<int> Trk::TrackSummary::m_information

private

vector containing the persistent summary information.

Definition at line 364 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

m_muonTrackSummary

std::unique_ptr<MuonTrackSummary> Trk::TrackSummary::m_muonTrackSummary

private

pointer to the MuonTrackSummary

Definition at line 370 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

s_numberOfInstantiations

std::atomic_size_t Trk::ObjectCounter< Trk::TrackSummary >::s_numberOfInstantiations

inlinestaticinherited

Definition at line 22 of file TrkObjectCounter.h.

SummaryTypeNotSet

const int Trk::TrackSummary::SummaryTypeNotSet = -1

static

Value set in the cxx file to -1.

If any of the values returned by get(const SummaryType& type)==SummaryTypeNotSet then this means that the information has not been filled. i.e. ID information cannot be filled if the TrackSummaryTool does not have access to the InDetTrackSummaryHelperTool

Definition at line 297 of file Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h.

---

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

• Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h
• TrackSummary.cxx