Inheritance diagram for sim::DumpGTruth:

Classes
struct	Config
	Collection of configuration parameters for the module. More...

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >
	Type to enable module parameters description by art. More...

using	Parameters = art::EDAnalyzer::Table< Config >
	Type to enable module parameters description by art. More...

Public Types inherited from art::EDAnalyzer
using	WorkerType = WorkerT< EDAnalyzer >

using	ModuleType = EDAnalyzer

Public Member Functions
	DumpGTruth (Parameters const &config)
	Configuration-checking constructor. More...

	DumpGTruth (DumpGTruth const &)=delete

	DumpGTruth (DumpGTruth &&)=delete

DumpGTruth &	operator= (DumpGTruth const &)=delete

DumpGTruth &	operator= (DumpGTruth &&)=delete

virtual void	analyze (art::Event const &event) override

	DumpGTruth (Parameters const &config)
	Configuration-checking constructor. More...

	DumpGTruth (DumpGTruth const &)=delete

	DumpGTruth (DumpGTruth &&)=delete

DumpGTruth &	operator= (DumpGTruth const &)=delete

DumpGTruth &	operator= (DumpGTruth &&)=delete

virtual void	analyze (art::Event const &event) override

Public Member Functions inherited from art::EDAnalyzer
	EDAnalyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDAnalyzer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Analyzer
virtual	~Analyzer () noexcept

	Analyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	Analyzer (Table< Config > const &config)

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

Public Member Functions inherited from art::Observer
	~Observer () noexcept

	Observer (Observer const &)=delete

	Observer (Observer &&)=delete

Observer &	operator= (Observer const &)=delete

Observer &	operator= (Observer &&)=delete

void	registerProducts (ProductDescriptions &, ModuleDescription const &)

void	fillDescriptions (ModuleDescription const &)

fhicl::ParameterSetID	selectorConfig () const

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Static Public Member Functions
template<typename Handle >
static std::string	productName (Handle const &handle)
	Returns the name of the product in the form `"module_instance_process"`. More...

template<typename Handle >
static std::string	productName (Handle const &handle)
	Returns the name of the product in the form `"module_instance_process"`. More...

Private Attributes
std::vector< art::InputTag >	fInputTruth
	Name of `GTruth` data products. More...

std::string	fOutputCategory
	Name of the stream for output. More...

bool	bAllTruth = false
	Whether to process all `GTruth` collections. More...

bool	bAllowNoTruth = false
	Whether to forgive when no truth is present. More...

Additional Inherited Members
Protected Member Functions inherited from art::Observer
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

	Observer (fhicl::ParameterSet const &config)

	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)

Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

Definition at line 39 of file DumpGTruth_module.cc.

Member Typedef Documentation

using sim::DumpGTruth::Parameters = art::EDAnalyzer::Table<Config>

Type to enable module parameters description by art.

Definition at line 67 of file DumpGTruth_module.cc.

using sim::DumpGTruth::Parameters = art::EDAnalyzer::Table<Config>

Type to enable module parameters description by art.

Definition at line 68 of file DumpGTruth_module.cc.

Constructor & Destructor Documentation

sim::DumpGTruth::DumpGTruth ( Parameters const & config )

explicit

Configuration-checking constructor.

Definition at line 101 of file DumpGTruth_module.cc.

   : EDAnalyzer(config)
   , fInputTruth()
   , fOutputCategory(config().OutputCategory())
   , bAllTruth(!config().InputTruth(fInputTruth)) // true if InputTruth omitted
   , bAllowNoTruth(config().AllowNoTruth())
 {
   if (!bAllTruth && bAllowNoTruth) {
     throw art::Exception(art::errors::Configuration)
       << "'AllowNoTruth' is only allowed if no 'InputTruth' is specified.\n";
   }
 }

sim::DumpGTruth::DumpGTruth ( DumpGTruth const & )

delete

sim::DumpGTruth::DumpGTruth ( DumpGTruth && )

delete

sim::DumpGTruth::DumpGTruth ( Parameters const & config )

explicit

Configuration-checking constructor.

sim::DumpGTruth::DumpGTruth ( DumpGTruth const & )

delete

sim::DumpGTruth::DumpGTruth ( DumpGTruth && )

delete

Member Function Documentation

virtual void sim::DumpGTruth::analyze ( art::Event const & event )

overridevirtual

Implements art::EDAnalyzer.

void sim::DumpGTruth::analyze ( art::Event const & event )

overridevirtual

Implements art::EDAnalyzer.

Definition at line 116 of file DumpGTruth_module.cc.

                                                  {
   
   //
   // prepare the data products to be dumped
   //
   struct ProductInfo_t {
     using Thruths_t = std::vector<simb::GTruth>;
     Thruths_t const* truths;
     std::string name;
     
     ProductInfo_t(art::Handle<Thruths_t> const& handle)
       : truths(handle.provenance()->isPresent()? handle.product(): nullptr)
       , name(sim::DumpGTruth::productName(handle))
       {}
     ProductInfo_t(art::ValidHandle<Thruths_t> const& handle)
       : truths(handle.product()), name(sim::DumpGTruth::productName(handle))
       {}
     
   }; // ProductInfo_t
   
   std::vector<ProductInfo_t> AllTruths;
   if (bAllTruth) {
     auto handles = event.getMany<std::vector<simb::GTruth> >();
     std::copy(handles.begin(), handles.end(), std::back_inserter(AllTruths));
   }
   else {
     for (auto const& inputTag: fInputTruth) {
       AllTruths.emplace_back
         (event.getValidHandle<std::vector<simb::GTruth>>(inputTag));
     } // for
   }
   
   //
   // sanity check
   //
   if (AllTruths.empty() && !bAllowNoTruth) {
     throw art::Exception(art::errors::ProductNotFound)
       << "No GENIE truth found to be dumped!\n";
   }
   
   //
   // print an introduction
   //
   unsigned int const nTruths = std::accumulate(
     AllTruths.begin(), AllTruths.end(), 0U,
     [](unsigned int total, auto const& info)
       { return total + (info.truths? info.truths->size(): 0); }
     );
   
   if (bAllTruth) {
     mf::LogVerbatim(fOutputCategory) << "Event " << event.id()
       << " contains " << nTruths << " GENIE truth blocks in "
       << AllTruths.size() << " collections";
   }
   else if (AllTruths.size() == 1) {
     mf::LogVerbatim(fOutputCategory) << "Event " << event.id();
   }
   else {
     mf::LogVerbatim(fOutputCategory) << "Dumping " << nTruths
       << " GENIE truth blocks from " << AllTruths.size()
       << " collections in event " << event.id();
   }
   
   //
   // dump data product by data product
   //
   for (ProductInfo_t const& truths_info: AllTruths) {
     
     auto const* truths = truths_info.truths;
     std::string productName = truths_info.name;
     
     if (!truths) {
       mf::LogVerbatim(fOutputCategory)
         << "Data product '" << productName
         << "' has been dropped. No information available.";
     }
     
     if (AllTruths.size() > 1) {
       mf::LogVerbatim(fOutputCategory)
         << "Data product '" << productName
         << "' contains " << truths->size() << " truth blocks:";
     }
     else if (truths->size() > 1) {
       mf::LogVerbatim(fOutputCategory)
         << truths->size() << " truth blocks:";
     }
     
     //
     // dump each GENIE truth in the data product
     //
     unsigned int iTruth = 0;
     for (auto const& truth: *truths) {
       
       mf::LogVerbatim log (fOutputCategory);
       
       if (truths->size() > 1) log << "(#" << iTruth << ") ";
       sim::dump::DumpGTruth(log, truth, "  ", "");
       
       //
       // update counters
       //
       ++iTruth;
       
     } // for each truth in data product
     
   } // for truth data products
   
   //
   // all done
   //
   
 } // sim::DumpGTruth::analyze()

DumpGTruth& sim::DumpGTruth::operator= ( DumpGTruth const & )

delete

DumpGTruth& sim::DumpGTruth::operator= ( DumpGTruth const & )

delete

DumpGTruth& sim::DumpGTruth::operator= ( DumpGTruth && )

delete

DumpGTruth& sim::DumpGTruth::operator= ( DumpGTruth && )

delete

template<typename Handle >

static std::string sim::DumpGTruth::productName ( Handle const & handle )

static

Returns the name of the product in the form "module_instance_process".

template<typename Handle >

std::string sim::DumpGTruth::productName ( Handle const & handle )

static

Returns the name of the product in the form "module_instance_process".

Definition at line 232 of file DumpGTruth_module.cc.

                                                          {
   auto const* prov = handle.provenance();
   return prov->moduleLabel()
     + '_' + prov->productInstanceName()
     + '_' + prov->processName()
     ;
 } // sim::DumpGTruth::productName()

Member Data Documentation

bool sim::DumpGTruth::bAllowNoTruth = false

private

Whether to forgive when no truth is present.

Definition at line 93 of file DumpGTruth_module.cc.

bool sim::DumpGTruth::bAllTruth = false

private

Whether to process all GTruth collections.

Definition at line 92 of file DumpGTruth_module.cc.

std::vector< art::InputTag > sim::DumpGTruth::fInputTruth

private

Name of GTruth data products.

Definition at line 90 of file DumpGTruth_module.cc.

std::string sim::DumpGTruth::fOutputCategory

private

Name of the stream for output.

Definition at line 91 of file DumpGTruth_module.cc.

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

garsoft/Utilities/Dumpers/DumpGTruth_module.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation