#include <DUNEAnaPFParticleUtils.h>

Inheritance diagram for dune_ana::DUNEAnaPFParticleUtils:

Static Public Member Functions
static std::vector< art::Ptr< anab::T0 > >	GetT0 (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &label)
	Get the T0(s) associated with the particle. More...

static std::vector< art::Ptr< anab::CosmicTag > >	GetCosmicTag (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &label)
	Get the Cosmic Tag(s) associated with the particle. More...

static std::vector< art::Ptr< recob::PFParticle > >	GetChildParticles (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &label)
	Get the child particles (one step down in the hierarchy) of this particle. More...

static std::vector< art::Ptr< recob::Hit > >	GetHits (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &label)
	Get the hits associated to this particle. More...

static std::vector< art::Ptr< recob::Hit > >	GetViewHits (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &label, const unsigned short &view)
	Get the hits associated to this particle in a given view. More...

static std::vector< art::Ptr< recob::SpacePoint > >	GetSpacePoints (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &label)
	Get the spacepoints associated to this particle. More...

static art::Ptr< recob::Track >	GetTrack (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &pParticleLabel, const std::string &trackLabel)
	Get the track associated to this particle. Should only be called if IsTrack method succeeds. More...

static art::Ptr< recob::Shower >	GetShower (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &pParticleLabel, const std::string &showerLabel)
	Get the shower associated to this particle. Should only be called if IsShower method succeeds. More...

static art::Ptr< recob::Vertex >	GetVertex (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &pParticleLabel)
	Get the vertex associated to this particle. More...

static art::Ptr< recob::Slice >	GetSlice (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &pParticleLabel)
	Get the slice associated to this particle. More...

static art::Ptr< larpandoraobj::PFParticleMetadata >	GetMetadata (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &label)
	Get the metadata associated to this particle. More...

static bool	IsTrack (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &pParticleLabel, const std::string &trackLabel)
	Check if this particle has an associated track. More...

static bool	IsShower (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &pParticleLabel, const std::string &showerLabel)
	Check if this particle has an associated shower. More...

static bool	IsClearCosmic (const art::Ptr< recob::PFParticle > &pParticle, const art::Event &evt, const std::string &pParticleLabel)
	Check if this particle is a clear cosmic ray. More...

static bool	IsNeutrino (const art::Ptr< recob::PFParticle > &pParticle)
	Check if this particle is a neutrino. More...

Additional Inherited Members
Static Private Member Functions inherited from dune_ana::DUNEAnaUtilsBase
template<typename T >
static std::vector< art::Ptr< T > >	GetProductVector (const art::Event &evt, const std::string &label)

template<typename T , typename U >
static std::vector< art::Ptr< T > >	GetAssocProductVector (const art::Ptr< U > &part, const art::Event &evt, const std::string &label, const std::string &assocLabel)

template<typename T , typename U >
static art::Ptr< T >	GetAssocProduct (const art::Ptr< U > &part, const art::Event &evt, const std::string &label, const std::string &assocLabel)

Detailed Description

DUNEAnaPFParticleUtils class.

Definition at line 37 of file DUNEAnaPFParticleUtils.h.

Member Function Documentation

std::vector< art::Ptr< recob::PFParticle > > dune_ana::DUNEAnaPFParticleUtils::GetChildParticles	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	label
	)

static

Get the child particles (one step down in the hierarchy) of this particle.

Parameters

pParticle	particle for which we want the child particles
evt	is the underlying art event
label	is the label for the PFParticle producer

Returns: vector of art::Ptrs to the child particles

Definition at line 43 of file DUNEAnaPFParticleUtils.cxx.

 {
     auto theseParticles = evt.getHandle<std::vector<recob::PFParticle>>(label);
     bool success = theseParticles.isValid();
     
     if (!success)
     {   
         mf::LogError("LArPandora") << " Failed to find product with label " << label << " ... returning empty vector" << std::endl;
         return std::vector<art::Ptr<recob::PFParticle>>();
     }
     
     std::vector<art::Ptr<recob::PFParticle>> children;
 
     for (unsigned int iPart = 0; iPart < theseParticles->size(); ++iPart)
     {     
         if (theseParticles->at(iPart).Parent() == pParticle.key())
         {
             art::Ptr<recob::PFParticle> pChild(theseParticles,iPart);
             children.push_back(pChild);
         }
     }
 
     return children;
 }

std::vector< art::Ptr< anab::CosmicTag > > dune_ana::DUNEAnaPFParticleUtils::GetCosmicTag	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	label
	)

static

Get the Cosmic Tag(s) associated with the particle.

Parameters

pParticle	particle for which we want the cosmic tag
evt	is the underlying art event
label	is the label for the PFParticle producer

Returns: vector of art::Ptrs to the cosmic tag(s)

Definition at line 36 of file DUNEAnaPFParticleUtils.cxx.

 {
     return DUNEAnaPFParticleUtils::GetAssocProductVector<anab::CosmicTag>(pParticle,evt,label,label); 
 }

std::vector< art::Ptr< recob::Hit > > dune_ana::DUNEAnaPFParticleUtils::GetHits	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	label
	)

static

Get the hits associated to this particle.

Parameters

pParticle	particle for which we want the hits
evt	is the underlying art event
label	is the label for the PFParticle producer

Returns: vector of art::Ptrs to the hits

Definition at line 70 of file DUNEAnaPFParticleUtils.cxx.

 {    
     // There isn't a direct association between PFParticles and hits, so we go via clusters
     const std::vector<art::Ptr<recob::Cluster>> theseClusters = DUNEAnaPFParticleUtils::GetAssocProductVector<recob::Cluster>(pParticle,evt,label,label);
 
     std::vector<art::Ptr<recob::Hit>> theseHits;
     for (const art::Ptr<recob::Cluster> pCluster : theseClusters)
     {
       const std::vector<art::Ptr<recob::Hit>> tempHits = DUNEAnaPFParticleUtils::GetAssocProductVector<recob::Hit>(pCluster,evt,label,label);
       theseHits.insert(theseHits.end(),tempHits.begin(),tempHits.end());
     }
     return theseHits;
 }

art::Ptr< larpandoraobj::PFParticleMetadata > dune_ana::DUNEAnaPFParticleUtils::GetMetadata	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	label
	)

static

Get the metadata associated to this particle.

Parameters

pParticle	particle for which we want the slice
evt	is the underlying art event
label	is the label for the PFParticle producer

Returns: art::Ptr to the metadata

Definition at line 158 of file DUNEAnaPFParticleUtils.cxx.

 {
     return DUNEAnaPFParticleUtils::GetAssocProduct<larpandoraobj::PFParticleMetadata>(pParticle,evt,label,label);
 }

art::Ptr< recob::Shower > dune_ana::DUNEAnaPFParticleUtils::GetShower	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	pParticleLabel,
		const std::string &	showerLabel
	)

static

Get the shower associated to this particle. Should only be called if IsShower method succeeds.

Parameters

pParticle	particle for which we want the shower
evt	is the underlying art event
particleLabel	is the label for the PFParticle producer
trackLabel	is the label for the Shower producer

Returns: art::Ptr to the shower

Definition at line 122 of file DUNEAnaPFParticleUtils.cxx.

 {
     return DUNEAnaPFParticleUtils::GetAssocProduct<recob::Shower>(pParticle,evt,particleLabel,showerLabel);
 }

art::Ptr< recob::Slice > dune_ana::DUNEAnaPFParticleUtils::GetSlice	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	pParticleLabel
	)

static

Get the slice associated to this particle.

Parameters

pParticle	particle for which we want the slice
evt	is the underlying art event
label	is the label for the PFParticle producer

Returns: art::Ptr to the slice

Definition at line 136 of file DUNEAnaPFParticleUtils.cxx.

 {
     const art::Ptr<larpandoraobj::PFParticleMetadata> pMetadata = DUNEAnaPFParticleUtils::GetMetadata(pParticle,evt,label);
     std::map<std::string,float> metaMap = pMetadata->GetPropertiesMap();
 
     unsigned int sliceIndex;
     std::map<std::string,float>::iterator mapItr = metaMap.find("SliceIndex");
 
     if (mapItr == metaMap.end())   
     {
         throw cet::exception("DUNEAna") << " DUNEAnaPFParticleUtils::GetSlice --- No associated slice found";
     }
     else
     {
         sliceIndex = mapItr->second;
     }
 
     return DUNEAnaPFParticleUtils::GetProductVector<recob::Slice>(evt,label).at(sliceIndex);
 }

std::vector< art::Ptr< recob::SpacePoint > > dune_ana::DUNEAnaPFParticleUtils::GetSpacePoints	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	label
	)

static

Get the spacepoints associated to this particle.

Parameters

pParticle	particle for which we want the spacepoints
evt	is the underlying art event
label	is the label for the PFParticle producer

Returns: vector of art::Ptrs to the spacepoints

Definition at line 108 of file DUNEAnaPFParticleUtils.cxx.

 {
     return DUNEAnaPFParticleUtils::GetAssocProductVector<recob::SpacePoint>(pParticle,evt,label,label);
 }

std::vector< art::Ptr< anab::T0 > > dune_ana::DUNEAnaPFParticleUtils::GetT0	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	label
	)

static

Get the T0(s) associated with the particle.

Parameters

pParticle	particle for which we want the T0
evt	is the underlying art event
label	is the label for the PFParticle producer

Returns: vector of art::Ptrs to the T0(s)

Definition at line 29 of file DUNEAnaPFParticleUtils.cxx.

 {
     return DUNEAnaPFParticleUtils::GetAssocProductVector<anab::T0>(pParticle,evt,label,label);
 }

art::Ptr< recob::Track > dune_ana::DUNEAnaPFParticleUtils::GetTrack	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	pParticleLabel,
		const std::string &	trackLabel
	)

static

Get the track associated to this particle. Should only be called if IsTrack method succeeds.

Parameters

pParticle	particle for which we want the track
evt	is the underlying art event
particleLabel	is the label for the PFParticle producer
trackLabel	is the label for the Track producer

Returns: art::Ptr to the track

Definition at line 115 of file DUNEAnaPFParticleUtils.cxx.

 {
     return DUNEAnaPFParticleUtils::GetAssocProduct<recob::Track>(pParticle,evt,particleLabel,trackLabel);
 }    

art::Ptr< recob::Vertex > dune_ana::DUNEAnaPFParticleUtils::GetVertex	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	pParticleLabel
	)

static

Get the vertex associated to this particle.

Parameters

pParticle	particle for which we want the vertex
evt	is the underlying art event
label	is the label for the PFParticle producer

Returns: art::Ptr to the vertex

Definition at line 129 of file DUNEAnaPFParticleUtils.cxx.

 {
     return DUNEAnaPFParticleUtils::GetAssocProduct<recob::Vertex>(pParticle,evt,particleLabel,particleLabel);
 }

std::vector< art::Ptr< recob::Hit > > dune_ana::DUNEAnaPFParticleUtils::GetViewHits	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	label,
		const unsigned short &	view
	)

static

Get the hits associated to this particle in a given view.

Parameters

pParticle	particle for which we want the hits
evt	is the underlying art event
label	is the label for the PFParticle producer
view	is the view for which we want the hits

Returns: vector of art::Ptrs to the hits

Definition at line 86 of file DUNEAnaPFParticleUtils.cxx.

 {
     // There isn't a direct association between PFParticles and hits, so we go via clusters
     const std::vector<art::Ptr<recob::Cluster>> theseClusters = DUNEAnaPFParticleUtils::GetAssocProductVector<recob::Cluster>(pParticle,evt,label,label);
 
     std::vector<art::Ptr<recob::Hit>> theseHits;
     for (const art::Ptr<recob::Cluster> pCluster : theseClusters)
     { 
         const std::vector<art::Ptr<recob::Hit>> tempHits = DUNEAnaPFParticleUtils::GetAssocProductVector<recob::Hit>(pCluster,evt,label,label);
         for(const art::Ptr<recob::Hit> pHit : tempHits)
         {
             if (pHit->View() == view)
             {
                 theseHits.push_back(pHit);
             }
         }
     }
     return theseHits;
 }

bool dune_ana::DUNEAnaPFParticleUtils::IsClearCosmic	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	pParticleLabel
	)

static

Check if this particle is a clear cosmic ray.

Parameters

pParticle	particle for which we want the clear cosmic confirmation
evt	is the underlying art event
particleLabel	is the label for the PFParticle producer

Returns: bool stating if the object is a clear cosmic ray

Definition at line 184 of file DUNEAnaPFParticleUtils.cxx.

 {
     const art::Ptr<larpandoraobj::PFParticleMetadata> pMetadata = DUNEAnaPFParticleUtils::GetMetadata(pParticle,evt,particleLabel);
 
     std::map<std::string,float> metaMap = pMetadata->GetPropertiesMap();
 
     return metaMap.find("IsClearCosmic") != metaMap.end();
 }

bool dune_ana::DUNEAnaPFParticleUtils::IsNeutrino ( const art::Ptr< recob::PFParticle > & pParticle )

static

Check if this particle is a neutrino.

Parameters

pParticle particle for which we want the neutrino confirmation

Returns: bool stating if the object is a neutrino

Definition at line 195 of file DUNEAnaPFParticleUtils.cxx.

 {
     const int pdg = pParticle->PdgCode();
     return ((std::abs(pdg) == 12) || (std::abs(pdg) == 14) || (std::abs(pdg) ==16));
 }

bool dune_ana::DUNEAnaPFParticleUtils::IsShower	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	pParticleLabel,
		const std::string &	showerLabel
	)

static

Check if this particle has an associated shower.

Parameters

pParticle	particle for which we want the shower-like confirmation
evt	is the underlying art event
particleLabel	is the label for the PFParticle producer
showerLabel	is the label for the shower producer

Returns: bool stating if the object is shower-like

Definition at line 175 of file DUNEAnaPFParticleUtils.cxx.

 {
     const std::vector<art::Ptr<recob::Shower>> theseShowers = DUNEAnaPFParticleUtils::GetAssocProductVector<recob::Shower>(pParticle,evt,particleLabel,showerLabel);
    
     return !theseShowers.empty();
 }

bool dune_ana::DUNEAnaPFParticleUtils::IsTrack	(	const art::Ptr< recob::PFParticle > &	pParticle,
		const art::Event &	evt,
		const std::string &	pParticleLabel,
		const std::string &	trackLabel
	)

static

Check if this particle has an associated track.

Parameters

pParticle	particle for which we want the track-like confirmation
evt	is the underlying art event
particleLabel	is the label for the PFParticle producer
trackLabel	is the label for the track producer

Returns: bool stating if the object is track-like

Definition at line 165 of file DUNEAnaPFParticleUtils.cxx.

 {
     // This function needs to fail if GetTrack would fail
     const std::vector<art::Ptr<recob::Track>> theseTracks = DUNEAnaPFParticleUtils::GetAssocProductVector<recob::Track>(pParticle,evt,particleLabel,trackLabel);
 
     return !theseTracks.empty();
 }

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

dunereco/dunereco/AnaUtils/DUNEAnaPFParticleUtils.h
dunereco/dunereco/AnaUtils/DUNEAnaPFParticleUtils.cxx

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation