Produces energy deposition summary data products. More...

Inheritance diagram for icarus::trigger::ExtractEnergyDepositionSummary:

Classes
struct	Config

struct	TimingPack_t

Public Types
using	microseconds = util::quantities::intervals::microseconds

using	Parameters = art::EDProducer::Table< Config >

Public Member Functions
	ExtractEnergyDepositionSummary (Parameters const &config)

virtual void	produce (art::Event &event) override
	Creates the data products. More...

Private Types
using	EDepTags_t = details::EventInfoExtractorMaker::EDepTags_t

Static Private Member Functions
static EDepTags_t	makeEnergyDepSourceTag (fhicl::Sequence< art::InputTag > const &energyDepositTags, fhicl::OptionalAtom< art::InputTag > const &simChannelTag)
	Fills a energy deposition tag object from the specified configuration. More...

Private Attributes
microseconds	fBeamGateDuration
	Duration of the gate during with global optical triggers are accepted. More...

microseconds	fBeamGateStart
	Start of the beam gate with respect to `BeamGate()`. More...

microseconds	fPreSpillWindow
	Duration of the pre-spill gate. More...

microseconds	fPreSpillStart
	Start of the pre-spill gate. More...

std::string const	fLogCategory
	Category name for the console output stream. More...

geo::GeometryCore const &	fGeom
	Access to detector geometry information. More...

std::optional< TimingPack_t >	fDetProps
	All information about detector timings and properties. More...

icarus::ns::util::ThreadSafeChangeMonitor < icarus::trigger::BeamGateStruct >	fBeamGateChangeCheck
	Functor returning whether a gate has changed. More...

details::EventInfoExtractorMaker const	fEventInfoExtractorMaker

Detailed Description

Produces energy deposition summary data products.

The data product produced by this module is an alternative to storing the whole energy deposition, which can be huge.

This module takes its information from sim::SimEnergyDeposits data product in input, simply providing a sum of it within the specified time interval.

Output data products

a single icarus::SimEnergyDepositSummary: sums of energies in a spill time, in a pre-spill time, and total, everywhere and in active volume only.

Input data products

std::vector<sim::SimEnergyDeposits> (multiple supported) or std::vector<sim::SimChannel> to extract the deposited energy from.

Service requirements

The following services are required:

Geometry for the determination of the active volume(s)
DetectorClocksService for the determination of beam gate and for time backtracking if energy deposition information is from sim::SimChannel
DetectorPropertiesService for time backtracking if energy deposition
information is from sim::SimChannel
art message facility

Configuration parameters

A terse description of the parameters is printed by running lar --print-description ExtractEnergyDepositionSummary.

EnergyDepositTags (list of input tags, default: [ "largeant:TPCActive" ]): a list of data products with energy depositions. In alternative, SimChannelTag can be specified instead.
SimChannelTag (input tag): tag of the data product with sim::SimChannels to extract the energy information from. If specified, it overrides EnergyDepositTags and extracts energy information from the sim::SimChannel data product identified by this tag. This option is for flawed input samples only, and EnergyDepositTags is recommended instead.
BeamGateDuration (time, mandatory): the duration of the beam gate; the time requires the unit to be explicitly specified: use "1.6 us" for BNB, 9.5 us for NuMI (also available as BNB_settings.spill_duration and NuMI_settings.spill_duration in trigger_icarus.fcl).
BeamGateStart (time, default: 0 s): open the beam gate this long after the nominal beam gate time.
PreSpillWindow (time, default: 10 s): duration of the pre-spill window.
PreSpillWindowGap (time, default: 0 s): gap from the end of pre-spill window to the start of beam gate.
OutputCategory (string, default: "ExtractEnergyDepositionSummary"): label for the category of messages in the console output; this is the label that can be used for filtering messages via MessageFacility service configuration.

Definition at line 121 of file ExtractEnergyDepositionSummary_module.cc.

Member Typedef Documentation

using icarus::trigger::ExtractEnergyDepositionSummary::EDepTags_t = details::EventInfoExtractorMaker::EDepTags_t

private

Definition at line 195 of file ExtractEnergyDepositionSummary_module.cc.

using icarus::trigger::ExtractEnergyDepositionSummary::microseconds = util::quantities::intervals::microseconds

Definition at line 125 of file ExtractEnergyDepositionSummary_module.cc.

using icarus::trigger::ExtractEnergyDepositionSummary::Parameters = art::EDProducer::Table<Config>

Definition at line 175 of file ExtractEnergyDepositionSummary_module.cc.

Constructor & Destructor Documentation

icarus::trigger::ExtractEnergyDepositionSummary::ExtractEnergyDepositionSummary ( Parameters const & config )

explicit

Definition at line 274 of file ExtractEnergyDepositionSummary_module.cc.

   : art::EDProducer(config)
   // configuration
   , fBeamGateDuration     (config().BeamGateDuration())
   , fBeamGateStart        (config().BeamGateStart())
   , fPreSpillWindow       (config().PreSpillWindow())
   , fPreSpillStart
       (fBeamGateStart - config().PreSpillWindowGap() - fPreSpillWindow)
   , fLogCategory(config().OutputCategory())
   // services
   , fGeom(*(lar::providerFrom<geo::Geometry>()))
   , fDetProps{
       config().SimChannelTag.hasValue()
         ? std::make_optional<TimingPack_t>(
           art::ServiceHandle<detinfo::DetectorClocksService const>()
             ->DataForJob(),
           art::ServiceHandle<detinfo::DetectorPropertiesService const>()
             ->DataForJob()
           )
         : std::nullopt
       }
   // algorithms
   , fEventInfoExtractorMaker(
       {}                                               // truthTags: none

Member Function Documentation

auto icarus::trigger::ExtractEnergyDepositionSummary::makeEnergyDepSourceTag	(	fhicl::Sequence< art::InputTag > const &	energyDepositTags,
		fhicl::OptionalAtom< art::InputTag > const &	simChannelTag
	)

staticprivate

Fills a energy deposition tag object from the specified configuration.

Definition at line 360 of file ExtractEnergyDepositionSummary_module.cc.

 {
   EDepTags_t edepTags;
   
   if (auto const tag = util::fhicl::getOptionalValue(simChannelTag)) {
     edepTags
      = icarus::trigger::details::EventInfoExtractor::SimChannelsInputTag{ *tag }
      ;
   }
   else {
     edepTags = energyDepositTags();
   }
   
   return edepTags;
 } // icarus::trigger::ExtractEnergyDepositionSummary::makeEnergyDepSourceTag()

void icarus::trigger::ExtractEnergyDepositionSummary::produce ( art::Event & event )

overridevirtual

Creates the data products.

Definition at line 312 of file ExtractEnergyDepositionSummary_module.cc.

 {
   
   //
   // prepare the information extractor and extract the information
   //
   
   // we need to convert the two relevant gates with the proper parameters
   auto const detTimings = icarus::ns::util::makeDetTimings(event);
   
   auto const beamGate = icarus::trigger::makeBeamGateStruct
     (detTimings, fBeamGateDuration, fBeamGateStart);
   
   if (auto oldGate = fBeamGateChangeCheck(beamGate); oldGate) {
     mf::LogWarning(fLogCategory)
       << "Beam gate has changed from " << oldGate->asOptTickRange()
       << " to " << beamGate.asOptTickRange() << " (optical tick)!";
   }
   
   details::EventInfo_t const info = fEventInfoExtractorMaker(
     beamGate.asSimulationRange(),
     icarus::trigger::makeBeamGateStruct
       (detTimings, fPreSpillStart, fPreSpillStart + fPreSpillWindow)
       .asSimulationRange()
     )(event);
   assert(info.hasDepEnergy());
   
   //
   // move the information into the data product
   //
   icarus::SimEnergyDepositSummary summary;
   summary.Total          = info.DepositedEnergy().value();
   summary.Spill          = info.DepositedEnergyInSpill().value();
   summary.PreSpill       = info.DepositedEnergyInPreSpill().value();
   summary.Active         = info.DepositedEnergyInActiveVolume().value();
   summary.SpillActive    = info.DepositedEnergyInSpillInActiveVolume().value();
   summary.PreSpillActive = info.DepositedEnergyInPreSpillInActiveVolume().value();
 
   //
   // finish
   //
   event.put
     (std::make_unique<icarus::SimEnergyDepositSummary>(std::move(summary)));
   
 } // icarus::trigger::ExtractEnergyDepositionSummary::produce()