#include <LArPandora.h>

Inheritance diagram for lar_pandora::LArPandora:

Public Member Functions
	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)

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

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

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

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

LArPandora class.

Definition at line 24 of file LArPandora.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters

pset	the parameter set

Definition at line 44 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_disableRealDataCheck(pset.get<bool>("DisableRealDataCheck", 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_useActiveBoundingBox = pset.get<bool>("UseActiveBoundingBox", 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_shouldRunStitching = m_shouldRunStitching;
     m_outputSettings.m_shouldProduceSlices = pset.get<bool>("ShouldProduceSlices", true);
     m_outputSettings.m_shouldProduceTestBeamInteractionVertices =
       pset.get<bool>("ShouldProduceTestBeamInteractionVertices", false);
     m_outputSettings.m_testBeamInteractionVerticesInstanceLabel = pset.get<std::string>(
       "TestBeamInteractionVerticesInstanceLabel", "testBeamInteractionVertices");
     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<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::SpacePoint, recob::Hit>>(instanceName);
         produces<art::Assns<recob::Cluster, recob::Hit>>(instanceName);
 
         if (m_outputSettings.m_shouldProduceTestBeamInteractionVertices) {
           // ATTN: Test beam interaction vertex instance label appended to current instance name to preserve unique label in multiple instance case
           produces<std::vector<recob::Vertex>>(
             instanceName + m_outputSettings.m_testBeamInteractionVerticesInstanceLabel);
           produces<art::Assns<recob::PFParticle, recob::Vertex>>(
             instanceName + m_outputSettings.m_testBeamInteractionVerticesInstanceLabel);
         }
 
         if (m_outputSettings.m_shouldRunStitching) {
           produces<std::vector<anab::T0>>(instanceName);
           produces<art::Assns<recob::PFParticle, anab::T0>>(instanceName);
         }
 
         if (m_outputSettings.m_shouldProduceSlices) {
           produces<std::vector<recob::Slice>>(instanceName);
           produces<art::Assns<recob::Slice, recob::Hit>>(instanceName);
           produces<art::Assns<recob::PFParticle, recob::Slice>>(instanceName);
         }
       }
     }
   }

Member Function Documentation

void lar_pandora::LArPandora::beginJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 134 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::LArPandora::CreatePandoraInput	(	art::Event &	evt,
		IdToHitMap &	idToHitMap
	)

protectedvirtual

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

   {
     // 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);
 
     LArPandoraHelper::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::LArPandora::ProcessPandoraOutput	(	art::Event &	evt,
		const IdToHitMap &	idToHitMap
	)

protectedvirtual

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

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

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

Member Data Documentation

std::string lar_pandora::LArPandora::m_allOutcomesInstanceLabel

protected

The instance label for all outcomes.

Definition at line 64 of file LArPandora.h.

std::string lar_pandora::LArPandora::m_backtrackerModuleLabel

protected

The back tracker module label.

Definition at line 62 of file LArPandora.h.

std::string lar_pandora::LArPandora::m_configFile

protected

The config file.

Definition at line 40 of file LArPandora.h.

bool lar_pandora::LArPandora::m_disableRealDataCheck

protected

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

Definition at line 71 of file LArPandora.h.

LArDriftVolumeMap lar_pandora::LArPandora::m_driftVolumeMap

protected

The map from volume id to drift volume.

Definition at line 77 of file LArPandora.h.

bool lar_pandora::LArPandora::m_enableDetectorGaps

protected

Whether to pass detector gap information to Pandora instances.

Definition at line 67 of file LArPandora.h.

bool lar_pandora::LArPandora::m_enableMCParticles

protected

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

Definition at line 69 of file LArPandora.h.

bool lar_pandora::LArPandora::m_enableProduction

protected

Whether to persist output products.

Definition at line 66 of file LArPandora.h.

std::string lar_pandora::LArPandora::m_geantModuleLabel

protected

The geant module label.

Definition at line 59 of file LArPandora.h.

std::string lar_pandora::LArPandora::m_generatorModuleLabel

protected

The generator module label.

Definition at line 58 of file LArPandora.h.

std::string lar_pandora::LArPandora::m_hitfinderModuleLabel

protected

The hit finder module label.

Definition at line 61 of file LArPandora.h.

LArPandoraInput::Settings lar_pandora::LArPandora::m_inputSettings

protected

The lar pandora input settings.

Definition at line 74 of file LArPandora.h.

bool lar_pandora::LArPandora::m_lineGapsCreated

protected

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

Definition at line 72 of file LArPandora.h.

LArPandoraOutput::Settings lar_pandora::LArPandora::m_outputSettings

protected

The lar pandora output settings.

Definition at line 75 of file LArPandora.h.

bool lar_pandora::LArPandora::m_printOverallRecoStatus

protected

Steering: whether to print current operation status messages.

Definition at line 56 of file LArPandora.h.

bool lar_pandora::LArPandora::m_shouldPerformSliceId

protected

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

Definition at line 54 of file LArPandora.h.

bool lar_pandora::LArPandora::m_shouldProduceAllOutcomes

protected

Steering: whether to produce all reconstruction outcomes.

Definition at line 55 of file LArPandora.h.

bool lar_pandora::LArPandora::m_shouldRunAllHitsCosmicReco

protected

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

Definition at line 43 of file LArPandora.h.

bool lar_pandora::LArPandora::m_shouldRunCosmicHitRemoval

protected

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

Definition at line 46 of file LArPandora.h.

bool lar_pandora::LArPandora::m_shouldRunCosmicRecoOption

protected

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

Definition at line 52 of file LArPandora.h.

bool lar_pandora::LArPandora::m_shouldRunNeutrinoRecoOption

protected

Steering: whether to run neutrino reconstruction for each slice.

Definition at line 50 of file LArPandora.h.

bool lar_pandora::LArPandora::m_shouldRunSlicing

protected

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

Definition at line 48 of file LArPandora.h.

bool lar_pandora::LArPandora::m_shouldRunStitching

protected

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

Definition at line 45 of file LArPandora.h.

std::string lar_pandora::LArPandora::m_simChannelModuleLabel

protected

The SimChannel producer module label.

Definition at line 60 of file LArPandora.h.

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

larpandora/larpandora/LArPandoraInterface/LArPandora.h
larpandora/larpandora/LArPandoraInterface/LArPandora.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation