The Trk class represents a Monte Carlo (MC) particle as well as a reconstructed track/shower. More...

#include <Trk.hh>

Inheritance diagram for Trk:

Public Member Functions
	Trk ()
	Default constructor. More...

void	read (const Trk &t)
	Read track (useful in python). More...

void	write (Trk &t) const
	Write track (useful in python). More...

double	distance_to (const Trk &t) const
	Get distance of closes approach to another track. More...

double	distance_to (const Vec &p=Vec()) const
	Get distance to given position. More...

std::string	name () const
	Get the name of the MC particle type. More...

bool	is_primary () const
	Check if this is a primary particle (i.e. More...

bool	is_neutrino () const
	Check if this is a netrino. More...

bool	is_lepton () const
	Check if this is a charged lepton. More...

bool	is_muon () const
	Check if this is a muon. More...

bool	is_orphan () const
	Check if this is an orphan. More...

std::vector< Trk * >	get_daughters (std::vector< Trk > &mctrks)
	Get list of of pointers to tracks, all of which have their mother identifier set to identifier of this track. More...

void	print (std::ostream &out) const
	Print track. More...

int	idx (const std::string &key) const
	Get index in user data of the item with given key. More...

bool	haveusr (const std::string &key) const
	Check availability of user data of the item with given key. More...

int	idxusr_checked (const std::string &key) const
	Get index in user data of the item with given key. More...

double	getusr (const std::string &key) const
	Get user data item with given key. More...

void	setusr (const std::string &key, double value)
	Set user data item with given key. More...

bool	delusr (const std::string &key)
	Remove (first) user data item with given key. More...

void	clearusr ()
	Clear user data. More...

void	printusr (std::ostream &out=std::cout)
	Print user data (i.e. More...

const char *	__str__ () const
	Get class name. More...

Public Attributes
int	id
	track identifier More...

Vec	pos
	postion of the track at time t More...

Vec	dir
	track direction More...

double	t
	track time (when the particle is at pos ) More...

double	E
	Energy (either MC truth or reconstructed) More...

double	len
	length, if applicable More...

double	lik
	likelihood or lambda value (for aafit, lambda) More...

int	type
	MC: particle type in PDG encoding. More...

int	rec_type
	identifyer for the overall fitting algorithm/chain/strategy More...

std::vector< int >	rec_stages
	list of identifyers of succesfull fitting stages resulting in this track More...

int	status
	MC status code. More...

int	mother_id
	MC id of the parent particle. More...

std::vector< double >	fitinf
	place to store additional fit info, for jgandalf, see JFitParameters.hh More...

std::vector< int >	hit_ids
	list of associated hit-ids (corresponds to Hit::id). More...

std::vector< double >	error_matrix
	(5x5) error covariance matrix (stored as linear vector) More...

std::string	comment
	use as you like More...

std::vector< double >	usr
	user data More...

std::vector< std::string >	usr_names
	user keys More...

TObject *	any
	Pointer to "any" user data. More...

Detailed Description

The Trk class represents a Monte Carlo (MC) particle as well as a reconstructed track/shower.

Definition at line 12 of file Trk.hh.

Constructor & Destructor Documentation

◆ Trk()

Trk::Trk ( )

inline

Default constructor.

Definition at line 37 of file Trk.hh.

37 : id(0),t(0),E(0),len(0),lik(0), type(0), rec_type(0), status(0), mother_id(-1) {}

Member Function Documentation

◆ read()

void Trk::read ( const Trk & t )

inline

Read track (useful in python).

Parameters

t track

Definition at line 44 of file Trk.hh.

44 { *this = t;}

◆ write()

void Trk::write ( Trk & t ) const

inline

Write track (useful in python).

Parameters

t track

Definition at line 51 of file Trk.hh.

51 { t = *this; }

◆ distance_to() [1/2]

double Trk::distance_to ( const Trk & t ) const

inline

Get distance of closes approach to another track.

Parameters

t track

Returns: distance

Definition at line 60 of file Trk.hh.

   {
     Vec v = dir.cross( t.dir );
     v /= v.len();
     const double d = (pos - t.pos ).dot( v );
     return d>0?d:-d;
   }

◆ distance_to() [2/2]

double Trk::distance_to ( const Vec & p = Vec() ) const

inline

Get distance to given position.

Parameters

p position

Returns: distance

Definition at line 74 of file Trk.hh.

   {
     Vec v = p - pos;
     double dz = v.dot(dir);
     return v.dot(v) - dz*dz;
   }

◆ name()

std::string Trk::name ( ) const

inline

Get the name of the MC particle type.

Returns: name

Definition at line 86 of file Trk.hh.

   {
     TParticlePDG* p = TDatabasePDG::Instance()->GetParticle( type );
     if (!p) return "unnamed state ("+ std::to_string(type)+")";
     return p->GetName();
   }

◆ is_primary()

bool Trk::is_primary ( ) const

inline

Check if this is a primary particle (i.e.

has not mother).

Returns: true if primary; else false

Definition at line 98 of file Trk.hh.

   {
     return mother_id == -1; // and/or status==0 ?
   }

◆ is_neutrino()

bool Trk::is_neutrino ( ) const

inline

Check if this is a netrino.

Note that its is checked if the PDG type is a nu-e, nu-mu or nu-tau.

Returns: true if neutrino; else false

Definition at line 110 of file Trk.hh.

   {
     const unsigned t = abs(type);
     return t == 12 || t == 14 || t == 16;
   }

◆ is_lepton()

bool Trk::is_lepton ( ) const

inline

Check if this is a charged lepton.

Note that its is checked if the PDG type is a (anti-)electron, (anti-)muon or (anti-)tua.

Returns: true if charged lepton; else false

Definition at line 123 of file Trk.hh.

   {
     const unsigned t = abs(type);
     return t == 11 || t == 13 || t == 15;
   }

◆ is_muon()

bool Trk::is_muon ( ) const

inline

Check if this is a muon.

Note that its is checked if the PDG type is a (anti-)muon.

Returns: true if muon; else false

Definition at line 136 of file Trk.hh.

136 { return abs(type)==13; }

◆ is_orphan()

bool Trk::is_orphan ( ) const

inline

Check if this is an orphan.

If a particle's (intermediate) mother has been deleted from the track-list (the 3rd digit of status==1).

Returns: true if orphan; else false

Definition at line 145 of file Trk.hh.

   {
     return (status / 100) % 10 == 1;
   }

◆ get_daughters()

std::vector< Trk* > Trk::get_daughters ( std::vector< Trk > & mctrks )

inline

Get list of of pointers to tracks, all of which have their mother identifier set to identifier of this track.

Parameters

mctrks list of input tracks

Returns: list of pointers to tracks

Definition at line 156 of file Trk.hh.

   {
     std::vector<Trk*> r;
  
     for( auto& t : mctrks )
       {
         if ( t.mother_id == id ) r.push_back( &t );
       }
     return r;
   }

◆ print()

void Trk::print ( std::ostream & out ) const

inline

Print track.

Parameters

out	output stream

Definition at line 172 of file Trk.hh.

   {
     out << "Trk: id=" << id << " pos="; pos.print(out);
     out << " dir="; dir.print(out);
     out << " t=" << t << " E=" << E << " pdg-type=" << type;
   }

◆ idx()

int AAObject::idx ( const std::string & key ) const

inlineinherited

Get index in user data of the item with given key.

Parameters

key key

Returns: index (-1 if key does not exists)

Definition at line 29 of file AAObject.hh.

   {
     auto i = std::find (usr_names.begin(), usr_names.end(), key );
     if (i == usr_names.end()) return -1;
     return i - usr_names.begin();
   }

◆ haveusr()

bool AAObject::haveusr ( const std::string & key ) const

inlineinherited

Check availability of user data of the item with given key.

Parameters

key key

Returns: true if available; else false

Definition at line 42 of file AAObject.hh.

   {
     return idx( key ) >= 0;
   }

◆ idxusr_checked()

int AAObject::idxusr_checked ( const std::string & key ) const

inlineinherited

Get index in user data of the item with given key.

This method throws a run-time exception if no user data are available.

Parameters

key key

Returns: index (-1 if key does not exists)

Definition at line 54 of file AAObject.hh.

   {
     int r = idx( key );
     if (r < 0)
       {
         THROW(Exception, "No user data for key " << key << " in aanet object of type " << this -> ClassName());
       }
     return r;
   }

◆ getusr()

double AAObject::getusr ( const std::string & key ) const

inlineinherited

Get user data item with given key.

This method throws a run-time exception if no user data are available.

Parameters

key key

Returns: value

Definition at line 72 of file AAObject.hh.

   {
     const int i = idx( key );
  
     if ( i  < 0 )
       {
         THROW(Exception, "No user data for key " << key << " in aanet object of type " << this -> ClassName());
       }
  
     if ( unsigned(i) >= usr.size() )
       {
         THROW(Exception, "Warning: inconsistent user data " << i << " >= " << usr.size());
       }
  
     return usr[i];
   }

◆ setusr()

void AAObject::setusr	(	const std::string &	key,
		double	value
	)

inlineinherited

Set user data item with given key.

Parameters

key	key
value	value

Definition at line 95 of file AAObject.hh.

   {
     int i = idx( key );
     if (i < 0)
       {
         if ( usr.size() < usr_names.size() )
           {
             // this should not happen, but let's just add empty data
             usr.resize( usr_names.size() );
           }
         else
           {
             // this is possible, add empty ("") names
             usr_names.resize( usr.size() );
           }
  
         usr_names.push_back( key );
         usr.push_back( value );
       }
     else
       {
         usr[i] = value;
       }
   }  

◆ delusr()

bool AAObject::delusr ( const std::string & key )

inlineinherited

Remove (first) user data item with given key.

Parameters

key key

Returns: true if data have been removed; else false

Definition at line 126 of file AAObject.hh.

   {
     int i = idx( key );
     if ( i < 0 ) return false;
  
     usr.erase ( usr.begin() + i );
     usr_names.erase( usr_names.begin() + i );
     return true;
   }

◆ clearusr()

void AAObject::clearusr ( )

inlineinherited

Clear user data.

Definition at line 139 of file AAObject.hh.

   {
     usr.resize(0);
     usr_names.resize(0);
   }

◆ printusr()

void AAObject::printusr ( std::ostream & out = std::cout )

inlineinherited

Print user data (i.e.

list of all pairs of keys and values).

Parameters

out	output stream

Definition at line 150 of file AAObject.hh.

   {
     unsigned n = std::max( usr.size(), usr_names.size() );
     
     for (unsigned i=0; i< n ;i++)
       {
         std::string name = "(unnamed)";
         if ( i < usr_names.size() && usr_names[i] != "" ) name = usr_names[i];
         out << i << " \t " << name << " : \t ";
         if ( i < usr.size() ) out << usr[i] << std::endl;
         else                  out << "(none)" << std::endl;
       }
   }

◆ str()

const char* AAObject::__str__ ( ) const

inlineinherited

Get class name.

Returns: class name

Definition at line 175 of file AAObject.hh.

175 { return Class_Name(); }

Member Data Documentation

◆ id

int Trk::id

track identifier

Definition at line 14 of file Trk.hh.

◆ pos

Vec Trk::pos

postion of the track at time t

Definition at line 15 of file Trk.hh.

◆ dir

Vec Trk::dir

track direction

Definition at line 16 of file Trk.hh.

◆ t

double Trk::t

track time (when the particle is at pos )

Definition at line 17 of file Trk.hh.

◆ E

double Trk::E

Energy (either MC truth or reconstructed)

Definition at line 18 of file Trk.hh.

◆ len

double Trk::len

length, if applicable

Definition at line 20 of file Trk.hh.

◆ lik

double Trk::lik

likelihood or lambda value (for aafit, lambda)

Definition at line 21 of file Trk.hh.

◆ type

int Trk::type

MC: particle type in PDG encoding.

Definition at line 22 of file Trk.hh.

◆ rec_type

int Trk::rec_type

identifyer for the overall fitting algorithm/chain/strategy

Definition at line 23 of file Trk.hh.

◆ rec_stages

std::vector<int> Trk::rec_stages

list of identifyers of succesfull fitting stages resulting in this track

Definition at line 24 of file Trk.hh.

◆ status

int Trk::status

MC status code.

Definition at line 26 of file Trk.hh.

◆ mother_id

int Trk::mother_id

MC id of the parent particle.

Definition at line 27 of file Trk.hh.

◆ fitinf

std::vector<double> Trk::fitinf

place to store additional fit info, for jgandalf, see JFitParameters.hh

Definition at line 29 of file Trk.hh.

◆ hit_ids

std::vector<int> Trk::hit_ids

list of associated hit-ids (corresponds to Hit::id).

Definition at line 30 of file Trk.hh.

◆ error_matrix

std::vector<double> Trk::error_matrix

(5x5) error covariance matrix (stored as linear vector)

Definition at line 31 of file Trk.hh.

◆ comment

std::string Trk::comment

use as you like

Definition at line 32 of file Trk.hh.

◆ usr

std::vector<double> AAObject::usr

inherited

user data

Definition at line 20 of file AAObject.hh.

◆ usr_names

std::vector<std::string> AAObject::usr_names

inherited

user keys

Definition at line 21 of file AAObject.hh.

◆ any

TObject* AAObject::any

inherited

Pointer to "any" user data.

Definition at line 177 of file AAObject.hh.

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

Trk.hh

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Trk()

Member Function Documentation

◆ read()

◆ write()

◆ distance_to() [1/2]

◆ distance_to() [2/2]

◆ name()

◆ is_primary()

◆ is_neutrino()

◆ is_lepton()

◆ is_muon()

◆ is_orphan()

◆ get_daughters()

◆ print()

◆ idx()

◆ haveusr()

◆ idxusr_checked()

◆ getusr()

◆ setusr()

◆ delusr()

◆ clearusr()

◆ printusr()

◆ __str__()

Member Data Documentation

◆ id

◆ pos

◆ dir

◆ t

◆ E

◆ len

◆ lik

◆ type

◆ rec_type

◆ rec_stages

◆ status

◆ mother_id

◆ fitinf

◆ hit_ids

◆ error_matrix

◆ comment

◆ usr

◆ usr_names

◆ any

◆ str()