Inheritance diagram for lar_pandora::StandardPandora:

Public Types
using	ModuleType = EDProducer

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

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

	~StandardPandora ()
	Destructor. More...

void	beginJob ()

void	produce (art::Event &evt)

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)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

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

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

Protected 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...

fhicl::ParameterSet	ConstructHitCollectionToolParameterSet (const fhicl::ParameterSet &pset)

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 ()

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...

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_disableRealDataCheck
	Whether to check if the input file contains real data before accessing MC information. More...

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

std::unique_ptr< IHitCollectionTool >	m_collectHitsTool
	art tool used to collect the hits 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...

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

Private Member Functions
void	CreatePandoraInstances ()
	Create pandora instances. More...

void	ConfigurePandoraInstances ()
	Configure pandora instances. More...

void	RunPandoraInstances ()
	Run all associated pandora instances. More...

void	ResetPandoraInstances ()
	Reset all associated pandora instances. More...

void	DeletePandoraInstances ()
	Delete pandora instances. More...

void	ProvideExternalSteeringParameters (const pandora::Pandora *const pPandora) const
	Pass external steering parameters, read from fhicl parameter set, to LArMaster Pandora algorithm. More...

Detailed Description

StandardPandora class.

Definition at line 18 of file StandardPandora_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::detail::Producer::Table = Modifier::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 26 of file Producer.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters

pset	the parameter set

Definition at line 70 of file StandardPandora_module.cc.

70 : LArPandora(pset) {}

lar_pandora::LArPandora::LArPandora

LArPandora(fhicl::ParameterSet const &pset)

Constructor.

Definition: LArPandora.cxx:42

lar_pandora::StandardPandora::~StandardPandora ( )

Destructor.

Definition at line 74 of file StandardPandora_module.cc.

References DeletePandoraInstances().

   {
     this->DeletePandoraInstances();
   }

Member Function Documentation

void lar_pandora::LArPandora::beginJob ( )

virtualinherited

Reimplemented from art::EDProducer.

Definition at line 133 of file LArPandora.cxx.

   {
     LArDriftVolumeList driftVolumeList;
     LArPandoraGeometry::LoadGeometry(
       driftVolumeList, m_driftVolumeMap, m_inputSettings.m_useActiveBoundingBox);
 
     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, m_inputSettings.m_useActiveBoundingBox);
       LArPandoraInput::CreatePandoraDetectorGaps(m_inputSettings, driftVolumeList, listOfGaps);
     }
 
     // Parse Pandora settings xml files
     this->ConfigurePandoraInstances();
   }

void lar_pandora::StandardPandora::ConfigurePandoraInstances ( )

privatevirtual

Configure pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 109 of file StandardPandora_module.cc.

References lar_pandora::LArPandora::m_configFile, lar_pandora::ILArPandora::m_pPrimaryPandora, and ProvideExternalSteeringParameters().

   {
     cet::search_path sp("FW_SEARCH_PATH");
     std::string fullConfigFileName;
 
     if (!sp.find_file(m_configFile, fullConfigFileName))
       throw cet::exception("StandardPandora")
         << " ConfigurePrimaryPandoraInstance - Failed to find xml configuration file "
         << m_configFile << " in FW search path";
 
     this->ProvideExternalSteeringParameters(m_pPrimaryPandora);
     PANDORA_THROW_RESULT_IF(pandora::STATUS_CODE_SUCCESS,
                             !=,
                             PandoraApi::ReadSettings(*m_pPrimaryPandora, fullConfigFileName));
   }

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

protectedinherited

Definition at line 256 of file LArPandora.cxx.

References fhicl::ParameterSet::get(), fhicl::ParameterSet::has_key(), and fhicl::ParameterSet::put().

Referenced by lar_pandora::LArPandora::LArPandora().

   {
     if (pset.has_key("HitCollectionTool")) {
       return pset.get<fhicl::ParameterSet>("HitCollectionTool");
     }
 
     fhicl::ParameterSet psetHitCollection;
     psetHitCollection.put<std::string>("tool_type", "LArPandoraHitCollectionToolDefault");
     return psetHitCollection;
   }

template<typename T , BranchType BT>

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

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

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

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

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

protectedvirtualinherited

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 175 of file LArPandora.cxx.

Referenced by lar_pandora::LArPandora::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;
 
     bool areSimChannelsValid(false);
 
     m_collectHitsTool->CollectHits(evt, m_hitfinderModuleLabel, artHits);
 
     if (m_enableMCParticles && (m_disableRealDataCheck || !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, areSimChannelsValid);
       if (!artSimChannels.empty()) {
         LArPandoraHelper::BuildMCParticleHitMaps(evt, artHits, artSimChannels, artHitsToTrackIDEs);
       }
       else if (!areSimChannelsValid) {
         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);
       }
       else {
         mf::LogDebug("LArPandora")
           << " *** LArPandora::CreatePandoraInput - empty list of sim channels found " << std::endl;
       }
     }
 
     LArPandoraInput::CreatePandoraHits2D(
       evt, m_inputSettings, m_driftVolumeMap, artHits, idToHitMap);
 
     if (m_enableMCParticles && (m_disableRealDataCheck || !evt.isRealData())) {
       LArPandoraInput::CreatePandoraMCParticles(m_inputSettings,
                                                 artMCTruthToMCParticles,
                                                 artMCParticlesToMCTruth,
                                                 generatorArtMCParticleVector);
       LArPandoraInput::CreatePandoraMCLinks2D(m_inputSettings, idToHitMap, artHitsToTrackIDEs);
     }
   }

void lar_pandora::StandardPandora::CreatePandoraInstances ( )

privatevirtual

Create pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 81 of file StandardPandora_module.cc.

References MultiPandoraApi::AddPrimaryPandoraInstance(), lar_pandora::ILArPandora::m_pPrimaryPandora, LArContent::RegisterAlgorithms(), LArDLContent::RegisterAlgorithms(), and LArContent::RegisterBasicPlugins().

   {
     m_pPrimaryPandora = new pandora::Pandora();
     PANDORA_THROW_RESULT_IF(
       pandora::STATUS_CODE_SUCCESS, !=, LArContent::RegisterAlgorithms(*m_pPrimaryPandora));
 #ifdef LIBTORCH_DL
     PANDORA_THROW_RESULT_IF(
       pandora::STATUS_CODE_SUCCESS, !=, LArDLContent::RegisterAlgorithms(*m_pPrimaryPandora));
 #endif
     PANDORA_THROW_RESULT_IF(
       pandora::STATUS_CODE_SUCCESS, !=, LArContent::RegisterBasicPlugins(*m_pPrimaryPandora));
 
     // ATTN Potentially ill defined, unless coordinate system set up to ensure that all drift volumes have same wire angles and pitches
     PANDORA_THROW_RESULT_IF(
       pandora::STATUS_CODE_SUCCESS,
       !=,
       PandoraApi::SetPseudoLayerPlugin(*m_pPrimaryPandora, new lar_content::LArPseudoLayerPlugin));
     PANDORA_THROW_RESULT_IF(
       pandora::STATUS_CODE_SUCCESS,
       !=,
       PandoraApi::SetLArTransformationPlugin(*m_pPrimaryPandora,
                                              new lar_content::LArRotationalTransformationPlugin));
 
     MultiPandoraApi::AddPrimaryPandoraInstance(m_pPrimaryPandora);
   }

void lar_pandora::StandardPandora::DeletePandoraInstances ( )

privatevirtual

Delete pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 143 of file StandardPandora_module.cc.

References MultiPandoraApi::DeletePandoraInstances(), and lar_pandora::ILArPandora::m_pPrimaryPandora.

Referenced by ~StandardPandora().

   {
     MultiPandoraApi::DeletePandoraInstances(m_pPrimaryPandora);
   }

void art::detail::Producer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 22 of file Producer.cc.

References art::detail::Producer::beginJobWithFrame(), and art::detail::Producer::setupQueues().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Producer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 65 of file Producer.cc.

References art::detail::Producer::beginRunWithFrame(), art::RangeSet::forRun(), art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 85 of file Producer.cc.

References art::detail::Producer::beginSubRunWithFrame(), art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

void art::detail::Producer::doEndJob ( )

inherited

Definition at line 30 of file Producer.cc.

References art::detail::Producer::endJobWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Producer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 75 of file Producer.cc.

References art::detail::Producer::endRunWithFrame(), art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 95 of file Producer.cc.

References art::detail::Producer::endSubRunWithFrame(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

bool art::detail::Producer::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
	)

inherited

Definition at line 105 of file Producer.cc.

References art::detail::Producer::checkPutProducts_, e, art::EventPrincipal::makeEvent(), art::detail::Producer::produceWithFrame(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     produceWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     ++counts_passed;
     return true;
   }

void art::detail::Producer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 44 of file Producer.cc.

References art::detail::Producer::respondToCloseInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 58 of file Producer.cc.

References art::detail::Producer::respondToCloseOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 37 of file Producer.cc.

References art::detail::Producer::respondToOpenInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 51 of file Producer.cc.

References art::detail::Producer::respondToOpenOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

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

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

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

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

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

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

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

protectedvirtualinherited

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 240 of file LArPandora.cxx.

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

Referenced by lar_pandora::LArPandora::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 )

virtualinherited

Implements art::EDProducer.

Definition at line 164 of file LArPandora.cxx.

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

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

void lar_pandora::StandardPandora::ProvideExternalSteeringParameters ( const pandora::Pandora *const pPandora ) const

private

Pass external steering parameters, read from fhicl parameter set, to LArMaster Pandora algorithm.

Parameters

pPandora the address of the relevant pandora instance

Definition at line 150 of file StandardPandora_module.cc.

References lar_pandora::LArPandora::m_printOverallRecoStatus, lar_pandora::LArPandora::m_shouldPerformSliceId, lar_pandora::LArPandora::m_shouldRunAllHitsCosmicReco, lar_content::MasterAlgorithm::ExternalSteeringParameters::m_shouldRunAllHitsCosmicReco, lar_pandora::LArPandora::m_shouldRunCosmicHitRemoval, lar_pandora::LArPandora::m_shouldRunCosmicRecoOption, lar_pandora::LArPandora::m_shouldRunNeutrinoRecoOption, lar_pandora::LArPandora::m_shouldRunSlicing, and lar_pandora::LArPandora::m_shouldRunStitching.

Referenced by ConfigurePandoraInstances().

   {
     auto* const pEventSteeringParameters =
       new lar_content::MasterAlgorithm::ExternalSteeringParameters;
     pEventSteeringParameters->m_shouldRunAllHitsCosmicReco = m_shouldRunAllHitsCosmicReco;
     pEventSteeringParameters->m_shouldRunStitching = m_shouldRunStitching;
     pEventSteeringParameters->m_shouldRunCosmicHitRemoval = m_shouldRunCosmicHitRemoval;
     pEventSteeringParameters->m_shouldRunSlicing = m_shouldRunSlicing;
     pEventSteeringParameters->m_shouldRunNeutrinoRecoOption = m_shouldRunNeutrinoRecoOption;
     pEventSteeringParameters->m_shouldRunCosmicRecoOption = m_shouldRunCosmicRecoOption;
     pEventSteeringParameters->m_shouldPerformSliceId = m_shouldPerformSliceId;
     pEventSteeringParameters->m_printOverallRecoStatus = m_printOverallRecoStatus;
     PANDORA_THROW_RESULT_IF(pandora::STATUS_CODE_SUCCESS,
                             !=,
                             pandora::ExternallyConfiguredAlgorithm::SetExternalParameters(
                               *pPandora, "LArMaster", pEventSteeringParameters));
 
 #ifdef LIBTORCH_DL
     auto* const pEventSettingsParametersCopy =
       new lar_content::MasterAlgorithm::ExternalSteeringParameters(*pEventSteeringParameters);
     PANDORA_THROW_RESULT_IF(pandora::STATUS_CODE_SUCCESS,
                             !=,
                             pandora::ExternallyConfiguredAlgorithm::SetExternalParameters(
                               *pPandora, "LArDLMaster", pEventSettingsParametersCopy));
 #endif
   }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

void lar_pandora::StandardPandora::ResetPandoraInstances ( )

privatevirtual

Reset all associated pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 135 of file StandardPandora_module.cc.

References lar_pandora::ILArPandora::m_pPrimaryPandora, and Reset().

   {
     PANDORA_THROW_RESULT_IF(
       pandora::STATUS_CODE_SUCCESS, !=, PandoraApi::Reset(*m_pPrimaryPandora));
   }

void lar_pandora::StandardPandora::RunPandoraInstances ( )

privatevirtual

Run all associated pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 127 of file StandardPandora_module.cc.

References lar_pandora::ILArPandora::m_pPrimaryPandora, and ProcessEvent().

   {
     PANDORA_THROW_RESULT_IF(
       pandora::STATUS_CODE_SUCCESS, !=, PandoraApi::ProcessEvent(*m_pPrimaryPandora));
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

Member Data Documentation

std::string lar_pandora::LArPandora::m_allOutcomesInstanceLabel

protectedinherited

The instance label for all outcomes.

Definition at line 66 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::LArPandora(), and lar_pandora::LArPandora::ProcessPandoraOutput().

std::string lar_pandora::LArPandora::m_backtrackerModuleLabel

protectedinherited

The back tracker module label.

Definition at line 64 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::CreatePandoraInput().

std::unique_ptr<IHitCollectionTool> lar_pandora::LArPandora::m_collectHitsTool

protectedinherited

art tool used to collect the hits

Definition at line 76 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::CreatePandoraInput().

std::string lar_pandora::LArPandora::m_configFile

protectedinherited

The config file.

Definition at line 42 of file LArPandora.h.

Referenced by ConfigurePandoraInstances().

bool lar_pandora::LArPandora::m_disableRealDataCheck

protectedinherited

Whether to check if the input file contains real data before accessing MC information.

Definition at line 73 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::CreatePandoraInput().

LArDriftVolumeMap lar_pandora::LArPandora::m_driftVolumeMap

protectedinherited

The map from volume id to drift volume.

Definition at line 81 of file LArPandora.h.

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

bool lar_pandora::LArPandora::m_enableDetectorGaps

protectedinherited

Whether to pass detector gap information to Pandora instances.

Definition at line 69 of file LArPandora.h.

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

bool lar_pandora::LArPandora::m_enableMCParticles

protectedinherited

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

Definition at line 71 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::CreatePandoraInput().

bool lar_pandora::LArPandora::m_enableProduction

protectedinherited

Whether to persist output products.

Definition at line 68 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::LArPandora(), and lar_pandora::LArPandora::ProcessPandoraOutput().

std::string lar_pandora::LArPandora::m_geantModuleLabel

protectedinherited

The geant module label.

Definition at line 61 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::CreatePandoraInput().

std::string lar_pandora::LArPandora::m_generatorModuleLabel

protectedinherited

The generator module label.

Definition at line 60 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::CreatePandoraInput().

std::string lar_pandora::LArPandora::m_hitfinderModuleLabel

protectedinherited

The hit finder module label.

Definition at line 63 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::CreatePandoraInput(), and lar_pandora::LArPandora::LArPandora().

LArPandoraInput::Settings lar_pandora::LArPandora::m_inputSettings

protectedinherited

The lar pandora input settings.

Definition at line 78 of file LArPandora.h.

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

bool lar_pandora::LArPandora::m_lineGapsCreated

protectedinherited

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

Definition at line 74 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::CreatePandoraInput().

LArPandoraOutput::Settings lar_pandora::LArPandora::m_outputSettings

protectedinherited

The lar pandora output settings.

Definition at line 79 of file LArPandora.h.

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

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

protectedinherited

The address of the primary pandora instance.

Definition at line 85 of file ILArPandora.h.

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

bool lar_pandora::LArPandora::m_printOverallRecoStatus

protectedinherited

Steering: whether to print current operation status messages.

Definition at line 58 of file LArPandora.h.

Referenced by ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldPerformSliceId

protectedinherited

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

Definition at line 56 of file LArPandora.h.

Referenced by ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldProduceAllOutcomes

protectedinherited

Steering: whether to produce all reconstruction outcomes.

Definition at line 57 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::LArPandora(), and lar_pandora::LArPandora::ProcessPandoraOutput().

bool lar_pandora::LArPandora::m_shouldRunAllHitsCosmicReco

protectedinherited

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

Definition at line 45 of file LArPandora.h.

Referenced by ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldRunCosmicHitRemoval

protectedinherited

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

Definition at line 48 of file LArPandora.h.

Referenced by ProvideExternalSteeringParameters().

bool lar_pandora::LArPandora::m_shouldRunCosmicRecoOption

protectedinherited

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

Definition at line 54 of file LArPandora.h.

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

bool lar_pandora::LArPandora::m_shouldRunNeutrinoRecoOption

protectedinherited

Steering: whether to run neutrino reconstruction for each slice.

Definition at line 52 of file LArPandora.h.

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

bool lar_pandora::LArPandora::m_shouldRunSlicing

protectedinherited

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

Definition at line 50 of file LArPandora.h.

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

bool lar_pandora::LArPandora::m_shouldRunStitching

protectedinherited

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

Definition at line 47 of file LArPandora.h.

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

std::string lar_pandora::LArPandora::m_simChannelModuleLabel

protectedinherited

The SimChannel producer module label.

Definition at line 62 of file LArPandora.h.

Referenced by lar_pandora::LArPandora::CreatePandoraInput().

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

larpandora/v09_22_05/source/larpandora/LArPandoraInterface/StandardPandora_module.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation