Inheritance diagram for lar_pandora::StandardPandora:

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

	~StandardPandora ()
	Destructor. More...

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

void	beginJob ()

void	produce (art::Event &evt)

Public Member Functions inherited from lar_pandora::ILArPandora
	ILArPandora (fhicl::ParameterSet const &pset)
	Constructor. More...

virtual	~ILArPandora ()
	Destructor. More...

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

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

std::string	workerType () const

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

	Producer (fhicl::ParameterSet const &)

	Producer (Producer const &)=delete

	Producer (Producer &&)=delete

Producer &	operator= (Producer const &)=delete

Producer &	operator= (Producer &&)=delete

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::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

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)

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

Additional Inherited Members
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)

Protected Member Functions inherited from lar_pandora::LArPandora
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...

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

Protected Attributes inherited from lar_pandora::LArPandora
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...

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

Protected Attributes inherited from lar_pandora::ILArPandora
const pandora::Pandora *	m_pPrimaryPandora
	The address of the primary pandora instance. More...

Detailed Description

StandardPandora class.

Definition at line 19 of file StandardPandora_module.cc.

Constructor & Destructor Documentation

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

Constructor.

Parameters

pset	the parameter set

Definition at line 73 of file StandardPandora_module.cc.

                                                               :
     LArPandora(pset)
 {
 }

lar_pandora::StandardPandora::~StandardPandora ( )

Destructor.

Definition at line 80 of file StandardPandora_module.cc.

 {
     this->DeletePandoraInstances();
 }

Member Function Documentation

void lar_pandora::StandardPandora::ConfigurePandoraInstances ( )

privatevirtual

Configure pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 105 of file StandardPandora_module.cc.

 {
     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));
 }

void lar_pandora::StandardPandora::CreatePandoraInstances ( )

privatevirtual

Create pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 87 of file StandardPandora_module.cc.

 {
     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 133 of file StandardPandora_module.cc.

 {
     MultiPandoraApi::DeletePandoraInstances(m_pPrimaryPandora);
 }

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 140 of file StandardPandora_module.cc.

 {
     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 lar_pandora::StandardPandora::ResetPandoraInstances ( )

privatevirtual

Reset all associated pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 126 of file StandardPandora_module.cc.

 {
     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 119 of file StandardPandora_module.cc.

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

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

larpandora/larpandora/LArPandoraInterface/StandardPandora_module.cc

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation