Auxiliary class to set-up Trk. More...

#include <JSirene.hh>

Inheritance diagram for JSIRENE::JTrk_t:

Public Member Functions
	JTrk_t (const int id, const int type, const int mother_id, const Vec &pos, const Vec &dir, const double t, const double E)
	Constructor.

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

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

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

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

bool	is_finalstate () const
	Test whether given particle is a final state inside the detector.

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

bool	is_e () const
	Check if this is an electron or positron.

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

bool	is_tau () const
	Check if this is a tau.

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

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

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.

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

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

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

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

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

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

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

void	clearusr ()
	Clear user data.

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

Public Attributes
int	id
	track identifier

Vec	pos
	postion [m] of the track at time t

Vec	dir
	track direction

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

double	E
	Energy [GeV] (either MC truth or reconstructed)

double	len
	length, if applicable [m]

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

int	type
	MC: particle type in PDG encoding.

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

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

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

int	mother_id
	MC id of the parent particle.

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

std::vector< double >	fitinf
	place to store additional fit info, see km3net-dataformat/definitions/fitparameters.csv

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

std::vector< double >	error_matrix
	(NxN) error covariance matrix for fit parameters (stored as linear vector)

std::string	comment
	use as you like

std::vector< double >	usr
	user data

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

TObject *	any
	Pointer to "any" user data.

Detailed Description

Auxiliary class to set-up Trk.

Definition at line 188 of file JSirene.hh.

Constructor & Destructor Documentation

◆ JTrk_t()

JSIRENE::JTrk_t::JTrk_t	(	const int	id,
		const int	type,
		const int	mother_id,
		const Vec &	pos,
		const Vec &	dir,
		const double	t,
		const double	E )

inline

Constructor.

Parameters

id	identifier
type	type
mother_id	mother identifier
pos	position
dir	direction
t	time [ns]
E	energy [GeV]

Definition at line 202 of file JSirene.hh.

    {
      this->id        = id;
      this->type      = type;
      this->mother_id = mother_id;
      this->pos       = pos;
      this->dir       = dir;
      this->t         = t;
      this->E         = E;
    }

Member Function Documentation

◆ read()

void Trk::read ( const Trk & t )

inlineinherited

Read track (useful in python).

Parameters

t track

Definition at line 50 of file Trk.hh.

50{ *this = t;}

◆ write()

void Trk::write ( Trk & t ) const

inlineinherited

Write track (useful in python).

Parameters

t track

Definition at line 57 of file Trk.hh.

57{ t = *this; }

◆ name()

std::string Trk::name ( ) const

inlineinherited

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

◆ is_primary()

bool Trk::is_primary ( ) const

inlineinherited

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

◆ is_finalstate()

bool Trk::is_finalstate ( ) const

inlineinherited

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

Returns: true if particle is final state; else false

Definition at line 87 of file Trk.hh.

  {
    return status==TRK_ST_FINALSTATE;
  }

◆ is_neutrino()

bool Trk::is_neutrino ( ) const

inlineinherited

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

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

◆ is_e()

bool Trk::is_e ( ) const

inlineinherited

Check if this is an electron or positron.

Returns: true if this is an electron or positron

Definition at line 109 of file Trk.hh.

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

◆ is_muon()

bool Trk::is_muon ( ) const

inlineinherited

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

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

◆ is_tau()

bool Trk::is_tau ( ) const

inlineinherited

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

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

◆ is_lepton()

bool Trk::is_lepton ( ) const

inlineinherited

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

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

◆ is_orphan()

bool Trk::is_orphan ( ) const

inlineinherited

Check if this is an orphan (i.e.

no mother).

Returns: true if orphan; else false

Definition at line 155 of file Trk.hh.

  {
    return mother_id == TRK_MOTHER_NONE;
  }

◆ get_daughters()

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

inlineinherited

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 166 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 = std::cout ) const

inlineinherited

Print track.

Parameters

out	output stream

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

Member Data Documentation

◆ id

int Trk::id

inherited

track identifier

Definition at line 16 of file Trk.hh.

◆ pos

Vec Trk::pos

inherited

postion [m] of the track at time t

Definition at line 17 of file Trk.hh.

◆ dir

Vec Trk::dir

inherited

track direction

Definition at line 18 of file Trk.hh.

◆ t

double Trk::t

inherited

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

Definition at line 19 of file Trk.hh.

◆ E

double Trk::E

inherited

Energy [GeV] (either MC truth or reconstructed)

Definition at line 20 of file Trk.hh.

◆ len

double Trk::len

inherited

length, if applicable [m]

Definition at line 22 of file Trk.hh.

◆ lik

double Trk::lik

inherited

likelihood or lambda value (for aafit, lambda)

Definition at line 23 of file Trk.hh.

◆ type

int Trk::type

inherited

MC: particle type in PDG encoding.

Definition at line 24 of file Trk.hh.

◆ rec_type

int Trk::rec_type

inherited

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

Definition at line 25 of file Trk.hh.

◆ rec_stages

std::vector<int> Trk::rec_stages

inherited

list of identifyers of succesfull fitting stages resulting in this track

Definition at line 26 of file Trk.hh.

◆ status

int Trk::status

inherited

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

Definition at line 28 of file Trk.hh.

◆ mother_id

int Trk::mother_id

inherited

MC id of the parent particle.

Definition at line 29 of file Trk.hh.

◆ counter

int Trk::counter

inherited

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

Definition at line 30 of file Trk.hh.

◆ fitinf

std::vector<double> Trk::fitinf

inherited

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

Definition at line 32 of file Trk.hh.

◆ hit_ids

std::vector<int> Trk::hit_ids

inherited

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

Definition at line 33 of file Trk.hh.

◆ error_matrix

std::vector<double> Trk::error_matrix

inherited

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

Definition at line 34 of file Trk.hh.

◆ comment

std::string Trk::comment

inherited

use as you like

Definition at line 35 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 171 of file AAObject.hh.

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

JSirene.hh

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JTrk_t()

Member Function Documentation

◆ read()

◆ write()

◆ name()

◆ is_primary()

◆ is_finalstate()

◆ is_neutrino()

◆ is_e()

◆ is_muon()

◆ is_tau()

◆ is_lepton()

◆ is_orphan()

◆ get_daughters()

◆ print()

◆ idx()

◆ haveusr()

◆ idxusr_checked()

◆ getusr()

◆ setusr()

◆ delusr()

◆ clearusr()

◆ printusr()

Member Data Documentation

◆ id

◆ pos

◆ dir

◆ t

◆ E

◆ len

◆ lik

◆ type

◆ rec_type

◆ rec_stages

◆ status

◆ mother_id

◆ counter

◆ fitinf

◆ hit_ids

◆ error_matrix

◆ comment

◆ usr

◆ usr_names

◆ any