icarus::trigger::details::EventInfoExtractor Class Reference

Extracts from event the relevant information on the physics event. More...

#include <EventInfoUtils.h>

Classes
struct	CategorizedInputTag
	Utility tag to identify a parameter as a specific type of tag. More...

Public Types
enum	InputType { InputType::EnergyDeposits, InputType::EnergyDepositSummary, InputType::SimChannels, InputType::Unknown }
	Enumerator of possible inputs. More...
using	simulation_time = detinfo::timescales::simulation_time
using	TimeSpan_t = std::pair< simulation_time, simulation_time >
using	SimEnergyDepositSummaryInputTag = CategorizedInputTag< InputType::EnergyDepositSummary >
	Utility tag to identify a parameter as for SimEnergyDepositSummary tag. More...
using	SimChannelsInputTag = CategorizedInputTag< InputType::SimChannels >
	Utility tag to identify a parameter as for sim::SimChannel tag. More...
using	EDepTags_t = std::variant< std::vector< art::InputTag >, SimEnergyDepositSummaryInputTag, SimChannelsInputTag >
	Type to specify the source of energy deposition information, if any. More...

Public Member Functions
bool	hasGenerated () const
	Returns whether we are extracting any generator information. More...
bool	hasEDep () const
	Returns whether we are extracting any energy deposition information. More...
template<typename Event >
auto	extractInfo (Event const &event) const -> EventInfo_t
Constructors
Constructors are available to take advantage of specific art features, and for the generic art/_gallery_ compatible interfaces.
	EventInfoExtractor (std::vector< art::InputTag > truthTags, EDepTags_t edepTags, TimeSpan_t inSpillTimes, TimeSpan_t inPreSpillTimes, geo::GeometryCore const &geom, detinfo::DetectorPropertiesData const *detProps, detinfo::DetectorTimings const *detTimings, std::string logCategory="EventInfoExtractor")
	Constructor: configures the object. More...
template<typename ConsumesColl >
	EventInfoExtractor (std::vector< art::InputTag > truthTags, std::vector< art::InputTag > edepTags, TimeSpan_t inSpillTimes, TimeSpan_t inPreSpillTimes, geo::GeometryCore const &geom, detinfo::DetectorPropertiesData const *detProps, detinfo::DetectorTimings const *detTimings, std::string logCategory, ConsumesColl &consumesCollector)
	Constructor: configures, and declares consuming data product. More...
template<typename Event >
EventInfo_t	extractInfo (Event const &event) const
	Returns an EventInfo_t object with information from event. More...
template<typename Event >
EventInfo_t	operator() (Event const &event) const

Static Public Member Functions
static bool	isEDepSummaryTag (EDepTags_t const &edepTag)
	Returns whether edepTags contains a energy deposition summary tag. More...
static bool	isEDepListTag (EDepTags_t const &edepTag)
	Returns whether edepTags contains energy deposition list tags. More...
static bool	isEDepSpecified (EDepTags_t const &edepTag)
	Returns whether edepTags contains any energy deposition tag. More...

Static Public Attributes
static EDepTags_t const	NoEDepTags {}
	Represents the absence of any energy deposition information. More...

Private Member Functions
bool	useEnergyDepositSummary () const
	Returns whether we use energy summary instead of full energy deposits. More...
void	fillGeneratorInfo (EventInfo_t &info, simb::MCTruth const &truth) const
	Fills info record with generation information from truth. More...
void	fillGeneratorNeutrinoInfo (EventInfo_t &info, simb::MCTruth const &truth) const
	Fills info record with generated neutrino information from truth. More...
void	setMainGeneratorNeutrinoInfo (EventInfo_t &info, simb::MCTruth const &truth) const
void	addGeneratorNeutrinoInfo (EventInfo_t &info, simb::MCTruth const &truth) const
void	addEnergyDepositionInfo (EventInfo_t &info, std::vector< sim::SimEnergyDeposit > const &energyDeposits) const
	Adds the energy depositions from energyDeposits into info record. More...
void	addEnergyDepositionInfo (EventInfo_t &info, std::vector< sim::SimChannel > const &channels) const
	Adds the energy depositions from channels into info record. More...
geo::TPCGeo const *	pointInTPC (geo::Point_t const &point) const
	Returns in which TPC volume point falls in (nullptr if none). More...
geo::TPCGeo const *	pointInActiveTPC (geo::Point_t const &point) const
	Returns in which active TPC volume point falls in (nullptr if none). More...
simulation_time	getInteractionTime (simb::MCTruth const &truth) const

Static Private Member Functions
template<typename ConsumesColl >
static void	declareConsumables (ConsumesColl &consumesCollector, std::vector< art::InputTag > const &truthTags, EDepTags_t const &edepTags)
	Declares all the consumables to the collector. More...

Private Attributes
friend	EventInfoExtractorMaker
std::vector< art::InputTag > const	fGeneratorTags
	List of truth data product tags (std::vector<simb::MCTruth>). More...
EDepTags_t const	fEnergyDepositTags
std::string const	fLogCategory
	Stream name for message facility. More...
geo::GeometryCore const &	fGeom
	Geometry service provider. More...
detinfo::DetectorPropertiesData const *	fDetProps = nullptr
	Detector timing conversion utility. More...
detinfo::DetectorTimings const *	fDetTimings = nullptr
TimeSpan_t const	fInSpillTimes
	Start and stop time for "in spill" label. More...
TimeSpan_t const	fInPreSpillTimes
	Start and stop time for "pre-spill" label. More...

Detailed Description

Extracts from event the relevant information on the physics event.

This returns a EventInfo_t object filled as completely as possible.

The EventInfo_t is managed so that it contains all the information about the "main" neutrino interaction. All other neutrino interactions are acknowledged but their information is not stored, with minor exceptions. Currently:

• the main interaction is the interaction happening the earliest;
• the other interactions have only their location (Vertices()) stored in the list; the order of the vertices in the list stays the same as the order they are filled, with the exception of the main interaction that is always moved in front() of the list. This means that interaction vertices are not ordered by time unless that is how they were fed to this object.

This class can read any data product in the event, and is completely configured at construction time via constructor arguments. If information is needed from a data product that is not read yet, the following actions are needed:

1. decide the input tag of the data product(s) to be read; this is usually delegated to the user via a configuration parameter;
2. the required input tags need to be stored into data members;
3. art needs to be informed of the intention of reading the data products via consumes() or equivalent calls; this class can take care of that, if a art::ConsumesCollector object is provided;
4. the data product can be read with the usual means.

Energy deposition

The energy deposition information is event-wide and does not select depositions from any specific interaction.

The energy depositions are grouped according to whether they are within the time interval of the beam spill window, a pre-spill window, or at any time; and whether they are in the active volume or anywhere. The depositions can be collected from a sim::SimEnergyDeposit list of data products or (not recommended) from a single sim::SimChannel data product. In the latter case, the depositions are extracted from the channels on the first interaction plane (always plane 0 according to LArSoft definitions), which is usually the largest of the planes.

Definition at line 99 of file EventInfoUtils.h.

Member Typedef Documentation

using icarus::trigger::details::EventInfoExtractor::EDepTags_t = std::variant< std::vector<art::InputTag>, SimEnergyDepositSummaryInputTag, SimChannelsInputTag >

Type to specify the source of energy deposition information, if any.

Definition at line 149 of file EventInfoUtils.h.

using icarus::trigger::details::EventInfoExtractor::SimChannelsInputTag = CategorizedInputTag<InputType::SimChannels>

Utility tag to identify a parameter as for sim::SimChannel tag.

Definition at line 141 of file EventInfoUtils.h.

using icarus::trigger::details::EventInfoExtractor::SimEnergyDepositSummaryInputTag = CategorizedInputTag<InputType::EnergyDepositSummary>

Utility tag to identify a parameter as for SimEnergyDepositSummary tag.

Definition at line 138 of file EventInfoUtils.h.

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

Definition at line 103 of file EventInfoUtils.h.

using icarus::trigger::details::EventInfoExtractor::TimeSpan_t = std::pair<simulation_time, simulation_time>

Definition at line 104 of file EventInfoUtils.h.

Member Enumeration Documentation

enum icarus::trigger::details::EventInfoExtractor::InputType

strong

Enumerator of possible inputs.

Enumerator
EnergyDeposits
EnergyDepositSummary
SimChannels
Unknown

Definition at line 107 of file EventInfoUtils.h.

                       {
    EnergyDeposits,
    EnergyDepositSummary,
    SimChannels,
    Unknown
  }; // InputType

Constructor & Destructor Documentation

icarus::trigger::details::EventInfoExtractor::EventInfoExtractor	(	std::vector< art::InputTag >	truthTags,
		EDepTags_t	edepTags,
		TimeSpan_t	inSpillTimes,
		TimeSpan_t	inPreSpillTimes,
		geo::GeometryCore const &	geom,
		detinfo::DetectorPropertiesData const *	detProps,
		detinfo::DetectorTimings const *	detTimings,
		std::string	logCategory = "EventInfoExtractor"
	)

Constructor: configures the object.

Parameters

truthTags	list of truth information data products to be read
edepTags	list of energy deposition data products to be read
inSpillTimes	start and end of spill, in simulation time
inPreSpillTimes	start and end of pre-spill, in simulation time
geom	LArSoft geometry service provider
detTimingsPtr	pointer to LArSoft detector timings utility
logCategory	name of message facility stream to sent messages to

See Also

EventInfoExtractor(std::vector<art::InputTag> const&, ConsumesColl&)

In art framework context, prefer the EventInfoExtractor(std::vector<art::InputTag> const&, ConsumesColl&) constructor.

Two formats of energy depositions are supported:

• standard LArSoft (std::vector<sim::SimEnergyDeposit>): specify a vector of input tags in edepTags argument;
• ICARUS deposited energy summary: specify an input tag converted into a SimEnergyDepositSummaryInputTag parameter in edepTags argument.

Definition at line 97 of file EventInfoUtils.cxx.

  : fGeneratorTags(std::move(truthTags))
  , fEnergyDepositTags(std::move(edepTags))
  , fLogCategory(std::move(logCategory))
  , fGeom(geom)
  , fDetProps(detProps)
  , fDetTimings(detTimings)
  , fInSpillTimes(std::move(inSpillTimes))
  , fInPreSpillTimes(std::move(inPreSpillTimes))
{
} // icarus::trigger::details::EventInfoExtractor::EventInfoExtractor()

template<typename ConsumesColl >

icarus::trigger::details::EventInfoExtractor::EventInfoExtractor	(	std::vector< art::InputTag >	truthTags,
		std::vector< art::InputTag >	edepTags,
		TimeSpan_t	inSpillTimes,
		TimeSpan_t	inPreSpillTimes,
		geo::GeometryCore const &	geom,
		detinfo::DetectorPropertiesData const *	detProps,
		detinfo::DetectorTimings const *	detTimings,
		std::string	logCategory,
		ConsumesColl &	consumesCollector
	)

Constructor: configures, and declares consuming data product.

Template Parameters

ConsumesColl

type with art::ConsumesCollector interface

Parameters

truthTags	list of truth information data products to be read
edepTags	list of energy deposition data products to be read
inSpillTimes	start and end of spill, in simulation time
inPreSpillTimes	start and end of pre-spill, in simulation time
geom	LArSoft geometry service provider
detTimings	LArSoft detector timings utility
logCategory	name of message facility stream to sent messages to
consumesCollector	object to declare the consumed products to

Typical usage is within a art module constructor:

icarus::trigger::details::EventInfoExtractor const eventInfoFrom {
  { art:InputTag{ "generator" } },
  consumesCollector()
  };

Definition at line 458 of file EventInfoUtils.h.

  : EventInfoExtractor{
      std::move(truthTags), std::move(edepTags),
      inSpillTimes, inPreSpillTimes,
      geom, detProps, detTimings, std::move(logCategory)
    }
{
  declareConsumables(consumesCollector, fGeneratorTags, fEnergyDepositTags);
} // icarus::trigger::details::EventInfoExtractor::EventInfoExtractor(coll)

Member Function Documentation

void icarus::trigger::details::EventInfoExtractor::addEnergyDepositionInfo ( EventInfo_t &  info, std::vector< sim::SimEnergyDeposit > const &  energyDeposits  ) const

private

Adds the energy depositions from energyDeposits into info record.

Definition at line 229 of file EventInfoUtils.cxx.

{
  using MeV = util::quantities::megaelectronvolt;
  
  auto Eacc = EnergyAccumulator(fInSpillTimes, fInPreSpillTimes, fGeom);
  
  for (sim::SimEnergyDeposit const& edep: energyDeposits) {
    
    Eacc.add(
        MeV{ edep.Energy() } // assuming it's stored in MeV
      , detinfo::timescales::simulation_time{ edep.Time() }
      , edep.MidPoint()
      );
    
  } // for all energy deposits in the data product
  
  info.SetDepositedEnergy
    (info.DepositedEnergy() + Eacc.totalEnergy);
  info.SetDepositedEnergyInSpill
    (info.DepositedEnergyInSpill() + Eacc.inSpillEnergy);
  info.SetDepositedEnergyInPreSpill
    (info.DepositedEnergyInPreSpill() + Eacc.inPreSpillEnergy);
  info.SetDepositedEnergyInActiveVolume
    (info.DepositedEnergyInActiveVolume() + Eacc.activeEnergy);
  info.SetDepositedEnergyInSpillInActiveVolume
    (info.DepositedEnergyInSpillInActiveVolume() + Eacc.inSpillActiveEnergy);
  info.SetDepositedEnergyInPreSpillInActiveVolume(
    info.DepositedEnergyInPreSpillInActiveVolume() + Eacc.inPreSpillActiveEnergy
    );
  
} // icarus::trigger::details::EventInfoExtractor::addEnergyDepositionInfo()

void icarus::trigger::details::EventInfoExtractor::addEnergyDepositionInfo ( EventInfo_t &  info, std::vector< sim::SimChannel > const &  channels  ) const

private

Adds the energy depositions from channels into info record.

Definition at line 265 of file EventInfoUtils.cxx.

{
  assert(fDetProps);
  assert(fDetTimings);
  
  using MeV = util::quantities::megaelectronvolt;
  
  auto Eacc = EnergyAccumulator(fInSpillTimes, fInPreSpillTimes, fGeom);
  
  double const driftVel = fDetProps->DriftVelocity(); // cm/us
  
  for (sim::SimChannel const& channel: channels) {
    
    // only channels on any of the first induction planes
    std::vector<geo::WireID> const& wires
      = fGeom.ChannelToWire(channel.Channel());
    if (empty(wires)) continue; // ghost channel or something; move on
    if (wires.front().Plane != 0) continue; // not the first induction plane
    
    geo::PlaneGeo const& plane = fGeom.Plane(wires.front());
    
    for (auto const& [ tdc, IDEs ]: channel.TDCIDEMap()) {
      
      // collection tick: includes also drift time, diffusion and what-not
      detinfo::timescales::electronics_tick const tick { tdc };
      detinfo::timescales::simulation_time const time
         = fDetTimings->toSimulationTime(tick);
      
      for (sim::IDE const& IDE: IDEs) {
        MeV const energy { IDE.energy }; // assuming it's stored in MeV
        geo::Point_t const location { IDE.x, IDE.y, IDE.z };
        
        // tentative estimation of drift length:
        double const d = plane.DistanceFromPlane(location); // cm
        util::quantities::intervals::microseconds const driftTime
          { d / driftVel };
        
        Eacc.add(energy, time - driftTime, location);
      } // all deposits at this time tick
      
    } // all time ticks in this channel
    
  } // for all channels
  
  info.SetDepositedEnergy
    (info.DepositedEnergy() + Eacc.totalEnergy);
  info.SetDepositedEnergyInSpill
    (info.DepositedEnergyInSpill() + Eacc.inSpillEnergy);
  info.SetDepositedEnergyInPreSpill
    (info.DepositedEnergyInPreSpill() + Eacc.inPreSpillEnergy);
  info.SetDepositedEnergyInActiveVolume
    (info.DepositedEnergyInActiveVolume() + Eacc.activeEnergy);
  info.SetDepositedEnergyInSpillInActiveVolume
    (info.DepositedEnergyInSpillInActiveVolume() + Eacc.inSpillActiveEnergy);
  info.SetDepositedEnergyInPreSpillInActiveVolume(
    info.DepositedEnergyInPreSpillInActiveVolume() + Eacc.inPreSpillActiveEnergy
    );
  
} // icarus::trigger::details::EventInfoExtractor::addEnergyDepositionInfo()

void icarus::trigger::details::EventInfoExtractor::addGeneratorNeutrinoInfo ( EventInfo_t &  info, simb::MCTruth const &  truth  ) const

private

Adds selected information from the interaction in truth to info record.

Definition at line 206 of file EventInfoUtils.cxx.

{
  /*
   * The only update to the record so far is the addition of the vertex of the
   * interaction at the end of the current list.
   * No information is overwritten.
   * 
   */
  
  simb::MCParticle const& nu = truth.GetNeutrino().Nu();
  
  // we do not trust the vertex (`GvX()`) of the neutrino particle,
  // since GenieHelper does not translate the vertex
  // of some of the particles from GENIE to detector frame;
  // trajectory is always translated:
  geo::Point_t const vertex { nu.EndX(), nu.EndY(), nu.EndZ() };
  info.AddVertex(vertex);
  
} // icarus::trigger::details::EventInfoExtractor::addGeneratorNeutrinoInfo()

template<typename ConsumesColl >

void icarus::trigger::details::EventInfoExtractor::declareConsumables ( ConsumesColl &  consumesCollector, std::vector< art::InputTag > const &  truthTags, EDepTags_t const &  edepTags  )

staticprivate

Declares all the consumables to the collector.

Definition at line 571 of file EventInfoUtils.h.

  {
  
  for (art::InputTag const& inputTag: truthTags)
    consumesCollector.template consumes<std::vector<simb::MCTruth>>(inputTag);
  
  if (
    auto* summaryTag = std::get_if<SimEnergyDepositSummaryInputTag>(&edepTags);
    summaryTag
  ) {
    
    consumesCollector.template consumes<icarus::SimEnergyDepositSummary>
      (static_cast<art::InputTag const&>(*summaryTag));
    
  }
  else if (
    auto* edepListTag = std::get_if<std::vector<art::InputTag>>(&edepTags);
    edepListTag
  ) {
    // may be empty
    for (art::InputTag const& inputTag: *edepListTag) {
      consumesCollector.template consumes<std::vector<sim::SimEnergyDeposit>>
        (inputTag);
    }
  }
  
} // icarus::trigger::details::EventInfoExtractor::declareConsumables()

template<typename Event >

EventInfo_t icarus::trigger::details::EventInfoExtractor::extractInfo

(

Event const &

event

)

const

Returns an EventInfo_t object with information from event.

Template Parameters

Event

type of event to read data from (art or gallery event)

Parameters

event

event record to read the information from

Returns

a EventInfo_t with information extracted from event

template<typename Event >

auto icarus::trigger::details::EventInfoExtractor::extractInfo

(

Event const &

event

)

const -> EventInfo_t

Definition at line 482 of file EventInfoUtils.h.

{
  
  EventInfo_t info;
  
  //
  // generator information
  //
  for (art::InputTag const& inputTag: fGeneratorTags) {
  
    auto const& truthRecords
      = event.template getProduct<std::vector<simb::MCTruth>>(inputTag);
    
    for (simb::MCTruth const& truth: truthRecords) {
      
      fillGeneratorInfo(info, truth);
      
    } // for truth records
    
  } // for generators
  
  //
  // propagation in the detector
  //
  if (auto* summaryTag
      = std::get_if<SimEnergyDepositSummaryInputTag>(&fEnergyDepositTags)
  ) {
    
    using GeV = util::quantities::gigaelectronvolt;
    
    auto const& energyDeposits = event
      .template getProduct<icarus::SimEnergyDepositSummary>(summaryTag->tag());
    
    info.SetDepositedEnergy                        (GeV(energyDeposits.Total));
    info.SetDepositedEnergyInSpill                 (GeV(energyDeposits.Spill));
    info.SetDepositedEnergyInPreSpill              (GeV(energyDeposits.PreSpill));
    info.SetDepositedEnergyInActiveVolume          (GeV(energyDeposits.Active));
    info.SetDepositedEnergyInSpillInActiveVolume   (GeV(energyDeposits.SpillActive));
    info.SetDepositedEnergyInPreSpillInActiveVolume(GeV(energyDeposits.PreSpillActive));
    
  }
  else if
    (auto* channelsTag = std::get_if<SimChannelsInputTag>(&fEnergyDepositTags))
  {
    
    auto const& channels
      = event.template getProduct<std::vector<sim::SimChannel>>
        (channelsTag->tag())
      ;
    mf::LogTrace(fLogCategory)
      << "Event " << event.id() << " has " << channels.size()
      << " energy deposits recorded in '" << channelsTag->tag().encode() << "'";
    
    addEnergyDepositionInfo(info, channels);
    
  }
  else if (
    auto* edepListTag
      = std::get_if<std::vector<art::InputTag>>(&fEnergyDepositTags)
  ) {
    
    for (art::InputTag const& edepTag: *edepListTag) {
      
      auto const& energyDeposits
        = event.template getProduct<std::vector<sim::SimEnergyDeposit>>(edepTag);
      mf::LogTrace(fLogCategory)
        << "Event " << event.id() << " has " << energyDeposits.size()
        << " energy deposits recorded in '" << edepTag.encode() << "'";
      
      addEnergyDepositionInfo(info, energyDeposits);
      
    } // for all energy deposit tags
    
  }
  else {
    throw std::logic_error(
      "icarus::trigger::details::EventInfoExtractor::EventInfoExtractor(): "
      "unexpected type from EDepTags_t"
      );
  }
  
  mf::LogTrace(fLogCategory) << "Event " << event.id() << ": " << info;
  
  return info;
} // icarus::trigger::details::EventInfoExtractor::extractInfo()

void icarus::trigger::details::EventInfoExtractor::fillGeneratorInfo ( EventInfo_t &  info, simb::MCTruth const &  truth  ) const

private

Fills info record with generation information from truth.

Definition at line 121 of file EventInfoUtils.cxx.

{
  
  if (truth.NeutrinoSet()) fillGeneratorNeutrinoInfo(info, truth);
  
} // icarus::trigger::details::EventInfoExtractor::fillGeneratorInfo()

void icarus::trigger::details::EventInfoExtractor::fillGeneratorNeutrinoInfo ( EventInfo_t &  info, simb::MCTruth const &  truth  ) const

private

Fills info record with generated neutrino information from truth.

If info record already contains an interaction (the "main" interaction), the interaction in truth becomes the new main interaction of info only if it is earlier than the old main interaction. Otherwise the record is updated to take note that there was yet another interaction in the event, with little-to-no information about it stored.

Definition at line 131 of file EventInfoUtils.cxx.

{
  if (!truth.NeutrinoSet()) return;
  
  simulation_time const interactionTime = getInteractionTime(truth);
  
  if ((info.nVertices() == 0) || (interactionTime < info.InteractionTime()))
    setMainGeneratorNeutrinoInfo(info, truth);
  else
    addGeneratorNeutrinoInfo(info, truth);
  
} // icarus::trigger::details::EventInfoExtractor::fillGeneratorNeutrinoInfo()

auto icarus::trigger::details::EventInfoExtractor::getInteractionTime ( simb::MCTruth const &  truth ) const

private

Returns the time of the neutrino interaction in truth.

Undefined behaviour if the truth information does not describe a neutrino interaction.

Definition at line 345 of file EventInfoUtils.cxx.

{
  assert(truth.NeutrinoSet());
  simb::MCParticle const& nu = truth.GetNeutrino().Nu();
  return simulation_time{ nu.EndT() };
} // icarus::trigger::details::EventInfoExtractor::getInteractionTime()

bool icarus::trigger::details::EventInfoExtractor::hasEDep ( ) const

inline

Returns whether we are extracting any energy deposition information.

Definition at line 249 of file EventInfoUtils.h.

{ return isEDepSpecified(fEnergyDepositTags); }

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

inline

Returns whether we are extracting any generator information.

Definition at line 246 of file EventInfoUtils.h.

{ return !fGeneratorTags.empty(); }

bool icarus::trigger::details::EventInfoExtractor::isEDepListTag ( EDepTags_t const &  edepTag )

static

Returns whether edepTags contains energy deposition list tags.

Definition at line 440 of file EventInfoUtils.h.

{
  auto const* edeplist = std::get_if<std::vector<art::InputTag>>(&edepTag);
  return edeplist && !edeplist->empty();
} // icarus::trigger::details::EventInfoExtractor::isEDepListTag()

static bool icarus::trigger::details::EventInfoExtractor::isEDepSpecified ( EDepTags_t const &  edepTag )

inlinestatic

Returns whether edepTags contains any energy deposition tag.

Definition at line 263 of file EventInfoUtils.h.

    { return edepTag != NoEDepTags; }

bool icarus::trigger::details::EventInfoExtractor::isEDepSummaryTag ( EDepTags_t const &  edepTag )

static

Returns whether edepTags contains a energy deposition summary tag.

Definition at line 434 of file EventInfoUtils.h.

  { return std::holds_alternative<SimEnergyDepositSummaryInputTag>(edepTag); }

template<typename Event >

EventInfo_t icarus::trigger::details::EventInfoExtractor::operator() ( Event const &  event ) const

inline

Definition at line 240 of file EventInfoUtils.h.

    { return extractInfo(event); }

geo::TPCGeo const * icarus::trigger::details::EventInfoExtractor::pointInActiveTPC ( geo::Point_t const &  point ) const

private

Returns in which active TPC volume point falls in (nullptr if none).

Definition at line 337 of file EventInfoUtils.cxx.

{
  return ::pointInActiveTPC(fGeom, point);
} // icarus::trigger::TriggerEfficiencyPlotsBase::pointInActiveTPC()

geo::TPCGeo const * icarus::trigger::details::EventInfoExtractor::pointInTPC ( geo::Point_t const &  point ) const

private

Returns in which TPC volume point falls in (nullptr if none).

Definition at line 328 of file EventInfoUtils.cxx.

{
  return fGeom.PositionToTPCptr(point);
} // icarus::trigger::TriggerEfficiencyPlotsBase::pointInTPC()

void icarus::trigger::details::EventInfoExtractor::setMainGeneratorNeutrinoInfo ( EventInfo_t &  info, simb::MCTruth const &  truth  ) const

private

Extracts information from truth and sets it as the "main" interaction information. Previous information is typically overwritten.

Definition at line 147 of file EventInfoUtils.cxx.

{
  /*
   * Sets the full information of the event, overwriting everything.
   * 
   * Except that the vertex is just inserted into the vertex list, as the
   * first entry.
   */
  
  using GeV = util::quantities::gigaelectronvolt;
  
  //
  // interaction flavor (nu_mu, nu_e)
  // interaction type (CC, NC)
  //

  simb::MCParticle const& nu = truth.GetNeutrino().Nu();
  info.SetNeutrinoPDG(nu.PdgCode());
  info.SetInteractionType(truth.GetNeutrino().InteractionType());
  info.SetInteractionTime(getInteractionTime(truth));

  info.SetNeutrinoEnergy(GeV{ nu.E() });
  info.SetLeptonEnergy(GeV{ truth.GetNeutrino().Lepton().E() });
  //info.SetNucleonEnergy(truth.GetNeutrino().HitNuc().E());

  switch (nu.PdgCode()) {
    case 14:
    case -14:
      info.SetNu_mu(true);
      break;
    case 12:
    case -12:
      info.SetNu_e(true);
      break;
  }

  switch (truth.GetNeutrino().CCNC()) {
    case simb::kCC: info.AddWeakChargedCurrentInteractions(); break;
    case simb::kNC: info.AddWeakNeutralCurrentInteractions(); break;
    default:
      mf::LogWarning(fLogCategory)
        << "Unexpected NC/CC flag (" << truth.GetNeutrino().CCNC() << ")";
  } // switch   
  
  // we do not trust the vertex (`GvX()`) of the neutrino particle,
  // since GenieHelper does not translate the vertex
  // of some of the particles from GENIE to detector frame;
  // trajectory is always translated:
  geo::Point_t const vertex { nu.EndX(), nu.EndY(), nu.EndZ() };
  info.InsertVertex(vertex, 0U);
  
  geo::TPCGeo const* tpc = pointInActiveTPC(vertex);
  if (tpc) info.SetInActiveVolume();
  
} // icarus::trigger::details::EventInfoExtractor::setMainGeneratorNeutrinoInfo()

bool icarus::trigger::details::EventInfoExtractor::useEnergyDepositSummary ( ) const

inlineprivate

Returns whether we use energy summary instead of full energy deposits.

Definition at line 303 of file EventInfoUtils.h.

    { return isEDepSummaryTag(fEnergyDepositTags); }

Member Data Documentation

friend icarus::trigger::details::EventInfoExtractor::EventInfoExtractorMaker

private

Definition at line 269 of file EventInfoUtils.h.

detinfo::DetectorPropertiesData const* icarus::trigger::details::EventInfoExtractor::fDetProps = nullptr

private

Detector timing conversion utility.

Definition at line 290 of file EventInfoUtils.h.

detinfo::DetectorTimings const* icarus::trigger::details::EventInfoExtractor::fDetTimings = nullptr

private

Definition at line 293 of file EventInfoUtils.h.

EDepTags_t const icarus::trigger::details::EventInfoExtractor::fEnergyDepositTags

private

List of energy deposition product tags (std::vector<sim::SimEnergyDeposit>) or their summary.

Definition at line 278 of file EventInfoUtils.h.

std::vector<art::InputTag> const icarus::trigger::details::EventInfoExtractor::fGeneratorTags

private

List of truth data product tags (std::vector<simb::MCTruth>).

Definition at line 274 of file EventInfoUtils.h.

geo::GeometryCore const& icarus::trigger::details::EventInfoExtractor::fGeom

private

Geometry service provider.

Detector properties information.

Definition at line 287 of file EventInfoUtils.h.

TimeSpan_t const icarus::trigger::details::EventInfoExtractor::fInPreSpillTimes

private

Start and stop time for "pre-spill" label.

Definition at line 298 of file EventInfoUtils.h.

TimeSpan_t const icarus::trigger::details::EventInfoExtractor::fInSpillTimes

private

Start and stop time for "in spill" label.

Definition at line 295 of file EventInfoUtils.h.

std::string const icarus::trigger::details::EventInfoExtractor::fLogCategory

private

Stream name for message facility.

Definition at line 280 of file EventInfoUtils.h.

icarus::trigger::details::EventInfoExtractor::EDepTags_t const icarus::trigger::details::EventInfoExtractor::NoEDepTags {}

inlinestatic

Represents the absence of any energy deposition information.

Definition at line 254 of file EventInfoUtils.h.

---

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

• EventInfoUtils.h
• EventInfoUtils.cxx