icarus::trigger::details::EventInfo_t Struct Reference

Selected information about the event. More...

#include <EventInfo_t.h>

Public Types
Local type aliases
using	GeV = util::quantities::gigaelectronvolt
using	simulation_time = detinfo::timescales::simulation_time

Public Member Functions
	EventInfo_t ()
	Constructor. As if nobody noticed. More...
void	dump (std::ostream &out) const
	Prints the content of the object into a stream. More...
Generation information
The information is available only if hasGenerated() returns true. Otherwise, the return value of all the members in this group is undefined.
bool	hasGenerated () const
	Returns whether generator information is available. More...
unsigned int	nWeakChargedCurrentInteractions () const
	Returns the number of weak charged current interactions in the event. More...
unsigned int	nWeakNeutralCurrentInteractions () const
	Returns the number of weak neutral current interactions in the event. More...
unsigned int	nWeakCurrentInteractions () const
	Returns the number of weak current interactions in the event. More...
bool	isWeakChargedCurrent () const
	Returns whether the event is generated as a neutrino CC interaction. More...
bool	isWeakNeutralCurrent () const
	Returns whether the event is generated as a neutrino NC interaction. More...
bool	isNeutrino () const
	Returns whether the event is generated as a neutrino interaction. More...
bool	isNu_mu () const
	Returns which neutrino flavor is present in an event. More...
bool	isNu_e () const
int	NeutrinoPDG () const
	Returns the neutrino PDG code. More...
GeV	NeutrinoEnergy () const
	Returns the neutrino energy [GeV]. More...
GeV	LeptonEnergy () const
	Returns the lepton energy [GeV]. More...
int	InteractionType () const
	Returns the interaction type. More...
simulation_time	InteractionTime () const
	Returns the time of the first interaction, in simulation time scale [ns]. More...
bool	hasVertex () const
	Returns whether this type of event has a known vertex. More...
unsigned int	nVertices () const
	Returns the number of known interaction vertices. More...
std::vector< geo::Point_t > const &	Vertices () const
	Returns the list of a known interaction vertex. More...
bool	isInActiveVolume () const
	Returns whether there is an interaction within the active volume. More...
Deposited energy information
The information is available only if hasDepEnergy() returns true. Otherwise, the return value of all the members in this group is undefined.
bool	hasDepEnergy () const
	Returns whether generator information is available. More...
GeV	DepositedEnergy () const
	Returns the total energy deposited in the detector during the event [GeV]. More...
GeV	DepositedEnergyInSpill () const
	Returns the total energy deposited in the detector during beam [GeV]. More...
GeV	DepositedEnergyInPreSpill () const
GeV	DepositedEnergyInActiveVolume () const
	Returns the energy deposited in the active volume during the event [GeV]. More...
GeV	DepositedEnergyInSpillInActiveVolume () const
	Returns the energy deposited in the active volume during the beam [GeV]. More...
GeV	DepositedEnergyInPreSpillInActiveVolume () const
Set interface
void	AddWeakChargedCurrentInteractions (unsigned int n=1U)
	Marks this event as including n more weak charged current interactions. More...
void	AddWeakNeutralCurrentInteractions (unsigned int n=1U)
	Marks this event as including n more weak neutral current interactions. More...
void	SetNu_mu (bool numu)
	Marks the flavor of the neutrino in the first interaction. More...
void	SetNu_e (bool nue)
void	SetNeutrinoPDG (int NU)
	Marks the neutrino type of the first interaction in the event. More...
void	SetNeutrinoEnergy (GeV eNu)
	Sets the neutrino energy. More...
void	SetLeptonEnergy (GeV eL)
	Sets the lepton energy. More...
void	SetInteractionType (int type)
	Sets the interaction type. More...
void	SetInteractionTime (simulation_time time)
	Sets the time of the first interaction. More...
void	SetInActiveVolume (bool active=true)
	Set whether the event has relevant activity in the active volume. More...
void	AddVertex (geo::Point_t const &vertex)
	Adds a point to the list of interaction vertices in the event. More...
void	InsertVertex (geo::Point_t const &vertex, std::size_t beforeIndex)
void	SetDepositedEnergy (GeV e)
	Sets the total deposited energy of the event [GeV]. More...
void	SetDepositedEnergyInSpill (GeV e)
	Sets the energy of the event deposited during beam gate [GeV]. More...
void	SetDepositedEnergyInPreSpill (GeV e)
	Sets the energy of the event deposited during pre-spill window [GeV]. More...
void	SetDepositedEnergyInActiveVolume (GeV e)
	Sets the total deposited energy of the event in active volume [GeV]. More...
void	SetDepositedEnergyInSpillInActiveVolume (GeV e)
void	SetDepositedEnergyInPreSpillInActiveVolume (GeV e)

Private Member Functions
void	setGen ()
	Declares that this object has generator information. More...
void	setDep ()
	Declares that this object has deposited energy information. More...

Private Attributes
bool	fHasGenerated = false
	Whether generation information is available. More...
std::array< unsigned int, NInteractionTypes >	fInteractions
int	fNeutrinoPDG { 0 }
int	fInteractionType { 0 }
simulation_time	fInteractionTime
	Time of the first interaction [ns]. More...
GeV	fNeutrinoEnergy { 0.0 }
GeV	fLeptonEnergy { 0.0 }
bool	nu_mu { false }
bool	nu_e { false }
bool	fInActiveVolume { false }
	Whether the event has activity inside the active volume. More...
std::vector< geo::Point_t >	fVertices
	Position of all vertices. More...
bool	fHasDepEnergy = false
	Whether deposited energy info is available. More...
GeV	fEnergyDepTotal { 0.0 }
	Total deposited energy. More...
GeV	fEnergyDepSpill { 0.0 }
	Energy deposited in spill. More...
GeV	fEnergyDepPreSpill { 0.0 }
	Energy deposited in pre-spill. More...
GeV	fEnergyDepActive { 0.0 }
GeV	fEnergyDepSpillActive { 0.0 }
	Energy deposited in active volume in spill. More...
GeV	fEnergyDepPreSpillActive { 0.0 }
	Energy deposited in active volume in pre-spill window. More...

Static Private Attributes
static constexpr std::size_t	itWCC { 0U }
	Charged weak current. More...
static constexpr std::size_t	itWNC { 1U }
	Neutral weak current. More...
static constexpr std::size_t	NInteractionTypes { 2U }

Detailed Description

Selected information about the event.

This is intended as a record for transferring relevant event information between object.

The exact definition of the quantities is deferred to the user (e.g. when and how long the beam and pre-spill windows are, the definition of active volume, etc.).

Definition at line 45 of file EventInfo_t.h.

Member Typedef Documentation

using icarus::trigger::details::EventInfo_t::GeV = util::quantities::gigaelectronvolt

Definition at line 49 of file EventInfo_t.h.

using icarus::trigger::details::EventInfo_t::simulation_time = detinfo::timescales::simulation_time

Definition at line 50 of file EventInfo_t.h.

Constructor & Destructor Documentation

icarus::trigger::details::EventInfo_t::EventInfo_t ( )

inline

Constructor. As if nobody noticed.

Definition at line 54 of file EventInfo_t.h.

{ fInteractions.fill(0U); }

Member Function Documentation

void icarus::trigger::details::EventInfo_t::AddVertex ( geo::Point_t const &  vertex )

inline

Adds a point to the list of interaction vertices in the event.

Definition at line 205 of file EventInfo_t.h.

    { setGen(); fVertices.push_back(vertex); }

void icarus::trigger::details::EventInfo_t::AddWeakChargedCurrentInteractions ( unsigned int  n = 1U )

inline

Marks this event as including n more weak charged current interactions.

Definition at line 173 of file EventInfo_t.h.

    { setGen(); fInteractions[itWCC] += n; }

void icarus::trigger::details::EventInfo_t::AddWeakNeutralCurrentInteractions ( unsigned int  n = 1U )

inline

Marks this event as including n more weak neutral current interactions.

Definition at line 177 of file EventInfo_t.h.

    { setGen(); fInteractions[itWNC] += n; }

GeV icarus::trigger::details::EventInfo_t::DepositedEnergy ( ) const

inline

Returns the total energy deposited in the detector during the event [GeV].

Definition at line 143 of file EventInfo_t.h.

{ return fEnergyDepTotal; }

GeV icarus::trigger::details::EventInfo_t::DepositedEnergyInActiveVolume ( ) const

inline

Returns the energy deposited in the active volume during the event [GeV].

Definition at line 153 of file EventInfo_t.h.

{ return fEnergyDepActive; }

GeV icarus::trigger::details::EventInfo_t::DepositedEnergyInPreSpill ( ) const

inline

Returns the total energy deposited in the detector in the pre-spill window [GeV]

Definition at line 150 of file EventInfo_t.h.

{ return fEnergyDepPreSpill; }

GeV icarus::trigger::details::EventInfo_t::DepositedEnergyInPreSpillInActiveVolume ( ) const

inline

Returns the energy deposited in the active volume during the pre-spill window [GeV]

Definition at line 161 of file EventInfo_t.h.

    { return fEnergyDepPreSpillActive; }

GeV icarus::trigger::details::EventInfo_t::DepositedEnergyInSpill ( ) const

inline

Returns the total energy deposited in the detector during beam [GeV].

Definition at line 146 of file EventInfo_t.h.

{ return fEnergyDepSpill; }

GeV icarus::trigger::details::EventInfo_t::DepositedEnergyInSpillInActiveVolume ( ) const

inline

Returns the energy deposited in the active volume during the beam [GeV].

Definition at line 156 of file EventInfo_t.h.

    { return fEnergyDepSpillActive; }

void EventInfo_t::dump

(

std::ostream &

out

)

const

Prints the content of the object into a stream.

Definition at line 21 of file EventInfo_t.cxx.

                                                                {
  if (hasGenerated()) {
    out << "Event contains:";
    if (isNeutrino()) {
      if (nWeakChargedCurrentInteractions())
        out << " " << nWeakChargedCurrentInteractions() << " CC";
      if (nWeakNeutralCurrentInteractions())
        out << " " << nWeakNeutralCurrentInteractions() << " NC";
      if (isNu_mu()) out << " nu_mu";
      if (isNu_e()) out << " nu_e";
      out << "\nThe first neutrino has E=" << NeutrinoEnergy()
        << " and becomes a lepton with E=" << LeptonEnergy()
        << " with a " << sim::TruthInteractionTypeName(InteractionType())
        << " interaction at " << InteractionTime()
        ;
    }
    else {
      out << " no neutrino interaction";
    }
  }
  else {
    out << "No generation information is available.";
  }
  if (hasDepEnergy()) {
    out << "\nTotal deposited energy: " << DepositedEnergy()
      << ", of which in spill/pre-spill " << DepositedEnergyInSpill()
        << " / " << DepositedEnergyInPreSpill()
      << ", in active volume " << DepositedEnergyInActiveVolume()
      << ", in active volume and in spill/pre-spill "
        << DepositedEnergyInSpillInActiveVolume()
        << " / " << DepositedEnergyInPreSpillInActiveVolume();
  }
  else {
    out << "\nNo energy deposition information is available.";
  }
  if (hasGenerated()) {
    if (fVertices.empty()) {
      out << "\nNo interaction vertex found.";
    }
    else {
      auto iVertex = fVertices.begin();
      auto const vend = fVertices.end();
      out
        << "\n" << fVertices.size() << " interaction vertices: " << *iVertex;
      while (++iVertex != vend) out << "; " << *iVertex;
      out << ".";
    }
    out << "\nThe event is" << (isInActiveVolume()? "": " NOT")
      << " marked as in the active volume of the detector.";
  }
  out << "\n";
  out.flush();
} // icarus::trigger::details::EventInfo_t::dump()

bool icarus::trigger::details::EventInfo_t::hasDepEnergy ( ) const

inline

Returns whether generator information is available.

Definition at line 140 of file EventInfo_t.h.

{ return fHasDepEnergy; }

bool icarus::trigger::details::EventInfo_t::hasGenerated ( ) const

inline

Returns whether generator information is available.

Definition at line 66 of file EventInfo_t.h.

{ return fHasGenerated; }

bool icarus::trigger::details::EventInfo_t::hasVertex ( ) const

inline

Returns whether this type of event has a known vertex.

Definition at line 115 of file EventInfo_t.h.

{ return !fVertices.empty(); }

void icarus::trigger::details::EventInfo_t::InsertVertex ( geo::Point_t const &  vertex, std::size_t  beforeIndex  )

inline

Inserts a point in the specified position of the list of interaction vertices in the event.

Definition at line 210 of file EventInfo_t.h.

    { setGen(); fVertices.insert(next(begin(fVertices), beforeIndex), vertex); }

simulation_time icarus::trigger::details::EventInfo_t::InteractionTime ( ) const

inline

Returns the time of the first interaction, in simulation time scale [ns].

Definition at line 112 of file EventInfo_t.h.

{ return fInteractionTime; }

int icarus::trigger::details::EventInfo_t::InteractionType ( ) const

inline

Returns the interaction type.

Definition at line 109 of file EventInfo_t.h.

{ return fInteractionType; }

bool icarus::trigger::details::EventInfo_t::isInActiveVolume ( ) const

inline

Returns whether there is an interaction within the active volume.

Definition at line 124 of file EventInfo_t.h.

{ return fInActiveVolume; }

bool icarus::trigger::details::EventInfo_t::isNeutrino ( ) const

inline

Returns whether the event is generated as a neutrino interaction.

Definition at line 92 of file EventInfo_t.h.

    { return isWeakChargedCurrent() || isWeakNeutralCurrent(); }

bool icarus::trigger::details::EventInfo_t::isNu_e ( ) const

inline

Definition at line 97 of file EventInfo_t.h.

{ return nu_e; }

bool icarus::trigger::details::EventInfo_t::isNu_mu ( ) const

inline

Returns which neutrino flavor is present in an event.

Definition at line 96 of file EventInfo_t.h.

{ return nu_mu; }

bool icarus::trigger::details::EventInfo_t::isWeakChargedCurrent ( ) const

inline

Returns whether the event is generated as a neutrino CC interaction.

Definition at line 84 of file EventInfo_t.h.

    { return nWeakChargedCurrentInteractions() > 0U; }

bool icarus::trigger::details::EventInfo_t::isWeakNeutralCurrent ( ) const

inline

Returns whether the event is generated as a neutrino NC interaction.

Definition at line 88 of file EventInfo_t.h.

    { return nWeakNeutralCurrentInteractions() > 0U; }

GeV icarus::trigger::details::EventInfo_t::LeptonEnergy ( ) const

inline

Returns the lepton energy [GeV].

Definition at line 106 of file EventInfo_t.h.

{ return fLeptonEnergy; }

GeV icarus::trigger::details::EventInfo_t::NeutrinoEnergy ( ) const

inline

Returns the neutrino energy [GeV].

Definition at line 103 of file EventInfo_t.h.

{ return fNeutrinoEnergy; }

int icarus::trigger::details::EventInfo_t::NeutrinoPDG ( ) const

inline

Returns the neutrino PDG code.

Definition at line 100 of file EventInfo_t.h.

{ return fNeutrinoPDG; }

unsigned int icarus::trigger::details::EventInfo_t::nVertices ( ) const

inline

Returns the number of known interaction vertices.

Definition at line 118 of file EventInfo_t.h.

{ return fVertices.size(); }

unsigned int icarus::trigger::details::EventInfo_t::nWeakChargedCurrentInteractions ( ) const

inline

Returns the number of weak charged current interactions in the event.

Definition at line 69 of file EventInfo_t.h.

    { return fInteractions[itWCC]; }

unsigned int icarus::trigger::details::EventInfo_t::nWeakCurrentInteractions ( ) const

inline

Returns the number of weak current interactions in the event.

Definition at line 77 of file EventInfo_t.h.

    {
      return
        nWeakChargedCurrentInteractions() + nWeakNeutralCurrentInteractions();
    }

unsigned int icarus::trigger::details::EventInfo_t::nWeakNeutralCurrentInteractions ( ) const

inline

Returns the number of weak neutral current interactions in the event.

Definition at line 73 of file EventInfo_t.h.

    { return fInteractions[itWNC]; }

void icarus::trigger::details::EventInfo_t::setDep ( )

inlineprivate

Declares that this object has deposited energy information.

Definition at line 297 of file EventInfo_t.h.

{ fHasDepEnergy = true; }

void icarus::trigger::details::EventInfo_t::SetDepositedEnergy ( GeV  e )

inline

Sets the total deposited energy of the event [GeV].

Definition at line 214 of file EventInfo_t.h.

{ setDep(); fEnergyDepTotal = e; }

void icarus::trigger::details::EventInfo_t::SetDepositedEnergyInActiveVolume ( GeV  e )

inline

Sets the total deposited energy of the event in active volume [GeV].

Definition at line 223 of file EventInfo_t.h.

    { setDep(); fEnergyDepActive = e; }

void icarus::trigger::details::EventInfo_t::SetDepositedEnergyInPreSpill ( GeV  e )

inline

Sets the energy of the event deposited during pre-spill window [GeV].

Definition at line 220 of file EventInfo_t.h.

{ setDep(); fEnergyDepPreSpill = e; }

void icarus::trigger::details::EventInfo_t::SetDepositedEnergyInPreSpillInActiveVolume ( GeV  e )

inline

Sets the energy of the event deposited during pre-spill window in active volume [GeV]

Definition at line 233 of file EventInfo_t.h.

    { setDep(); fEnergyDepPreSpillActive = e; }

void icarus::trigger::details::EventInfo_t::SetDepositedEnergyInSpill ( GeV  e )

inline

Sets the energy of the event deposited during beam gate [GeV].

Definition at line 217 of file EventInfo_t.h.

{ setDep(); fEnergyDepSpill = e; }

void icarus::trigger::details::EventInfo_t::SetDepositedEnergyInSpillInActiveVolume ( GeV  e )

inline

Sets the energy of the event deposited during beam gate in active volume [GeV]

Definition at line 228 of file EventInfo_t.h.

    { setDep(); fEnergyDepSpillActive = e; }

void icarus::trigger::details::EventInfo_t::setGen ( )

inlineprivate

Declares that this object has generator information.

Definition at line 294 of file EventInfo_t.h.

{ fHasGenerated = true; }

void icarus::trigger::details::EventInfo_t::SetInActiveVolume ( bool  active = true )

inline

Set whether the event has relevant activity in the active volume.

Definition at line 201 of file EventInfo_t.h.

    { setGen(); fInActiveVolume = active; }

void icarus::trigger::details::EventInfo_t::SetInteractionTime ( simulation_time  time )

inline

Sets the time of the first interaction.

Definition at line 197 of file EventInfo_t.h.

    { setGen(); fInteractionTime = time; }

void icarus::trigger::details::EventInfo_t::SetInteractionType ( int  type )

inline

Sets the interaction type.

Definition at line 194 of file EventInfo_t.h.

{ setGen(); fInteractionType = type; }

void icarus::trigger::details::EventInfo_t::SetLeptonEnergy ( GeV  eL )

inline

Sets the lepton energy.

Definition at line 191 of file EventInfo_t.h.

{ setGen(); fLeptonEnergy = eL; }

void icarus::trigger::details::EventInfo_t::SetNeutrinoEnergy ( GeV  eNu )

inline

Sets the neutrino energy.

Definition at line 188 of file EventInfo_t.h.

{ setGen(); fNeutrinoEnergy = eNu; }

void icarus::trigger::details::EventInfo_t::SetNeutrinoPDG ( int  NU )

inline

Marks the neutrino type of the first interaction in the event.

Definition at line 185 of file EventInfo_t.h.

{ setGen(); fNeutrinoPDG = NU; }

void icarus::trigger::details::EventInfo_t::SetNu_e ( bool  nue )

inline

Definition at line 182 of file EventInfo_t.h.

{ setGen(); nu_e = nue; }

void icarus::trigger::details::EventInfo_t::SetNu_mu ( bool  numu )

inline

Marks the flavor of the neutrino in the first interaction.

Definition at line 181 of file EventInfo_t.h.

{ setGen(); nu_mu = numu; }

std::vector<geo::Point_t> const& icarus::trigger::details::EventInfo_t::Vertices ( ) const

inline

Returns the list of a known interaction vertex.

Definition at line 121 of file EventInfo_t.h.

{ return fVertices; }

Member Data Documentation

GeV icarus::trigger::details::EventInfo_t::fEnergyDepActive { 0.0 }

private

Energy deposited in active volume.

Definition at line 284 of file EventInfo_t.h.

GeV icarus::trigger::details::EventInfo_t::fEnergyDepPreSpill { 0.0 }

private

Energy deposited in pre-spill.

Definition at line 283 of file EventInfo_t.h.

GeV icarus::trigger::details::EventInfo_t::fEnergyDepPreSpillActive { 0.0 }

private

Energy deposited in active volume in pre-spill window.

Definition at line 288 of file EventInfo_t.h.

GeV icarus::trigger::details::EventInfo_t::fEnergyDepSpill { 0.0 }

private

Energy deposited in spill.

Definition at line 282 of file EventInfo_t.h.

GeV icarus::trigger::details::EventInfo_t::fEnergyDepSpillActive { 0.0 }

private

Energy deposited in active volume in spill.

Definition at line 286 of file EventInfo_t.h.

GeV icarus::trigger::details::EventInfo_t::fEnergyDepTotal { 0.0 }

private

Total deposited energy.

Definition at line 281 of file EventInfo_t.h.

bool icarus::trigger::details::EventInfo_t::fHasDepEnergy = false

private

Whether deposited energy info is available.

Definition at line 279 of file EventInfo_t.h.

bool icarus::trigger::details::EventInfo_t::fHasGenerated = false

private

Whether generation information is available.

Definition at line 254 of file EventInfo_t.h.

bool icarus::trigger::details::EventInfo_t::fInActiveVolume { false }

private

Whether the event has activity inside the active volume.

Definition at line 271 of file EventInfo_t.h.

std::array<unsigned int, NInteractionTypes> icarus::trigger::details::EventInfo_t::fInteractions

private

Definition at line 256 of file EventInfo_t.h.

simulation_time icarus::trigger::details::EventInfo_t::fInteractionTime

private

Time of the first interaction [ns].

Definition at line 261 of file EventInfo_t.h.

int icarus::trigger::details::EventInfo_t::fInteractionType { 0 }

private

Definition at line 259 of file EventInfo_t.h.

GeV icarus::trigger::details::EventInfo_t::fLeptonEnergy { 0.0 }

private

Definition at line 264 of file EventInfo_t.h.

GeV icarus::trigger::details::EventInfo_t::fNeutrinoEnergy { 0.0 }

private

Definition at line 263 of file EventInfo_t.h.

int icarus::trigger::details::EventInfo_t::fNeutrinoPDG { 0 }

private

Definition at line 258 of file EventInfo_t.h.

std::vector<geo::Point_t> icarus::trigger::details::EventInfo_t::fVertices

private

Position of all vertices.

Definition at line 273 of file EventInfo_t.h.

constexpr std::size_t icarus::trigger::details::EventInfo_t::itWCC { 0U }

staticprivate

Charged weak current.

Definition at line 246 of file EventInfo_t.h.

constexpr std::size_t icarus::trigger::details::EventInfo_t::itWNC { 1U }

staticprivate

Neutral weak current.

Definition at line 247 of file EventInfo_t.h.

constexpr std::size_t icarus::trigger::details::EventInfo_t::NInteractionTypes { 2U }

staticprivate

Definition at line 248 of file EventInfo_t.h.

bool icarus::trigger::details::EventInfo_t::nu_e { false }

private

Definition at line 268 of file EventInfo_t.h.

bool icarus::trigger::details::EventInfo_t::nu_mu { false }

private

Definition at line 267 of file EventInfo_t.h.

---

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

• EventInfo_t.h
• EventInfo_t.cxx