ShowerRecoTools::ShowerNumElectronsEnergy Class Reference

Inheritance diagram for ShowerRecoTools::ShowerNumElectronsEnergy:

Public Member Functions
	ShowerNumElectronsEnergy (const fhicl::ParameterSet &pset)
int	CalculateElement (const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerElementHolder) override

Private Member Functions
double	CalculateEnergy (const detinfo::DetectorClocksData &clockData, const detinfo::DetectorPropertiesData &detProp, const std::vector< art::Ptr< recob::Hit >> &hits, const geo::PlaneID::PlaneID_t plane) const
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)
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
art::InputTag	fPFParticleLabel
int	fVerbose
std::string	fShowerEnergyOutputLabel
std::string	fShowerBestPlaneOutputLabel
art::ServiceHandle< geo::Geometry >	fGeom
calo::CalorimetryAlg	fCalorimetryAlg
double	fRecombinationFactor

Detailed Description

Definition at line 28 of file ShowerNumElectronsEnergy_tool.cc.

Constructor & Destructor Documentation

ShowerRecoTools::ShowerNumElectronsEnergy::ShowerNumElectronsEnergy

(

const fhicl::ParameterSet &

pset

)

Definition at line 58 of file ShowerNumElectronsEnergy_tool.cc.

    : IShowerTool(pset.get<fhicl::ParameterSet>("BaseTools"))
    , fPFParticleLabel(pset.get<art::InputTag>("PFParticleLabel"))
    , fVerbose(pset.get<int>("Verbose"))
    , fShowerEnergyOutputLabel(pset.get<std::string>("ShowerEnergyOutputLabel"))
    , fShowerBestPlaneOutputLabel(pset.get<std::string>("ShowerBestPlaneOutputLabel"))
    , fCalorimetryAlg(pset.get<fhicl::ParameterSet>("CalorimetryAlg"))
    , fRecombinationFactor(pset.get<double>("RecombinationFactor"))
  {}

Member Function Documentation

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

inlinevirtualinherited

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

Definition at line 74 of file IShowerTool.h.

    {
      return 0;
    }

template<class T , class A , class B >

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

inlineprotectedinherited

Definition at line 152 of file IShowerTool.h.

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

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

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

overridevirtual

Implements ShowerRecoTools::IShowerTool.

Definition at line 68 of file ShowerNumElectronsEnergy_tool.cc.

References CalculateEnergy(), util::end(), fGeom, fPFParticleLabel, fShowerBestPlaneOutputLabel, fShowerEnergyOutputLabel, fVerbose, reco::shower::ShowerElementHolder::GetFindManyP(), art::ProductRetriever::getValidHandle(), hits(), art::Ptr< T >::key(), geo::GeometryCore::Nplanes(), and reco::shower::ShowerElementHolder::SetElement().

  {

    if (fVerbose)
      std::cout
        << "~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Shower Reco Energy Tool ~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
        << std::endl;

    // Get the assocated pfParicle vertex PFParticles
    auto const pfpHandle = Event.getValidHandle<std::vector<recob::PFParticle>>(fPFParticleLabel);

    //Get the clusters
    auto const clusHandle = Event.getValidHandle<std::vector<recob::Cluster>>(fPFParticleLabel);

    const art::FindManyP<recob::Cluster>& fmc =
      ShowerEleHolder.GetFindManyP<recob::Cluster>(pfpHandle, Event, fPFParticleLabel);
    // art::FindManyP<recob::Cluster> fmc(pfpHandle, Event, fPFParticleLabel);
    std::vector<art::Ptr<recob::Cluster>> clusters = fmc.at(pfparticle.key());

    //Get the hit association
    const art::FindManyP<recob::Hit>& fmhc =
      ShowerEleHolder.GetFindManyP<recob::Hit>(clusHandle, Event, fPFParticleLabel);
    // art::FindManyP<recob::Hit> fmhc(clusHandle, Event, fPFParticleLabel);

    std::map<geo::PlaneID::PlaneID_t, std::vector<art::Ptr<recob::Hit>>> planeHits;

    //Loop over the clusters in the plane and get the hits
    for (auto const& cluster : clusters) {

      //Get the hits
      std::vector<art::Ptr<recob::Hit>> hits = fmhc.at(cluster.key());

      //Get the plane.
      const geo::PlaneID::PlaneID_t plane(cluster->Plane().Plane);

      planeHits[plane].insert(planeHits[plane].end(), hits.begin(), hits.end());
    }

    // Calculate the energy for each plane && best plane
    geo::PlaneID::PlaneID_t bestPlane = std::numeric_limits<geo::PlaneID::PlaneID_t>::max();
    unsigned int bestPlaneNumHits = 0;

    //Holder for the final product
    std::vector<double> energyVec(fGeom->Nplanes(), -999.);
    std::vector<double> energyError(fGeom->Nplanes(), -999.);

    auto const clockData =
      art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(Event);
    auto const detProp =
      art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(Event, clockData);

    for (auto const& [plane, hits] : planeHits) {

      unsigned int planeNumHits = hits.size();

      //Calculate the Energy for
      double Energy = CalculateEnergy(clockData, detProp, hits, plane);
      // If the energy is negative, leave it at -999
      if (Energy > 0) energyVec.at(plane) = Energy;

      if (planeNumHits > bestPlaneNumHits) {
        bestPlane = plane;
        bestPlaneNumHits = planeNumHits;
      }
    }

    ShowerEleHolder.SetElement(energyVec, energyError, fShowerEnergyOutputLabel);
    // Only set the best plane if it has some hits in it
    if (bestPlane < fGeom->Nplanes()) {
      // Need to cast as an int for legacy default of -999
      // have to define a new variable as we pass-by-reference when filling
      int bestPlaneVal(bestPlane);
      ShowerEleHolder.SetElement(bestPlaneVal, fShowerBestPlaneOutputLabel);
    }

    return 0;
  }

double ShowerRecoTools::ShowerNumElectronsEnergy::CalculateEnergy ( const detinfo::DetectorClocksData &  clockData, const detinfo::DetectorPropertiesData &  detProp, const std::vector< art::Ptr< recob::Hit >> &  hits, const geo::PlaneID::PlaneID_t  plane  ) const

private

Definition at line 149 of file ShowerNumElectronsEnergy_tool.cc.

References DEFINE_ART_CLASS_TOOL, calo::CalorimetryAlg::ElectronsFromADCArea(), fCalorimetryAlg, fRecombinationFactor, hits(), util::kGeVToElectrons, and calo::CalorimetryAlg::LifetimeCorrection().

Referenced by CalculateElement().

  {

    double totalCharge = 0;
    double totalEnergy = 0;
    double correctedtotalCharge = 0;
    double nElectrons = 0;

    for (auto const& hit : hits) {
      totalCharge +=
        hit->Integral() *
        fCalorimetryAlg.LifetimeCorrection(
          clockData, detProp, hit->PeakTime()); // obtain charge and correct for lifetime
    }

    // correct charge due to recombination
    correctedtotalCharge = totalCharge / fRecombinationFactor;
    // calculate # of electrons and the corresponding energy
    nElectrons = fCalorimetryAlg.ElectronsFromADCArea(correctedtotalCharge, plane);
    totalEnergy = (nElectrons / util::kGeVToElectrons) * 1000; // energy in MeV
    return totalEnergy;
  }

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

inlineprotectedinherited

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

    {
      return fLArPandoraShowerAlg;
    };

template<class T >

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

inlineprotectedinherited

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

    {

      //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 )

inlineprotectedinherited

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

{ return UniquePtrs->GetVectorPtrSize(Name); }

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

inlineinherited

Definition at line 68 of file IShowerTool.h.

    {
      UniquePtrs = &uniqueproducerPtrs;
    }

virtual void ShowerRecoTools::IShowerTool::InitialiseProducers ( )

inlinevirtualinherited

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

Definition at line 62 of file IShowerTool.h.

{}

template<class T >

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

inlineprotectedinherited

Definition at line 137 of file IShowerTool.h.

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

    {

      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 )

inlineprotectedinherited

Definition at line 162 of file IShowerTool.h.

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

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

{ UniquePtrs->PrintPtr(Name); }

void ShowerRecoTools::IShowerTool::PrintPtrs ( )

inlineprotectedinherited

Definition at line 160 of file IShowerTool.h.

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

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

{ 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 = ""  )

inlineinherited

Definition at line 46 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 )

inlineinherited

Definition at line 65 of file IShowerTool.h.

{ collectorPtr = collector; }

Member Data Documentation

calo::CalorimetryAlg ShowerRecoTools::ShowerNumElectronsEnergy::fCalorimetryAlg

private

Definition at line 52 of file ShowerNumElectronsEnergy_tool.cc.

Referenced by CalculateEnergy().

art::ServiceHandle<geo::Geometry> ShowerRecoTools::ShowerNumElectronsEnergy::fGeom

private

Definition at line 51 of file ShowerNumElectronsEnergy_tool.cc.

Referenced by CalculateElement().

art::InputTag ShowerRecoTools::ShowerNumElectronsEnergy::fPFParticleLabel

private

Definition at line 44 of file ShowerNumElectronsEnergy_tool.cc.

Referenced by CalculateElement().

double ShowerRecoTools::ShowerNumElectronsEnergy::fRecombinationFactor

private

Definition at line 55 of file ShowerNumElectronsEnergy_tool.cc.

Referenced by CalculateEnergy().

std::string ShowerRecoTools::ShowerNumElectronsEnergy::fShowerBestPlaneOutputLabel

private

Definition at line 48 of file ShowerNumElectronsEnergy_tool.cc.

Referenced by CalculateElement().

std::string ShowerRecoTools::ShowerNumElectronsEnergy::fShowerEnergyOutputLabel

private

Definition at line 47 of file ShowerNumElectronsEnergy_tool.cc.

Referenced by CalculateElement().

int ShowerRecoTools::ShowerNumElectronsEnergy::fVerbose

private

Definition at line 45 of file ShowerNumElectronsEnergy_tool.cc.

Referenced by CalculateElement().

---

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

• larpandora/v09_22_05/source/larpandora/LArPandoraEventBuilding/LArPandoraShower/Tools/ShowerNumElectronsEnergy_tool.cc