Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
lar_pandora::ILArPandora Class Referenceabstract

ILArPandora class. More...

#include <ILArPandora.h>

Inheritance diagram for lar_pandora::ILArPandora:
art::EDProducer art::detail::Producer art::detail::LegacyModule art::Modifier art::ModuleBase art::ProductRegistryHelper lar_pandora::LArPandora lar_pandora::StandardPandora

Public Member Functions

 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
 
Produceroperator= (Producer const &)=delete
 
Produceroperator= (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
 
Modifieroperator= (Modifier const &)=delete
 
Modifieroperator= (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)
 

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 CreatePandoraInput (art::Event &evt, IdToHitMap &idToHitMap)=0
 Create pandora input hits, mc particles etc. More...
 
virtual void ProcessPandoraOutput (art::Event &evt, const IdToHitMap &idToHitMap)=0
 Process pandora output particle flow objects. More...
 
virtual void RunPandoraInstances ()=0
 Run all associated pandora instances. More...
 
virtual void ResetPandoraInstances ()=0
 Reset all associated pandora instances. More...
 
- Protected Member Functions inherited from art::ModuleBase
ConsumesCollectorconsumesCollector ()
 
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

const pandora::Pandora * m_pPrimaryPandora
 The address of the primary pandora instance. 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)
 

Detailed Description

ILArPandora class.

Definition at line 26 of file ILArPandora.h.

Constructor & Destructor Documentation

lar_pandora::ILArPandora::ILArPandora ( fhicl::ParameterSet const &  pset)
inline

Constructor.

Parameters
psetthe parameter set

Definition at line 88 of file ILArPandora.h.

88  :
89  EDProducer(pset),
90  m_pPrimaryPandora(nullptr)
91 {
92 }
EDProducer(fhicl::ParameterSet const &pset)
Definition: EDProducer.h:20
const pandora::Pandora * m_pPrimaryPandora
The address of the primary pandora instance.
Definition: ILArPandora.h:83
lar_pandora::ILArPandora::~ILArPandora ( )
inlinevirtual

Destructor.

Definition at line 96 of file ILArPandora.h.

97 {
98 }

Member Function Documentation

virtual void lar_pandora::ILArPandora::ConfigurePandoraInstances ( )
protectedpure virtual

Configure pandora instances.

Implemented in lar_pandora::StandardPandora.

virtual void lar_pandora::ILArPandora::CreatePandoraInput ( art::Event evt,
IdToHitMap idToHitMap 
)
protectedpure virtual

Create pandora input hits, mc particles etc.

Parameters
evtthe art event
idToHitMapto receive the populated pandora hit id to art hit map

Implemented in lar_pandora::LArPandora.

virtual void lar_pandora::ILArPandora::CreatePandoraInstances ( )
protectedpure virtual

Create pandora instances.

Implemented in lar_pandora::StandardPandora.

virtual void lar_pandora::ILArPandora::DeletePandoraInstances ( )
protectedpure virtual

Delete pandora instances.

Implemented in lar_pandora::StandardPandora.

virtual void lar_pandora::ILArPandora::ProcessPandoraOutput ( art::Event evt,
const IdToHitMap idToHitMap 
)
protectedpure virtual

Process pandora output particle flow objects.

Parameters
evtthe art event
idToHitMapthe pandora hit id to art hit map

Implemented in lar_pandora::LArPandora.

virtual void lar_pandora::ILArPandora::ResetPandoraInstances ( )
protectedpure virtual

Reset all associated pandora instances.

Implemented in lar_pandora::StandardPandora.

virtual void lar_pandora::ILArPandora::RunPandoraInstances ( )
protectedpure virtual

Run all associated pandora instances.

Implemented in lar_pandora::StandardPandora.

Member Data Documentation

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

The address of the primary pandora instance.

Definition at line 83 of file ILArPandora.h.


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