#include "LArPandora.h"

Inheritance diagram for lar_pandora::LArPandora:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

Public Member Functions
	LArPandora (fhicl::ParameterSet const &pset)
	Constructor. More...

void	beginJob ()

void	produce (art::Event &evt)

template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const

template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const

bool	modifiesEvent () const

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

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

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

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

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

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

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

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

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

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
virtual void	CreatePandoraInstances ()=0
	Create pandora instances. More...

virtual void	ConfigurePandoraInstances ()=0
	Configure pandora instances. More...

virtual void	DeletePandoraInstances ()=0
	Delete pandora instances. More...

virtual void	RunPandoraInstances ()=0
	Run all associated pandora instances. More...

virtual void	ResetPandoraInstances ()=0
	Reset all associated pandora instances. More...

CurrentProcessingContext const *	currentContext () const

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

Protected Attributes
std::string	m_configFile
	The config file. More...

bool	m_shouldRunAllHitsCosmicReco
	Steering: whether to run all hits cosmic-ray reconstruction. More...

bool	m_shouldRunStitching
	Steering: whether to stitch cosmic-ray muons crossing between volumes. More...

bool	m_shouldRunCosmicHitRemoval
	Steering: whether to remove hits from tagged cosmic-rays. More...

bool	m_shouldRunSlicing
	Steering: whether to slice events into separate regions for processing. More...

bool	m_shouldRunNeutrinoRecoOption
	Steering: whether to run neutrino reconstruction for each slice. More...

bool	m_shouldRunCosmicRecoOption
	Steering: whether to run cosmic-ray reconstruction for each slice. More...

bool	m_shouldPerformSliceId
	Steering: whether to identify slices and select most appropriate pfos. More...

bool	m_shouldProduceAllOutcomes
	Steering: whether to produce all reconstruction outcomes. More...

bool	m_printOverallRecoStatus
	Steering: whether to print current operation status messages. More...

const pandora::Pandora *	m_pPrimaryPandora
	The address of the primary pandora instance. More...

Private Member Functions
void	CreatePandoraInput (art::Event &evt, IdToHitMap &idToHitMap)
	Create pandora input hits, mc particles etc. More...

void	ProcessPandoraOutput (art::Event &evt, const IdToHitMap &idToHitMap)
	Process pandora output particle flow objects. More...

Private Attributes
std::string	m_generatorModuleLabel
	The generator module label. More...

std::string	m_geantModuleLabel
	The geant module label. More...

std::string	m_simChannelModuleLabel
	The SimChannel producer module label. More...

std::string	m_hitfinderModuleLabel
	The hit finder module label. More...

std::string	m_backtrackerModuleLabel
	The back tracker module label. More...

std::string	m_allOutcomesInstanceLabel
	The instance label for all outcomes. More...

bool	m_enableProduction
	Whether to persist output products. More...

bool	m_enableDetectorGaps
	Whether to pass detector gap information to Pandora instances. More...

bool	m_enableMCParticles
	Whether to pass mc information to Pandora instances to aid development. More...

bool	m_lineGapsCreated
	Book-keeping: whether line gap creation has been called. More...

LArPandoraInput::Settings	m_inputSettings
	The lar pandora input settings. More...

LArPandoraOutput::Settings	m_outputSettings
	The lar pandora output settings. More...

LArDriftVolumeMap	m_driftVolumeMap
	The map from volume id to drift volume. More...

Detailed Description

LArPandora class.

Definition at line 25 of file LArPandora.h.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

lar_pandora::LArPandora::LArPandora ( fhicl::ParameterSet const & pset )

Constructor.

Parameters

pset	the parameter set

Definition at line 45 of file LArPandora.cxx.

                                                     :
     ILArPandora(pset),
     m_configFile(pset.get<std::string>("ConfigFile")),
     m_shouldRunAllHitsCosmicReco(pset.get<bool>("ShouldRunAllHitsCosmicReco")),
     m_shouldRunStitching(pset.get<bool>("ShouldRunStitching")),
     m_shouldRunCosmicHitRemoval(pset.get<bool>("ShouldRunCosmicHitRemoval")),
     m_shouldRunSlicing(pset.get<bool>("ShouldRunSlicing")),
     m_shouldRunNeutrinoRecoOption(pset.get<bool>("ShouldRunNeutrinoRecoOption")),
     m_shouldRunCosmicRecoOption(pset.get<bool>("ShouldRunCosmicRecoOption")),
     m_shouldPerformSliceId(pset.get<bool>("ShouldPerformSliceId")),
     m_shouldProduceAllOutcomes(pset.get<bool>("ProduceAllOutcomes", false)),
     m_printOverallRecoStatus(pset.get<bool>("PrintOverallRecoStatus", false)),
     m_generatorModuleLabel(pset.get<std::string>("GeneratorModuleLabel", "")),
     m_geantModuleLabel(pset.get<std::string>("GeantModuleLabel", "largeant")),
     m_simChannelModuleLabel(pset.get<std::string>("SimChannelModuleLabel", m_geantModuleLabel)),
     m_hitfinderModuleLabel(pset.get<std::string>("HitFinderModuleLabel")),
     m_backtrackerModuleLabel(pset.get<std::string>("BackTrackerModuleLabel","")),
     m_allOutcomesInstanceLabel(pset.get<std::string>("AllOutcomesInstanceLabel", "allOutcomes")),
     m_enableProduction(pset.get<bool>("EnableProduction", true)),
     m_enableDetectorGaps(pset.get<bool>("EnableLineGaps", true)),
     m_enableMCParticles(pset.get<bool>("EnableMCParticles", false)),
     m_lineGapsCreated(false)
 {
     m_inputSettings.m_useHitWidths = pset.get<bool>("UseHitWidths", true);
     m_inputSettings.m_useBirksCorrection = pset.get<bool>("UseBirksCorrection", false);
     m_inputSettings.m_uidOffset = pset.get<int>("UidOffset", 100000000);
     m_inputSettings.m_dx_cm = pset.get<double>("DefaultHitWidth", 0.5);
     m_inputSettings.m_int_cm = pset.get<double>("InteractionLength", 84.);
     m_inputSettings.m_rad_cm = pset.get<double>("RadiationLength", 14.);
     m_inputSettings.m_dEdX_mip = pset.get<double>("dEdXmip", 2.);
     m_inputSettings.m_mips_max = pset.get<double>("MipsMax", 50.);
     m_inputSettings.m_mips_if_negative = pset.get<double>("MipsIfNegative", 0.);
     m_inputSettings.m_mips_to_gev = pset.get<double>("MipsToGeV", 3.5e-4);
     m_inputSettings.m_recombination_factor = pset.get<double>("RecombinationFactor", 0.63);
     m_outputSettings.m_pProducer = this;
     m_outputSettings.m_shouldRunStitching = m_shouldRunStitching;
     m_outputSettings.m_isNeutrinoRecoOnlyNoSlicing = (!m_shouldRunSlicing && m_shouldRunNeutrinoRecoOption && !m_shouldRunCosmicRecoOption);
     m_outputSettings.m_hitfinderModuleLabel = m_hitfinderModuleLabel;
 
     if (m_enableProduction)
     {
         // Set up the instance names to produces
         std::vector<std::string> instanceNames({""});
         if (m_shouldProduceAllOutcomes)
             instanceNames.push_back(m_allOutcomesInstanceLabel);
 
         for (const std::string &instanceName : instanceNames)
         {
             produces< std::vector<recob::PFParticle> >(instanceName);
             produces< std::vector<recob::SpacePoint> >(instanceName);
             produces< std::vector<recob::Cluster> >(instanceName);
             produces< std::vector<recob::Vertex> >(instanceName);
             produces< std::vector<larpandoraobj::PFParticleMetadata> >(instanceName);
             produces< std::vector<recob::Slice> >(instanceName);
 
             produces< art::Assns<recob::PFParticle, larpandoraobj::PFParticleMetadata> >(instanceName);
             produces< art::Assns<recob::PFParticle, recob::SpacePoint> >(instanceName);
             produces< art::Assns<recob::PFParticle, recob::Cluster> >(instanceName);
             produces< art::Assns<recob::PFParticle, recob::Vertex> >(instanceName);
             produces< art::Assns<recob::PFParticle, recob::Slice> >(instanceName);
             produces< art::Assns<recob::SpacePoint, recob::Hit> >(instanceName);
             produces< art::Assns<recob::Cluster, recob::Hit> >(instanceName);
             produces< art::Assns<recob::Slice, recob::Hit> >(instanceName);
 
             if (m_outputSettings.m_shouldRunStitching)
             {
                 produces< std::vector<anab::T0> >(instanceName);
                 produces< art::Assns<recob::PFParticle, anab::T0> >(instanceName);
             }
         }
     }
 }

Member Function Documentation

void lar_pandora::LArPandora::beginJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 120 of file LArPandora.cxx.

References lar_pandora::ILArPandora::ConfigurePandoraInstances(), lar_pandora::LArPandoraInput::CreatePandoraDetectorGaps(), lar_pandora::ILArPandora::CreatePandoraInstances(), lar_pandora::LArPandoraInput::CreatePandoraLArTPCs(), lar_pandora::LArPandoraGeometry::LoadDetectorGaps(), lar_pandora::LArPandoraGeometry::LoadGeometry(), m_driftVolumeMap, m_enableDetectorGaps, m_inputSettings, m_outputSettings, lar_pandora::LArPandoraInput::Settings::m_pPrimaryPandora, lar_pandora::LArPandoraOutput::Settings::m_pPrimaryPandora, and lar_pandora::ILArPandora::m_pPrimaryPandora.

 {
     LArDriftVolumeList driftVolumeList;
     LArPandoraGeometry::LoadGeometry(driftVolumeList, m_driftVolumeMap);
 
     this->CreatePandoraInstances();
 
     if (!m_pPrimaryPandora)
         throw cet::exception("LArPandora") << " LArPandora::beginJob - failed to create primary Pandora instance " << std::endl;
 
     m_inputSettings.m_pPrimaryPandora = m_pPrimaryPandora;
     m_outputSettings.m_pPrimaryPandora = m_pPrimaryPandora;
 
     // Pass basic LArTPC information to pandora instances
     LArPandoraInput::CreatePandoraLArTPCs(m_inputSettings, driftVolumeList);
 
     // If using global drift volume approach, pass details of gaps between daughter volumes to the pandora instance
     if (m_enableDetectorGaps)
     {
         LArDetectorGapList listOfGaps;
         LArPandoraGeometry::LoadDetectorGaps(listOfGaps);
         LArPandoraInput::CreatePandoraDetectorGaps(m_inputSettings, driftVolumeList, listOfGaps);
     }
 
     // Parse Pandora settings xml files
     this->ConfigurePandoraInstances();
 }

virtual void lar_pandora::ILArPandora::ConfigurePandoraInstances ( )

protectedpure virtualinherited

Configure pandora instances.

Implemented in lar_pandora::StandardPandora.

Referenced by beginJob().

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::consumes ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::consumesView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

void lar_pandora::LArPandora::CreatePandoraInput	(	art::Event &	evt,
		IdToHitMap &	idToHitMap
	)

privatevirtual

Create pandora input hits, mc particles etc.

Parameters

evt	the art event
idToHitMap	to receive the populated pandora hit id to art hit map

Implements lar_pandora::ILArPandora.

Definition at line 161 of file LArPandora.cxx.

Referenced by produce().

 {
     // ATTN Should complete gap creation in begin job callback, but channel status service functionality unavailable at that point
     if (!m_lineGapsCreated && m_enableDetectorGaps)
     {
         LArPandoraInput::CreatePandoraReadoutGaps(m_inputSettings, m_driftVolumeMap);
         m_lineGapsCreated = true;
     }
 
     HitVector artHits;
     SimChannelVector artSimChannels;
     HitsToTrackIDEs artHitsToTrackIDEs;
     MCParticleVector artMCParticleVector;
     RawMCParticleVector generatorArtMCParticleVector;
     MCTruthToMCParticles artMCTruthToMCParticles;
     MCParticlesToMCTruth artMCParticlesToMCTruth;
 
     LArPandoraHelper::CollectHits(evt, m_hitfinderModuleLabel, artHits);
 
     if (m_enableMCParticles && !evt.isRealData())
     {
         LArPandoraHelper::CollectMCParticles(evt, m_geantModuleLabel, artMCParticleVector);
 
         if (!m_generatorModuleLabel.empty())
             LArPandoraHelper::CollectGeneratorMCParticles(evt, m_generatorModuleLabel, generatorArtMCParticleVector);
 
         LArPandoraHelper::CollectMCParticles(evt, m_geantModuleLabel, artMCTruthToMCParticles, artMCParticlesToMCTruth);
 
         LArPandoraHelper::CollectSimChannels(evt, m_simChannelModuleLabel, artSimChannels);
         if (!artSimChannels.empty())
         {
             LArPandoraHelper::BuildMCParticleHitMaps(artHits, artSimChannels, artHitsToTrackIDEs);
         }
         else
         {
             if (m_backtrackerModuleLabel.empty())
             {
               throw cet::exception("LArPandora") << "LArPandora::CreatePandoraInput - Can't build MCParticle to Hit map." << std::endl <<
                   "No SimChannels found with label \"" << m_simChannelModuleLabel << "\", and BackTrackerModuleLabel isn't set in FHiCL." << std::endl;
             }
 
             LArPandoraHelper::BuildMCParticleHitMaps(evt, m_hitfinderModuleLabel, m_backtrackerModuleLabel, artHitsToTrackIDEs);
         }
     }
 
     LArPandoraInput::CreatePandoraHits2D(m_inputSettings, m_driftVolumeMap, artHits, idToHitMap);
 
     if (m_enableMCParticles && !evt.isRealData())
     {
         LArPandoraInput::CreatePandoraMCParticles(m_inputSettings, artMCTruthToMCParticles, artMCParticlesToMCTruth, generatorArtMCParticleVector);
         LArPandoraInput::CreatePandoraMCLinks2D(m_inputSettings, idToHitMap, artHitsToTrackIDEs);
     }
 }

virtual void lar_pandora::ILArPandora::CreatePandoraInstances ( )

protectedpure virtualinherited

Create pandora instances.

Implemented in lar_pandora::StandardPandora.

Referenced by beginJob().

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

   {
     return current_context_.get();
   }

virtual void lar_pandora::ILArPandora::DeletePandoraInstances ( )

protectedpure virtualinherited

Delete pandora instances.

Implemented in lar_pandora::StandardPandora.

EngineCreator::seed_t EngineCreator::get_seed_value	(	fhicl::ParameterSet const &	pset,
		char const	key[] = `"seed"`,
		seed_t const	implicit_seed = `-1`
	)

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

template<typename PROD , BranchType B>

ProductID art::EDProducer::getProductID ( std::string const & instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::moduleDescription_.

   {
     return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                                instanceName);
   }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID	(	ModuleDescription const &	moduleDescription,
		std::string const &	instanceName
	)		const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

   {
     auto const& pd =
       get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
     return pd.productID();
   }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::mayConsume ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

     {
       return true;
     }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

void lar_pandora::LArPandora::ProcessPandoraOutput	(	art::Event &	evt,
		const IdToHitMap &	idToHitMap
	)

privatevirtual

Process pandora output particle flow objects.

Parameters

evt	the art event
idToHitMap	the pandora hit id to art hit map

Implements lar_pandora::ILArPandora.

Definition at line 217 of file LArPandora.cxx.

References m_allOutcomesInstanceLabel, lar_pandora::LArPandoraOutput::Settings::m_allOutcomesInstanceLabel, m_enableProduction, m_outputSettings, m_shouldProduceAllOutcomes, lar_pandora::LArPandoraOutput::Settings::m_shouldProduceAllOutcomes, and lar_pandora::LArPandoraOutput::ProduceArtOutput().

Referenced by produce().

 {
     if (m_enableProduction)
     {
         m_outputSettings.m_shouldProduceAllOutcomes = false;
         LArPandoraOutput::ProduceArtOutput(m_outputSettings, idToHitMap, evt);
         
         if (m_shouldProduceAllOutcomes)
         {
             m_outputSettings.m_shouldProduceAllOutcomes = true;
             m_outputSettings.m_allOutcomesInstanceLabel = m_allOutcomesInstanceLabel;
             LArPandoraOutput::ProduceArtOutput(m_outputSettings, idToHitMap, evt);
         }
     }
 }

void lar_pandora::LArPandora::produce ( art::Event & evt )

virtual

Implements art::EDProducer.

Definition at line 150 of file LArPandora.cxx.

References CreatePandoraInput(), ProcessPandoraOutput(), lar_pandora::ILArPandora::ResetPandoraInstances(), and lar_pandora::ILArPandora::RunPandoraInstances().

 {
     IdToHitMap idToHitMap;
     this->CreatePandoraInput(evt, idToHitMap);
     this->RunPandoraInstances();
     this->ProcessPandoraOutput(evt, idToHitMap);
     this->ResetPandoraInstances();
 }

virtual void lar_pandora::ILArPandora::ResetPandoraInstances ( )

protectedpure virtualinherited

Reset all associated pandora instances.

Implemented in lar_pandora::StandardPandora.

Referenced by produce().

virtual void lar_pandora::ILArPandora::RunPandoraInstances ( )

protectedpure virtualinherited

Run all associated pandora instances.

Implemented in lar_pandora::StandardPandora.

Referenced by produce().

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }

Member Data Documentation

std::string lar_pandora::LArPandora::m_allOutcomesInstanceLabel

private

The instance label for all outcomes.

Definition at line 61 of file LArPandora.h.

Referenced by LArPandora(), and ProcessPandoraOutput().

std::string lar_pandora::LArPandora::m_backtrackerModuleLabel

private

The back tracker module label.

Definition at line 59 of file LArPandora.h.

Referenced by CreatePandoraInput().

std::string lar_pandora::LArPandora::m_configFile

protected

The config file.

Definition at line 39 of file LArPandora.h.

Referenced by lar_pandora::StandardPandora::ConfigurePandoraInstances().

LArDriftVolumeMap lar_pandora::LArPandora::m_driftVolumeMap

private

The map from volume id to drift volume.

Definition at line 71 of file LArPandora.h.

Referenced by beginJob(), and CreatePandoraInput().

bool lar_pandora::LArPandora::m_enableDetectorGaps

private

Whether to pass detector gap information to Pandora instances.

Definition at line 64 of file LArPandora.h.

Referenced by beginJob(), and CreatePandoraInput().

bool lar_pandora::LArPandora::m_enableMCParticles

private

Whether to pass mc information to Pandora instances to aid development.

Definition at line 65 of file LArPandora.h.

Referenced by CreatePandoraInput().

bool lar_pandora::LArPandora::m_enableProduction

private

Whether to persist output products.

Definition at line 63 of file LArPandora.h.

Referenced by LArPandora(), and ProcessPandoraOutput().

std::string lar_pandora::LArPandora::m_geantModuleLabel

private

The geant module label.

Definition at line 56 of file LArPandora.h.

Referenced by CreatePandoraInput().

std::string lar_pandora::LArPandora::m_generatorModuleLabel

private

The generator module label.

Definition at line 55 of file LArPandora.h.

Referenced by CreatePandoraInput().

std::string lar_pandora::LArPandora::m_hitfinderModuleLabel

private

The hit finder module label.

Definition at line 58 of file LArPandora.h.

Referenced by CreatePandoraInput(), and LArPandora().

LArPandoraInput::Settings lar_pandora::LArPandora::m_inputSettings

private

The lar pandora input settings.

Definition at line 68 of file LArPandora.h.

Referenced by beginJob(), CreatePandoraInput(), and LArPandora().

bool lar_pandora::LArPandora::m_lineGapsCreated

private

Book-keeping: whether line gap creation has been called.

Definition at line 66 of file LArPandora.h.

Referenced by CreatePandoraInput().

LArPandoraOutput::Settings lar_pandora::LArPandora::m_outputSettings

private

The lar pandora output settings.

Definition at line 69 of file LArPandora.h.

Referenced by beginJob(), LArPandora(), and ProcessPandoraOutput().

const pandora::Pandora* lar_pandora::ILArPandora::m_pPrimaryPandora

protectedinherited

The address of the primary pandora instance.

Definition at line 82 of file ILArPandora.h.

Referenced by beginJob(), lar_pandora::StandardPandora::ConfigurePandoraInstances(), lar_pandora::StandardPandora::CreatePandoraInstances(), lar_pandora::StandardPandora::DeletePandoraInstances(), lar_pandora::StandardPandora::ResetPandoraInstances(), and lar_pandora::StandardPandora::RunPandoraInstances().

bool lar_pandora::LArPandora::m_printOverallRecoStatus

protected

Steering: whether to print current operation status messages.

Definition at line 49 of file LArPandora.h.

Referenced by lar_pandora::StandardPandora::ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldPerformSliceId

protected

Steering: whether to identify slices and select most appropriate pfos.

Definition at line 47 of file LArPandora.h.

Referenced by lar_pandora::StandardPandora::ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldProduceAllOutcomes

protected

Steering: whether to produce all reconstruction outcomes.

Definition at line 48 of file LArPandora.h.

Referenced by LArPandora(), and ProcessPandoraOutput().

bool lar_pandora::LArPandora::m_shouldRunAllHitsCosmicReco

protected

Steering: whether to run all hits cosmic-ray reconstruction.

Definition at line 41 of file LArPandora.h.

Referenced by lar_pandora::StandardPandora::ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldRunCosmicHitRemoval

protected

Steering: whether to remove hits from tagged cosmic-rays.

Definition at line 43 of file LArPandora.h.

Referenced by lar_pandora::StandardPandora::ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldRunCosmicRecoOption

protected

Steering: whether to run cosmic-ray reconstruction for each slice.

Definition at line 46 of file LArPandora.h.

Referenced by LArPandora(), and lar_pandora::StandardPandora::ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldRunNeutrinoRecoOption

protected

Steering: whether to run neutrino reconstruction for each slice.

Definition at line 45 of file LArPandora.h.

Referenced by LArPandora(), and lar_pandora::StandardPandora::ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldRunSlicing

protected

Steering: whether to slice events into separate regions for processing.

Definition at line 44 of file LArPandora.h.

Referenced by LArPandora(), and lar_pandora::StandardPandora::ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldRunStitching

protected

Steering: whether to stitch cosmic-ray muons crossing between volumes.

Definition at line 42 of file LArPandora.h.

Referenced by LArPandora(), and lar_pandora::StandardPandora::ProvideExternalSteeringParameters().

std::string lar_pandora::LArPandora::m_simChannelModuleLabel

private

The SimChannel producer module label.

Definition at line 57 of file LArPandora.h.

Referenced by CreatePandoraInput().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandora/v07_06_01/source/larpandora/LArPandoraInterface/LArPandora.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandora/v07_06_01/source/larpandora/LArPandoraInterface/LArPandora.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation