Inheritance diagram for lar_pandora::StandardPandora:

[legend]

Collaboration diagram for lar_pandora::StandardPandora:

[legend]

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

	~StandardPandora ()
	Destructor.

void	beginJob ()

void	produce (art::Event &evt)

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

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

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

Protected Attributes
std::string	m_configFile
	The config file.

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

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

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

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

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

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

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

bool	m_shouldProduceAllOutcomes
	Steering: whether to produce all reconstruction outcomes.

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

std::string	m_generatorModuleLabel
	The generator module label.

std::string	m_geantModuleLabel
	The geant module label.

std::string	m_simChannelModuleLabel
	The SimChannel producer module label.

std::string	m_hitfinderModuleLabel
	The hit finder module label.

std::string	m_backtrackerModuleLabel
	The back tracker module label.

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

bool	m_enableProduction
	Whether to persist output products.

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

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

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

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

std::unique_ptr< IHitCollectionTool >	m_collectHitsTool
	art tool used to collect the hits

LArPandoraInput::Settings	m_inputSettings
	The lar pandora input settings.

LArPandoraOutput::Settings	m_outputSettings
	The lar pandora output settings.

LArDriftVolumeMap	m_driftVolumeMap
	The map from volume id to drift volume.

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

Private Member Functions
void	CreatePandoraInstances ()
	Create pandora instances.

void	ConfigurePandoraInstances ()
	Configure pandora instances.

void	RunPandoraInstances ()
	Run all associated pandora instances.

void	ResetPandoraInstances ()
	Reset all associated pandora instances.

void	DeletePandoraInstances ()
	Delete pandora instances.

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

Detailed Description

StandardPandora class.

Definition at line 18 of file StandardPandora_module.cc.

Constructor & Destructor Documentation

◆ StandardPandora()

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

Constructor.

Parameters

pset	the parameter set

Definition at line 70 of file StandardPandora_module.cc.

◆ ~StandardPandora()

lar_pandora::StandardPandora::~StandardPandora ( )

Destructor.

Definition at line 74 of file StandardPandora_module.cc.

Here is the call graph for this function:

Member Function Documentation

◆ beginJob()

void lar_pandora::LArPandora::beginJob ( )

inherited

Definition at line 133 of file LArPandora.cxx.

Here is the call graph for this function:

◆ ConfigurePandoraInstances()

void lar_pandora::StandardPandora::ConfigurePandoraInstances ( )

privatevirtual

Configure pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 106 of file StandardPandora_module.cc.

Here is the call graph for this function:

◆ ConstructHitCollectionToolParameterSet()

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

protectedinherited

Definition at line 256 of file LArPandora.cxx.

◆ CreatePandoraInput()

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreatePandoraInstances()

void lar_pandora::StandardPandora::CreatePandoraInstances ( )

privatevirtual

Create pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 78 of file StandardPandora_module.cc.

Here is the call graph for this function:

◆ DeletePandoraInstances()

void lar_pandora::StandardPandora::DeletePandoraInstances ( )

privatevirtual

Delete pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 140 of file StandardPandora_module.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessPandoraOutput()

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.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ produce()

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

inherited

Definition at line 164 of file LArPandora.cxx.

Here is the call graph for this function:

◆ ProvideExternalSteeringParameters()

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetPandoraInstances()

void lar_pandora::StandardPandora::ResetPandoraInstances ( )

privatevirtual

Reset all associated pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 132 of file StandardPandora_module.cc.

Here is the call graph for this function:

◆ RunPandoraInstances()

void lar_pandora::StandardPandora::RunPandoraInstances ( )

privatevirtual

Run all associated pandora instances.

Implements lar_pandora::ILArPandora.

Definition at line 124 of file StandardPandora_module.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_allOutcomesInstanceLabel

std::string lar_pandora::LArPandora::m_allOutcomesInstanceLabel

protectedinherited

The instance label for all outcomes.

Definition at line 66 of file LArPandora.h.

◆ m_backtrackerModuleLabel

std::string lar_pandora::LArPandora::m_backtrackerModuleLabel

protectedinherited

The back tracker module label.

Definition at line 64 of file LArPandora.h.

◆ m_collectHitsTool

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.

◆ m_configFile

std::string lar_pandora::LArPandora::m_configFile

protectedinherited

The config file.

Definition at line 42 of file LArPandora.h.

◆ m_disableRealDataCheck

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.

◆ m_driftVolumeMap

LArDriftVolumeMap lar_pandora::LArPandora::m_driftVolumeMap

protectedinherited

The map from volume id to drift volume.

Definition at line 81 of file LArPandora.h.

◆ m_enableDetectorGaps

bool lar_pandora::LArPandora::m_enableDetectorGaps

protectedinherited

Whether to pass detector gap information to Pandora instances.

Definition at line 69 of file LArPandora.h.

◆ m_enableMCParticles

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.

◆ m_enableProduction

bool lar_pandora::LArPandora::m_enableProduction

protectedinherited

Whether to persist output products.

Definition at line 68 of file LArPandora.h.

◆ m_geantModuleLabel

std::string lar_pandora::LArPandora::m_geantModuleLabel

protectedinherited

The geant module label.

Definition at line 61 of file LArPandora.h.

◆ m_generatorModuleLabel

std::string lar_pandora::LArPandora::m_generatorModuleLabel

protectedinherited

The generator module label.

Definition at line 60 of file LArPandora.h.

◆ m_hitfinderModuleLabel

std::string lar_pandora::LArPandora::m_hitfinderModuleLabel

protectedinherited

The hit finder module label.

Definition at line 63 of file LArPandora.h.

◆ m_inputSettings

LArPandoraInput::Settings lar_pandora::LArPandora::m_inputSettings

protectedinherited

The lar pandora input settings.

Definition at line 78 of file LArPandora.h.

◆ m_lineGapsCreated

bool lar_pandora::LArPandora::m_lineGapsCreated

protectedinherited

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

Definition at line 74 of file LArPandora.h.

◆ m_outputSettings

LArPandoraOutput::Settings lar_pandora::LArPandora::m_outputSettings

protectedinherited

The lar pandora output settings.

Definition at line 79 of file LArPandora.h.

◆ m_pPrimaryPandora

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

protectedinherited

The address of the primary pandora instance.

Definition at line 85 of file ILArPandora.h.

◆ m_printOverallRecoStatus

bool lar_pandora::LArPandora::m_printOverallRecoStatus

protectedinherited

Steering: whether to print current operation status messages.

Definition at line 58 of file LArPandora.h.

◆ m_shouldPerformSliceId

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.

◆ m_shouldProduceAllOutcomes

bool lar_pandora::LArPandora::m_shouldProduceAllOutcomes

protectedinherited

Steering: whether to produce all reconstruction outcomes.

Definition at line 57 of file LArPandora.h.

◆ m_shouldRunAllHitsCosmicReco

bool lar_pandora::LArPandora::m_shouldRunAllHitsCosmicReco

protectedinherited

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

Definition at line 45 of file LArPandora.h.

◆ m_shouldRunCosmicHitRemoval

bool lar_pandora::LArPandora::m_shouldRunCosmicHitRemoval

protectedinherited

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

Definition at line 48 of file LArPandora.h.

◆ m_shouldRunCosmicRecoOption

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.

◆ m_shouldRunNeutrinoRecoOption

bool lar_pandora::LArPandora::m_shouldRunNeutrinoRecoOption

protectedinherited

Steering: whether to run neutrino reconstruction for each slice.

Definition at line 52 of file LArPandora.h.

◆ m_shouldRunSlicing

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.

◆ m_shouldRunStitching

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.

◆ m_simChannelModuleLabel

std::string lar_pandora::LArPandora::m_simChannelModuleLabel

protectedinherited

The SimChannel producer module label.

Definition at line 62 of file LArPandora.h.

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

larpandora/larpandora/LArPandoraInterface/StandardPandora_module.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ StandardPandora()

◆ ~StandardPandora()

Member Function Documentation

◆ beginJob()

◆ ConfigurePandoraInstances()

◆ ConstructHitCollectionToolParameterSet()

◆ CreatePandoraInput()

◆ CreatePandoraInstances()

◆ DeletePandoraInstances()

◆ ProcessPandoraOutput()

◆ produce()

◆ ProvideExternalSteeringParameters()

◆ ResetPandoraInstances()

◆ RunPandoraInstances()

Member Data Documentation

◆ m_allOutcomesInstanceLabel

◆ m_backtrackerModuleLabel

◆ m_collectHitsTool

◆ m_configFile

◆ m_disableRealDataCheck

◆ m_driftVolumeMap

◆ m_enableDetectorGaps

◆ m_enableMCParticles

◆ m_enableProduction

◆ m_geantModuleLabel

◆ m_generatorModuleLabel

◆ m_hitfinderModuleLabel

◆ m_inputSettings

◆ m_lineGapsCreated

◆ m_outputSettings

◆ m_pPrimaryPandora

◆ m_printOverallRecoStatus

◆ m_shouldPerformSliceId

◆ m_shouldProduceAllOutcomes

◆ m_shouldRunAllHitsCosmicReco

◆ m_shouldRunCosmicHitRemoval

◆ m_shouldRunCosmicRecoOption

◆ m_shouldRunNeutrinoRecoOption

◆ m_shouldRunSlicing

◆ m_shouldRunStitching

◆ m_simChannelModuleLabel