LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ShowerRecoTools::IShowerTool Class Referenceabstract

#include "IShowerTool.h"

Inheritance diagram for ShowerRecoTools::IShowerTool:
ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder ShowerRecoTools::Shower3DCylinderTrackHitFinder ShowerRecoTools::ShowerBayesianTrucatingdEdx ShowerRecoTools::ShowerDirectionCheater ShowerRecoTools::ShowerDirectionTopologyDecisionTool ShowerRecoTools::ShowerExampleTool ShowerRecoTools::ShowerIncrementalTrackHitFinder ShowerRecoTools::ShowerLengthPercentile ShowerRecoTools::ShowerLinearEnergy ShowerRecoTools::ShowerNumElectronsEnergy ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder ShowerRecoTools::ShowerPCADirection ShowerRecoTools::ShowerPCAEigenvalueLength ShowerRecoTools::ShowerPCAPropergationStartPosition ShowerRecoTools::ShowerPFPVertexStartPosition ShowerRecoTools::ShowerSkeletonTool ShowerRecoTools::ShowerStartPositionCheater ShowerRecoTools::ShowerTrackColinearTrajPointDirection ShowerRecoTools::ShowerTrackDirection ShowerRecoTools::ShowerTrackFinderCheater ShowerRecoTools::ShowerTrackHitDirection ShowerRecoTools::ShowerTrackPCADirection ShowerRecoTools::ShowerTrackSpacePointDirection ShowerRecoTools::ShowerTrackStartPosition ShowerRecoTools::ShowerTrackTrajPointDirection ShowerRecoTools::ShowerTrackTrajToSpacePoint ShowerRecoTools::ShowerTrajPointdEdx ShowerRecoTools::ShowerUnidirectiondEdx

Public Member Functions

 IShowerTool (const fhicl::ParameterSet &pset)
 
virtual ~IShowerTool () noexcept=default
 
virtual int CalculateElement (const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder)=0
 
int RunShowerTool (const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder, std::string evd_display_name_append="")
 
virtual void InitialiseProducers ()
 
void SetPtr (art::ProducesCollector *collector)
 
void InitaliseProducerPtr (reco::shower::ShowerProducedPtrsHolder &uniqueproducerPtrs)
 
virtual int AddAssociations (const art::Ptr< recob::PFParticle > &pfpPtr, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder)
 

Protected Member Functions

const shower::LArPandoraShowerAlg & GetLArPandoraShowerAlg () const
 
template<class T >
art::Ptr< T > GetProducedElementPtr (std::string Name, reco::shower::ShowerElementHolder &ShowerEleHolder, int iter=-1)
 
template<class T >
void InitialiseProduct (std::string Name, std::string InstanceName="")
 
template<class T , class A , class B >
void AddSingle (A &a, B &b, std::string Name)
 
int GetVectorPtrSize (std::string Name)
 
void PrintPtrs ()
 
void PrintPtr (std::string Name)
 

Private Attributes

reco::shower::ShowerProducedPtrsHolder * UniquePtrs
 
shower::LArPandoraShowerAlg fLArPandoraShowerAlg
 
bool fRunEventDisplay
 
art::ProducesCollector * collectorPtr
 

Detailed Description

Definition at line 30 of file IShowerTool.h.

Constructor & Destructor Documentation

ShowerRecoTools::IShowerTool::IShowerTool ( const fhicl::ParameterSet &  pset)
inline

Definition at line 33 of file IShowerTool.h.

34  : fLArPandoraShowerAlg(pset.get<fhicl::ParameterSet>("LArPandoraShowerAlg"))
35  , fRunEventDisplay(pset.get<bool>("EnableEventDisplay")){};
fhicl::ParameterSet::get
T get(std::string const &key) const
Definition: ParameterSet.h:314
ShowerRecoTools::IShowerTool::fLArPandoraShowerAlg
shower::LArPandoraShowerAlg fLArPandoraShowerAlg
Definition: IShowerTool.h:92
virtual ShowerRecoTools::IShowerTool::~IShowerTool ( )
virtualdefaultnoexcept

Member Function Documentation

virtual int ShowerRecoTools::IShowerTool::AddAssociations ( const art::Ptr< recob::PFParticle > &  pfpPtr,
art::Event &  Event,
reco::shower::ShowerElementHolder &  ShowerEleHolder 
)
inlinevirtual

Reimplemented in ShowerRecoTools::ShowerPCADirection, ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder, ShowerRecoTools::ShowerExampleTool, and ShowerRecoTools::ShowerSkeletonTool.

Definition at line 74 of file IShowerTool.h.

77  {
78  return 0;
79  }
template<class T , class A , class B >
void ShowerRecoTools::IShowerTool::AddSingle ( A &  a,
B &  b,
std::string  Name 
)
inlineprotected

Definition at line 152 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::AddSingle().

153  {
154  UniquePtrs->AddSingle<T>(a, b, Name);
155  }
ShowerRecoTools::IShowerTool::UniquePtrs
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:85
reco::shower::ShowerProducedPtrsHolder::AddSingle
void AddSingle(A &a, B &b, const std::string &Name)
Definition: ShowerProducedPtrsHolder.hh:438
virtual int ShowerRecoTools::IShowerTool::CalculateElement ( const art::Ptr< recob::PFParticle > &  pfparticle,
art::Event &  Event,
reco::shower::ShowerElementHolder &  ShowerEleHolder 
)
pure virtual

Implemented in ShowerRecoTools::ShowerTrajPointdEdx, ShowerRecoTools::ShowerIncrementalTrackHitFinder, ShowerRecoTools::ShowerNumElectronsEnergy, ShowerRecoTools::ShowerPCADirection, ShowerRecoTools::ShowerBayesianTrucatingdEdx, ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder, ShowerRecoTools::ShowerTrackPCADirection, ShowerRecoTools::ShowerDirectionCheater, ShowerRecoTools::ShowerTrackColinearTrajPointDirection, ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder, ShowerRecoTools::ShowerLinearEnergy, ShowerRecoTools::ShowerPFPVertexStartPosition, ShowerRecoTools::ShowerPCAPropergationStartPosition, ShowerRecoTools::ShowerStartPositionCheater, ShowerRecoTools::ShowerTrackFinderCheater, ShowerRecoTools::Shower3DCylinderTrackHitFinder, ShowerRecoTools::ShowerTrackHitDirection, ShowerRecoTools::ShowerUnidirectiondEdx, ShowerRecoTools::ShowerTrackSpacePointDirection, ShowerRecoTools::ShowerTrackTrajToSpacePoint, ShowerRecoTools::ShowerDirectionTopologyDecisionTool, ShowerRecoTools::ShowerLengthPercentile, ShowerRecoTools::ShowerTrackDirection, ShowerRecoTools::ShowerTrackTrajPointDirection, ShowerRecoTools::ShowerExampleTool, ShowerRecoTools::ShowerPCAEigenvalueLength, ShowerRecoTools::ShowerTrackStartPosition, and ShowerRecoTools::ShowerSkeletonTool.

const shower::LArPandoraShowerAlg& ShowerRecoTools::IShowerTool::GetLArPandoraShowerAlg ( ) const
inlineprotected

Definition at line 82 of file IShowerTool.h.

Referenced by ShowerRecoTools::ShowerLengthPercentile::CalculateElement(), ShowerRecoTools::ShowerUnidirectiondEdx::CalculateElement(), ShowerRecoTools::Shower3DCylinderTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerPCAPropergationStartPosition::CalculateElement(), ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerPFPVertexStartPosition::CalculateElement(), ShowerRecoTools::ShowerDirectionCheater::CalculateElement(), ShowerRecoTools::ShowerPCADirection::CalculateElement(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), ShowerRecoTools::ShowerPCADirection::CalculateShowerPCA(), ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder::FindInitialTrackHits(), ShowerRecoTools::Shower3DCylinderTrackHitFinder::FindTrackSpacePoints(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::FitSegmentAndCalculateResidual(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::PruneFrontOfSPSPool(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::PruneTrack(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::RunTestOfIncrementalSpacePointFinder(), ShowerRecoTools::ShowerTrackPCADirection::ShowerPCAVector(), and ShowerRecoTools::ShowerIncrementalTrackHitFinder::ShowerPCAVector().

83  {
84  return fLArPandoraShowerAlg;
85  };
ShowerRecoTools::IShowerTool::fLArPandoraShowerAlg
shower::LArPandoraShowerAlg fLArPandoraShowerAlg
Definition: IShowerTool.h:92
template<class T >
art::Ptr<T> ShowerRecoTools::IShowerTool::GetProducedElementPtr ( std::string  Name,
reco::shower::ShowerElementHolder &  ShowerEleHolder,
int  iter = -1 
)
inlineprotected

Definition at line 102 of file IShowerTool.h.

References reco::shower::ShowerElementHolder::CheckElement(), reco::shower::ShowerProducedPtrsHolder::CheckUniqueProduerPtr(), reco::shower::ShowerProducedPtrsHolder::GetArtPtr(), and reco::shower::ShowerElementHolder::GetShowerNumber().

105  {
106 
107  //Check the element has been set
108  bool check_element = ShowerEleHolder.CheckElement(Name);
109  if (!check_element) {
110  throw cet::exception("IShowerTool") << "tried to get a element that does not exist. Failed "
111  "at making the art ptr for Element: "
112  << Name << std::endl;
113  }
114 
115  //Check the unique ptr has been set.
116  bool check_ptr = UniquePtrs->CheckUniqueProduerPtr(Name);
117  if (!check_ptr) {
118  throw cet::exception("IShowerTool")
119  << "tried to get a ptr that does not exist. Failed at making the art ptr for Element"
120  << Name;
121  }
122 
123  //Check if the user has defined an index if not just use the current shower index/
124  int index;
125  if (iter != -1) { index = iter; }
126  else {
127  index = ShowerEleHolder.GetShowerNumber();
128  }
129 
130  //Make the ptr
131  return UniquePtrs->GetArtPtr<T>(Name, index);
132  }
ShowerRecoTools::IShowerTool::UniquePtrs
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:85
reco::shower::ShowerProducedPtrsHolder::CheckUniqueProduerPtr
bool CheckUniqueProduerPtr(const std::string &Name) const
Definition: ShowerProducedPtrsHolder.hh:364
reco::shower::ShowerElementHolder::CheckElement
bool CheckElement(const std::string &Name) const
Definition: ShowerElementHolder.hh:470
reco::shower::ShowerProducedPtrsHolder::GetArtPtr
art::Ptr< T > GetArtPtr(const std::string &Name, const int &iter) const
Definition: ShowerProducedPtrsHolder.hh:501
fhicl::exception
cet::coded_exception< error, detail::translate > exception
Definition: exception.h:33
int ShowerRecoTools::IShowerTool::GetVectorPtrSize ( std::string  Name)
inlineprotected

Definition at line 158 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::GetVectorPtrSize().

Referenced by ShowerRecoTools::ShowerExampleTool::AddAssociations(), ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder::AddAssociations(), and ShowerRecoTools::ShowerPCADirection::AddAssociations().

158 { return UniquePtrs->GetVectorPtrSize(Name); }
ShowerRecoTools::IShowerTool::UniquePtrs
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:85
reco::shower::ShowerProducedPtrsHolder::GetVectorPtrSize
int GetVectorPtrSize(const std::string &Name) const
Definition: ShowerProducedPtrsHolder.hh:535
void ShowerRecoTools::IShowerTool::InitaliseProducerPtr ( reco::shower::ShowerProducedPtrsHolder &  uniqueproducerPtrs)
inline

Definition at line 68 of file IShowerTool.h.

69  {
70  UniquePtrs = &uniqueproducerPtrs;
71  }
ShowerRecoTools::IShowerTool::UniquePtrs
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:85
virtual void ShowerRecoTools::IShowerTool::InitialiseProducers ( )
inlinevirtual

Reimplemented in ShowerRecoTools::ShowerPCADirection, ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder, and ShowerRecoTools::ShowerExampleTool.

Definition at line 62 of file IShowerTool.h.

62 {}
template<class T >
void ShowerRecoTools::IShowerTool::InitialiseProduct ( std::string  Name,
std::string  InstanceName = "" 
)
inlineprotected

Definition at line 137 of file IShowerTool.h.

References art::ProducesCollector::produces(), and reco::shower::ShowerProducedPtrsHolder::SetShowerUniqueProduerPtr().

138  {
139 
140  if (collectorPtr == nullptr) {
141  mf::LogWarning("IShowerTool") << "The art::ProducesCollector ptr has not been set";
142  return;
143  }
144 
145  collectorPtr->produces<T>(InstanceName);
146  UniquePtrs->SetShowerUniqueProduerPtr(type<T>(), Name, InstanceName);
147  }
ShowerRecoTools::IShowerTool::UniquePtrs
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:85
ShowerRecoTools::IShowerTool::collectorPtr
art::ProducesCollector * collectorPtr
Definition: IShowerTool.h:97
art::ProducesCollector::produces
void produces(std::string const &instanceName={}, Persistable const persistable=Persistable::Yes)
Definition: ProducesCollector.h:88
mf::LogWarning
MaybeLogger_< ELseverityLevel::ELsev_warning, false > LogWarning
Definition: MessageLogger.h:210
reco::shower::ShowerProducedPtrsHolder::SetShowerUniqueProduerPtr
int SetShowerUniqueProduerPtr(type< T >, const std::string &Name, const std::string &Instance="")
Definition: ShowerProducedPtrsHolder.hh:308
void ShowerRecoTools::IShowerTool::PrintPtr ( std::string  Name)
inlineprotected

Definition at line 162 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::PrintPtr().

Referenced by ShowerRecoTools::ShowerExampleTool::CalculateElement().

162 { UniquePtrs->PrintPtr(Name); }
ShowerRecoTools::IShowerTool::UniquePtrs
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:85
reco::shower::ShowerProducedPtrsHolder::PrintPtr
void PrintPtr(const std::string &Name) const
Definition: ShowerProducedPtrsHolder.hh:546
void ShowerRecoTools::IShowerTool::PrintPtrs ( )
inlineprotected

Definition at line 160 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::PrintPtrs().

Referenced by ShowerRecoTools::ShowerExampleTool::CalculateElement().

160 { UniquePtrs->PrintPtrs(); }
ShowerRecoTools::IShowerTool::UniquePtrs
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:85
int ShowerRecoTools::IShowerTool::RunShowerTool ( const art::Ptr< recob::PFParticle > &  pfparticle,
art::Event &  Event,
reco::shower::ShowerElementHolder &  ShowerEleHolder,
std::string  evd_display_name_append = "" 
)
inline

Definition at line 46 of file IShowerTool.h.

50  {
51 
52  int calculation_status = CalculateElement(pfparticle, Event, ShowerEleHolder);
53  if (calculation_status != 0) return calculation_status;
54  if (fRunEventDisplay) {
55  IShowerTool::GetLArPandoraShowerAlg().DebugEVD(
56  pfparticle, Event, ShowerEleHolder, evd_display_name_append);
57  }
58  return calculation_status;
59  }
shower::LArPandoraShowerAlg::DebugEVD
void DebugEVD(art::Ptr< recob::PFParticle > const &pfparticle, art::Event const &Event, const reco::shower::ShowerElementHolder &ShowerEleHolder, std::string const &evd_disp_name_append="") const
Definition: LArPandoraShowerAlg.cxx:602
ShowerRecoTools::IShowerTool::CalculateElement
virtual int CalculateElement(const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder)=0
ShowerRecoTools::IShowerTool::GetLArPandoraShowerAlg
const shower::LArPandoraShowerAlg & GetLArPandoraShowerAlg() const
Definition: IShowerTool.h:82
void ShowerRecoTools::IShowerTool::SetPtr ( art::ProducesCollector *  collector)
inline

Definition at line 65 of file IShowerTool.h.

65 { collectorPtr = collector; }
ShowerRecoTools::IShowerTool::collectorPtr
art::ProducesCollector * collectorPtr
Definition: IShowerTool.h:97

Member Data Documentation

art::ProducesCollector* ShowerRecoTools::IShowerTool::collectorPtr
private

Definition at line 97 of file IShowerTool.h.

shower::LArPandoraShowerAlg ShowerRecoTools::IShowerTool::fLArPandoraShowerAlg
private

Definition at line 92 of file IShowerTool.h.

bool ShowerRecoTools::IShowerTool::fRunEventDisplay
private

Definition at line 95 of file IShowerTool.h.

reco::shower::ShowerProducedPtrsHolder* ShowerRecoTools::IShowerTool::UniquePtrs
private

Definition at line 85 of file IShowerTool.h.

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