Trk Struct Reference

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...
std::string	name () const
	Get the name of the MC particle type. More...
bool	is_primary () const
	Check if this is a primary particle. More...
bool	is_finalstate () const
	Test whether given particle is a final state inside the detector. More...
bool	is_neutrino () const
	Check if this is a netrino. More...
bool	is_e () const
	Check if this is an electron or positron. More...
bool	is_muon () const
	Check if this is a muon. More...
bool	is_tau () const
	Check if this is a tau. More...
bool	is_lepton () const
	Check if this is a charged lepton. More...
bool	is_orphan () const
	Check if this is an orphan (i.e. 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=std::cout) 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...

Public Attributes
int	id
	track identifier More...
Vec	pos
	postion [m] of the track at time t More...
Vec	dir
	track direction More...
double	t
	track time [ns] (when the particle is at pos ) More...
double	E
	Energy [GeV] (either MC truth or reconstructed) More...
double	len
	length, if applicable [m] More...
double	lik
	likelihood or lambda value (for aafit, lambda) More...
int	type
	MC: particle type in PDG encoding. More...
int	rec_type
	identifier of the fitting algorithm/chain/strategy, see km3net-dataformat/definitions/reconstruction.csv More...
std::vector< int >	rec_stages
	list of identifyers of succesfull fitting stages resulting in this track More...
int	status
	MC status code, see km3net-dataformat/definitions/trkmembers.csv for values. More...
int	mother_id
	MC id of the parent particle. More...
int	counter
	used by CORSIKA7 MC generation to store interaction counters, see CORSIKA Userguide More...
std::vector< double >	fitinf
	place to store additional fit info, see km3net-dataformat/definitions/fitparameters.csv More...
std::vector< int >	hit_ids
	list of associated hit-ids (corresponds to Hit::id). More...
std::vector< double >	error_matrix
	(NxN) error covariance matrix for fit parameters (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 14 of file Trk.hh.

Constructor & Destructor Documentation

Trk::Trk ( )

inline

Default constructor.

Definition at line 40 of file Trk.hh.

: id(0),t(0),E(0),len(0),lik(0), type(0), rec_type(0), status(TRK_ST_UNDEFINED), mother_id(TRK_MOTHER_UNDEFINED), counter(0) {}

Member Function Documentation

void Trk::read ( const Trk &  t )

inline

Read track (useful in python).

Parameters

t

track

Definition at line 50 of file Trk.hh.

{ *this = t;}

void Trk::write ( Trk &  t ) const

inline

Write track (useful in python).

Parameters

t

track

Definition at line 57 of file Trk.hh.

{ t = *this; }

std::string Trk::name ( ) const

inline

Get the name of the MC particle type.

Returns

name

Definition at line 65 of file Trk.hh.

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

bool Trk::is_primary ( ) const

inline

Check if this is a primary particle.

Returns

true if primary; else false

Definition at line 77 of file Trk.hh.

  {
    return status==TRK_ST_PRIMARYNEUTRINO || status==TRK_ST_PRIMARYCOSMIC;
  }

bool Trk::is_finalstate ( ) const

inline

Test whether given particle is a final state inside the detector.

Parameters

track

track

Returns

true if particle is final state; else false

Definition at line 88 of file Trk.hh.

  {
    return status==TRK_ST_FINALSTATE;
  }

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 100 of file Trk.hh.

  {
    return type == kNuE || type == kNuEBar || type == kNuMu || type == kNuMuBar || type == kNuTau || type == kNuTauBar;
  }

bool Trk::is_e ( ) const

inline

Check if this is an electron or positron.

Returns

true if this is an electron or positron

Definition at line 110 of file Trk.hh.

  {
     return type == kElectron || type == kPositron;
  }

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 122 of file Trk.hh.

  {
    return type == kMuonMinus || type == kMuonPlus;
  }

bool Trk::is_tau ( ) const

inline

Check if this is a tau.

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

Returns

true if tau; else false

Definition at line 134 of file Trk.hh.

  {
    return type == kTauMinus || type == kTauPlus;
  }

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 146 of file Trk.hh.

  {
    return is_e() || is_muon() || is_tau();
  }

bool Trk::is_orphan ( ) const

inline

Check if this is an orphan (i.e.

no mother).

Returns

true if orphan; else false

Definition at line 156 of file Trk.hh.

  {
    return mother_id == TRK_MOTHER_NONE;
  }

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 167 of file Trk.hh.

  {
    std::vector<Trk*> r;

    for( auto& t : mctrks )
      {
             if ( t.mother_id == id ) r.push_back( &t );
      }
    return r;
  }

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

inline

Print track.

Parameters

out	output stream

Definition at line 183 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;
  }

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();
  }

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;
  }

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;
  }

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];
  }

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;
    }
  }

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;
  }

void AAObject::clearusr ( )

inlineinherited

Clear user data.

Definition at line 139 of file AAObject.hh.

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

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;
    }
  }

Member Data Documentation

int Trk::id

track identifier

Definition at line 16 of file Trk.hh.

Vec Trk::pos

postion [m] of the track at time t

Definition at line 17 of file Trk.hh.

Vec Trk::dir

track direction

Definition at line 18 of file Trk.hh.

double Trk::t

track time [ns] (when the particle is at pos )

Definition at line 19 of file Trk.hh.

double Trk::E

Energy [GeV] (either MC truth or reconstructed)

Definition at line 20 of file Trk.hh.

double Trk::len

length, if applicable [m]

Definition at line 22 of file Trk.hh.

double Trk::lik

likelihood or lambda value (for aafit, lambda)

Definition at line 23 of file Trk.hh.

int Trk::type

MC: particle type in PDG encoding.

Definition at line 24 of file Trk.hh.

int Trk::rec_type

identifier of the fitting algorithm/chain/strategy, see km3net-dataformat/definitions/reconstruction.csv

Definition at line 25 of file Trk.hh.

std::vector<int> Trk::rec_stages

list of identifyers of succesfull fitting stages resulting in this track

Definition at line 26 of file Trk.hh.

int Trk::status

MC status code, see km3net-dataformat/definitions/trkmembers.csv for values.

Definition at line 28 of file Trk.hh.

int Trk::mother_id

MC id of the parent particle.

Definition at line 29 of file Trk.hh.

int Trk::counter

used by CORSIKA7 MC generation to store interaction counters, see CORSIKA Userguide

Definition at line 30 of file Trk.hh.

std::vector<double> Trk::fitinf

place to store additional fit info, see km3net-dataformat/definitions/fitparameters.csv

Definition at line 32 of file Trk.hh.

std::vector<int> Trk::hit_ids

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

Definition at line 33 of file Trk.hh.

std::vector<double> Trk::error_matrix

(NxN) error covariance matrix for fit parameters (stored as linear vector)

Definition at line 34 of file Trk.hh.

std::string Trk::comment

use as you like

Definition at line 35 of file Trk.hh.

std::vector<double> AAObject::usr

inherited

user data

Definition at line 20 of file AAObject.hh.

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

inherited

user keys

Definition at line 21 of file AAObject.hh.

TObject* AAObject::any

inherited

Pointer to "any" user data.

Definition at line 171 of file AAObject.hh.

---

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

• Trk.hh