ShowerRecoTools::IShowerTool Class Reference

#include <IShowerTool.h>

Inheritance diagram for ShowerRecoTools::IShowerTool:

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 25 of file IShowerTool.h.

Constructor & Destructor Documentation

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

inline

Definition at line 28 of file IShowerTool.h.

      : fLArPandoraShowerAlg(pset.get<fhicl::ParameterSet>("LArPandoraShowerAlg"))
      , fRunEventDisplay(pset.get<bool>("EnableEventDisplay")){};

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 78 of file IShowerTool.h.

    {
      return 0;
    }

template<class T , class A , class B >

void ShowerRecoTools::IShowerTool::AddSingle ( A &  a, B &  b, std::string  Name  )

inlineprotected

Definition at line 160 of file IShowerTool.h.

    {
      UniquePtrs->AddSingle<T>(a, b, Name);
    }

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

pure virtual

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

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

inlineprotected

Definition at line 87 of file IShowerTool.h.

    {
      return fLArPandoraShowerAlg;
    };

template<class T >

art::Ptr<T> ShowerRecoTools::IShowerTool::GetProducedElementPtr ( std::string  Name, reco::shower::ShowerElementHolder &  ShowerEleHolder, int  iter = -1  )

inlineprotected

Definition at line 108 of file IShowerTool.h.

    {

      //Check the element has been set
      bool check_element = ShowerEleHolder.CheckElement(Name);
      if (!check_element) {
        throw cet::exception("IShowerTool") << "tried to get a element that does not exist. Failed "
                                               "at making the art ptr for Element: "
                                            << Name << std::endl;
      }

      //Check the unique ptr has been set.
      bool check_ptr = UniquePtrs->CheckUniqueProduerPtr(Name);
      if (!check_ptr) {
        throw cet::exception("IShowerTool")
          << "tried to get a ptr that does not exist. Failed at making the art ptr for Element"
          << Name;
      }

      //Check if the user has defined an index if not just use the current shower index/
      int index;
      if (iter != -1) { index = iter; }
      else {
        index = ShowerEleHolder.GetShowerNumber();
      }

      //Make the ptr
      return UniquePtrs->GetArtPtr<T>(Name, index);
    }

int ShowerRecoTools::IShowerTool::GetVectorPtrSize ( std::string  Name )

inlineprotected

Definition at line 167 of file IShowerTool.h.

    {
      return UniquePtrs->GetVectorPtrSize(Name);
    }

void ShowerRecoTools::IShowerTool::InitaliseProducerPtr ( reco::shower::ShowerProducedPtrsHolder &  uniqueproducerPtrs )

inline

Definition at line 71 of file IShowerTool.h.

    {
      UniquePtrs = &uniqueproducerPtrs;
    }

virtual void ShowerRecoTools::IShowerTool::InitialiseProducers ( )

inlinevirtual

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

Definition at line 59 of file IShowerTool.h.

    {}

template<class T >

void ShowerRecoTools::IShowerTool::InitialiseProduct ( std::string  Name, std::string  InstanceName = ""  )

inlineprotected

Definition at line 144 of file IShowerTool.h.

    {

      if (collectorPtr == nullptr) {
        mf::LogWarning("IShowerTool") << "The art::ProducesCollector ptr has not been set";
        return;
      }

      collectorPtr->produces<T>(InstanceName);
      UniquePtrs->SetShowerUniqueProduerPtr(type<T>(), Name, InstanceName);
    }

void ShowerRecoTools::IShowerTool::PrintPtr ( std::string  Name )

inlineprotected

Definition at line 179 of file IShowerTool.h.

    {
      UniquePtrs->PrintPtr(Name);
    }

void ShowerRecoTools::IShowerTool::PrintPtrs ( )

inlineprotected

Definition at line 173 of file IShowerTool.h.

    {
      UniquePtrs->PrintPtrs();
    }

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 42 of file IShowerTool.h.

    {

      int calculation_status = CalculateElement(pfparticle, Event, ShowerEleHolder);
      if (calculation_status != 0) return calculation_status;
      if (fRunEventDisplay) {
        IShowerTool::GetLArPandoraShowerAlg().DebugEVD(
          pfparticle, Event, ShowerEleHolder, evd_display_name_append);
      }
      return calculation_status;
    }

void ShowerRecoTools::IShowerTool::SetPtr ( art::ProducesCollector *  collector )

inline

Definition at line 64 of file IShowerTool.h.

    {
      collectorPtr = collector;
    }

Member Data Documentation

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

private

Definition at line 102 of file IShowerTool.h.

shower::LArPandoraShowerAlg ShowerRecoTools::IShowerTool::fLArPandoraShowerAlg

private

Definition at line 97 of file IShowerTool.h.

bool ShowerRecoTools::IShowerTool::fRunEventDisplay

private

Definition at line 100 of file IShowerTool.h.

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

private

Definition at line 90 of file IShowerTool.h.

---

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

• larpandora/larpandora/LArPandoraEventBuilding/LArPandoraShower/Tools/IShowerTool.h