lar::example::CheatTrack Class Reference

Pseudo-track object for TotallyCheatTracks example. More...

#include <CheatTrack.h>

Public Types
using	PDGID_t = int
	Type of the particle ID. More...

Public Member Functions
	CheatTrack ()=default
	Default constructor, only for ROOT I/O (do not use it!). More...
	CheatTrack (recob::Trajectory &&traj, PDGID_t pid)
	Constructor from trajectory (stolen) and particle ID. More...
recob::Trajectory const &	trajectory () const
	Returns the trajectory of this track. More...
Access to data
double	momentum () const
	Returns the initial momentum of the particle [MeV]. More...
PDGID_t	particleId () const
	Returns the particle ID, in PDG standard. More...
bool	hasParticleId () const
	Returns whether the particle ID is valid. More...

Static Public Attributes
static constexpr PDGID_t	InvalidParticleID = 0
	Value of a particle ID that denotes it as invalid. More...

Private Attributes
recob::Trajectory	fTraj
	The trejectory of this track. More...
PDGID_t	fPDGID = InvalidParticleID
	Particle ID in PDG standard. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &out, lar::example::CheatTrack const &track)

Printing data
static constexpr unsigned int	DefaultDumpVerbosity = 1U
	Default verbosity level. More...
static constexpr unsigned int	MaxDumpVerbosity = recob::Trajectory::MaxDumpVerbosity
	Maximum verbosity level. More...
template<typename Stream >
void	dump (Stream &&out, unsigned int verbosity, std::string indent, std::string firstIndent) const
	Prints the content of this object into an output stream. More...
template<typename Stream >
void	dump (Stream &&out, unsigned int verbosity=DefaultDumpVerbosity, std::string indent="") const

Detailed Description

Pseudo-track object for TotallyCheatTracks example.

This class represents a reconstructed track via a trajectory in phase space (position plus momentum), sampled in many points, and in addition a particle identification code representing the type of the original particle.

It is expected to be unrealistically precise for a reconstructed object, by being constructed from simulated "truth" information.

This track object does not implement the standard interface of a LArSoft track (recob::Track). It can present a standard LArSoft recob::Trajectory though.

Definition at line 52 of file CheatTrack.h.

Member Typedef Documentation

using lar::example::CheatTrack::PDGID_t = int

Type of the particle ID.

Definition at line 56 of file CheatTrack.h.

Constructor & Destructor Documentation

lar::example::CheatTrack::CheatTrack ( )

default

Default constructor, only for ROOT I/O (do not use it!).

lar::example::CheatTrack::CheatTrack ( recob::Trajectory &&  traj, PDGID_t  pid  )

inline

Constructor from trajectory (stolen) and particle ID.

Parameters

traj	the reconstructed trajectory of the track
pid	particle ID, in PDG standard

The trajectory in traj is moved into this object, and it will not be valid in the caller scope any more.

Definition at line 72 of file CheatTrack.h.

        : fTraj(std::move(traj))
        , fPDGID(pid)
        {}

Member Function Documentation

template<typename Stream >

void lar::example::CheatTrack::dump	(	Stream &&	out,
		unsigned int	verbosity,
		std::string	indent,
		std::string	firstIndent
	)		const

Prints the content of this object into an output stream.

Template Parameters

Stream

type of the output text stream

Parameters

out	the output text stream
verbosity	the amount of information printed (default: DefaultDumpVerbosity)
indent	indentation string for all output except the first line (default: none)
firstIndent	indentation string for the first line (default: as indent)

Verbosity level is the same as the one of recob::Trajectory::Dump(). In addition, the momentum and particle ID are always printed.

Definition at line 168 of file CheatTrack.h.

{

  // we could use ROOT's TDatabasePDG to get the name of the ID, but we'd rather
  // not depend on ROOT here...
  out << firstIndent
    << "particle: ";
  auto const* pPDGinfo = TDatabasePDG::Instance()->GetParticle(particleId());
  if (pPDGinfo) out << pPDGinfo->GetName() << " (ID=" << particleId() << ")";
  else          out << "ID " << particleId();
  out << "; momentum: " << momentum() << " GeV/c; ";
  trajectory().Dump(std::forward<Stream>(out), verbosity, indent, "");

} // lar::example::CheatTrack::dump()

template<typename Stream >

void lar::example::CheatTrack::dump ( Stream &&  out, unsigned int  verbosity = DefaultDumpVerbosity, std::string  indent = ""  ) const

inline

Definition at line 130 of file CheatTrack.h.

        { dump(std::forward<Stream>(out), verbosity, indent, indent); }

bool lar::example::CheatTrack::hasParticleId ( ) const

inline

Returns whether the particle ID is valid.

Definition at line 92 of file CheatTrack.h.

{ return particleId() != InvalidParticleID; }

double lar::example::CheatTrack::momentum ( ) const

inline

Returns the initial momentum of the particle [MeV].

Definition at line 86 of file CheatTrack.h.

{ return trajectory().StartMomentum(); }

PDGID_t lar::example::CheatTrack::particleId ( ) const

inline

Returns the particle ID, in PDG standard.

Definition at line 89 of file CheatTrack.h.

{ return fPDGID; }

recob::Trajectory const& lar::example::CheatTrack::trajectory ( ) const

inline

Returns the trajectory of this track.

Definition at line 79 of file CheatTrack.h.

{ return fTraj; }

Friends And Related Function Documentation

std::ostream & operator<< ( std::ostream &  out, lar::example::CheatTrack const &  track  )

related

Prints the content of the track into a text stream.

Definition at line 153 of file CheatTrack.h.

      { track.dump(out); return out; }

Member Data Documentation

constexpr unsigned int lar::example::CheatTrack::DefaultDumpVerbosity = 1U

static

Default verbosity level.

Definition at line 102 of file CheatTrack.h.

PDGID_t lar::example::CheatTrack::fPDGID = InvalidParticleID

private

Particle ID in PDG standard.

Definition at line 144 of file CheatTrack.h.

recob::Trajectory lar::example::CheatTrack::fTraj

private

The trejectory of this track.

Definition at line 143 of file CheatTrack.h.

constexpr PDGID_t lar::example::CheatTrack::InvalidParticleID = 0

static

Value of a particle ID that denotes it as invalid.

Definition at line 59 of file CheatTrack.h.

constexpr unsigned int lar::example::CheatTrack::MaxDumpVerbosity = recob::Trajectory::MaxDumpVerbosity

static

Maximum verbosity level.

Definition at line 106 of file CheatTrack.h.

---

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

• larexamples/larexamples/Algorithms/TotallyCheatTracks/CheatTrackData/CheatTrack.h