LArSoft  v10_04_05
Liquid Argon Software toolkit - https://larsoft.org/
ShowerRecoTools::ShowerLinearEnergy Class Reference
Inheritance diagram for ShowerRecoTools::ShowerLinearEnergy:
ShowerRecoTools::IShowerTool

Public Member Functions

 ShowerLinearEnergy (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::LArPandoraShowerAlgGetLArPandoraShowerAlg () 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

unsigned int fNumPlanes
 
std::vector< double > fGradients
 
std::vector< double > fIntercepts
 
art::InputTag fPFParticleLabel
 
int fVerbose
 
std::string fShowerEnergyOutputLabel
 
std::string fShowerBestPlaneOutputLabel
 
geo::WireReadoutGeom const & fChannelMap = art::ServiceHandle<geo::WireReadout>()->Get()
 

Detailed Description

Definition at line 24 of file ShowerLinearEnergy_tool.cc.

Constructor & Destructor Documentation

ShowerRecoTools::ShowerLinearEnergy::ShowerLinearEnergy ( const fhicl::ParameterSet pset)

Definition at line 55 of file ShowerLinearEnergy_tool.cc.

References fChannelMap, fGradients, fIntercepts, fNumPlanes, and geo::WireReadoutGeom::Nplanes().

56  : IShowerTool(pset.get<fhicl::ParameterSet>("BaseTools"))
57  , fGradients(pset.get<std::vector<double>>("Gradients"))
58  , fIntercepts(pset.get<std::vector<double>>("Intercepts"))
59  , fPFParticleLabel(pset.get<art::InputTag>("PFParticleLabel"))
60  , fVerbose(pset.get<int>("Verbose"))
61  , fShowerEnergyOutputLabel(pset.get<std::string>("ShowerEnergyOutputLabel"))
62  , fShowerBestPlaneOutputLabel(pset.get<std::string>("ShowerBestPlaneOutputLabel"))
63  {
65  if (fNumPlanes != fGradients.size() || fNumPlanes != fIntercepts.size()) {
66  throw cet::exception("ShowerLinearEnergy")
67  << "The number of planes does not match the size of the fcl parametes passed: Num Planes: "
68  << fNumPlanes << ", Gradients size: " << fGradients.size()
69  << ", Intercpts size: " << fIntercepts.size();
70  }
71  }
T get(std::string const &key) const
Definition: ParameterSet.h:314
geo::WireReadoutGeom const & fChannelMap
unsigned int Nplanes(TPCID const &tpcid=details::tpc_zero) const
Returns the total number of planes in the specified TPC.
IShowerTool(const fhicl::ParameterSet &pset)
Definition: IShowerTool.h:31
cet::coded_exception< error, detail::translate > exception
Definition: exception.h:33

Member Function Documentation

virtual int ShowerRecoTools::IShowerTool::AddAssociations ( const art::Ptr< recob::PFParticle > &  pfpPtr,
art::Event Event,
reco::shower::ShowerElementHolder ShowerEleHolder 
)
inlinevirtualinherited
template<class T , class A , class B >
void ShowerRecoTools::IShowerTool::AddSingle ( A &  a,
B &  b,
std::string  Name 
)
inlineprotectedinherited

Definition at line 150 of file IShowerTool.h.

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

151  {
152  UniquePtrs->AddSingle<T>(a, b, Name);
153  }
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:83
void AddSingle(A &a, B &b, const std::string &Name)
int ShowerRecoTools::ShowerLinearEnergy::CalculateElement ( const art::Ptr< recob::PFParticle > &  pfparticle,
art::Event Event,
reco::shower::ShowerElementHolder ShowerElementHolder 
)
overridevirtual

Implements ShowerRecoTools::IShowerTool.

Definition at line 73 of file ShowerLinearEnergy_tool.cc.

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

76  {
77 
78  // Get the assocated pfParicle vertex PFParticles
79  auto const pfpHandle = Event.getValidHandle<std::vector<recob::PFParticle>>(fPFParticleLabel);
80 
81  //Get the clusters
82  auto const clusHandle = Event.getValidHandle<std::vector<recob::Cluster>>(fPFParticleLabel);
83 
85  ShowerEleHolder.GetFindManyP<recob::Cluster>(pfpHandle, Event, fPFParticleLabel);
86  // art::FindManyP<recob::Cluster> fmc(pfpHandle, Event, fPFParticleLabel);
87  std::vector<art::Ptr<recob::Cluster>> clusters = fmc.at(pfparticle.key());
88 
89  //Get the hit association
90  const art::FindManyP<recob::Hit>& fmhc =
91  ShowerEleHolder.GetFindManyP<recob::Hit>(clusHandle, Event, fPFParticleLabel);
92  // art::FindManyP<recob::Hit> fmhc(clusHandle, Event, fPFParticleLabel);
93 
94  std::map<geo::PlaneID::PlaneID_t, std::vector<art::Ptr<recob::Hit>>> planeHits;
95 
96  //Loop over the clusters in the plane and get the hits
97  for (auto const& cluster : clusters) {
98 
99  //Get the hits
100  std::vector<art::Ptr<recob::Hit>> hits = fmhc.at(cluster.key());
101 
102  //Get the plane.
103  const geo::PlaneID::PlaneID_t plane(cluster->Plane().Plane);
104 
105  planeHits[plane].insert(planeHits[plane].end(), hits.begin(), hits.end());
106  }
107 
108  // Calculate the energy for each plane && best plane
109  geo::PlaneID::PlaneID_t bestPlane = std::numeric_limits<geo::PlaneID::PlaneID_t>::max();
110  unsigned int bestPlaneNumHits = 0;
111 
112  //Holder for the final product
113  std::vector<double> energyVec(fNumPlanes, -999.);
114  std::vector<double> energyError(fNumPlanes, -999.);
115 
116  auto const clockData =
118  auto const detProp =
120 
121  for (auto const& [plane, hits] : planeHits) {
122 
123  unsigned int planeNumHits = hits.size();
124 
125  //Calculate the Energy for
126  double Energy = CalculateEnergy(clockData, detProp, hits, plane);
127  // If the energy is negative, leave it at -999
128  if (Energy > 0) energyVec.at(plane) = Energy;
129 
130  if (planeNumHits > bestPlaneNumHits) {
131  bestPlane = plane;
132  bestPlaneNumHits = planeNumHits;
133  }
134  }
135 
136  ShowerEleHolder.SetElement(energyVec, energyError, fShowerEnergyOutputLabel);
137  // Only set the best plane if it has some hits in it
138  if (bestPlane < fChannelMap.Nplanes()) {
139  // Need to cast as an int for legacy default of -999
140  // have to define a new variable as we pass-by-reference when filling
141  int bestPlaneVal(bestPlane);
142  ShowerEleHolder.SetElement(bestPlaneVal, fShowerBestPlaneOutputLabel);
143  }
144 
145  return 0;
146  }
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
unsigned int PlaneID_t
Type for the ID number.
Definition: geo_types.h:365
Set of hits with a 2D structure.
Definition: Cluster.h:69
Cluster finding and building.
decltype(auto) constexpr end(T &&obj)
ADL-aware version of std::end.
Definition: StdUtils.h:77
void hits()
Definition: readHits.C:15
key_type key() const noexcept
Definition: Ptr.h:166
geo::WireReadoutGeom const & fChannelMap
unsigned int Nplanes(TPCID const &tpcid=details::tpc_zero) const
Returns the total number of planes in the specified TPC.
ValidHandle< PROD > getValidHandle(InputTag const &tag) const
2D representation of charge deposited in the TDC/wire plane
Definition: Hit.h:46
double ShowerRecoTools::ShowerLinearEnergy::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 150 of file ShowerLinearEnergy_tool.cc.

References DEFINE_ART_CLASS_TOOL, detinfo::DetectorPropertiesData::ElectronLifetime(), fGradients, fIntercepts, hits(), and detinfo::sampling_rate().

Referenced by CalculateElement().

154  {
155 
156  double totalCharge = 0, totalEnergy = 0;
157 
158  for (auto const& hit : hits) {
159  totalCharge += (hit->Integral() * std::exp((sampling_rate(clockData) * hit->PeakTime()) /
160  (detProp.ElectronLifetime() * 1e3)));
161  }
162 
163  totalEnergy = (totalCharge * fGradients.at(plane)) + fIntercepts.at(plane);
164 
165  return totalEnergy;
166  }
Detector simulation of raw signals on wires.
double sampling_rate(DetectorClocksData const &data)
Returns the period of the TPC readout electronics clock.
const shower::LArPandoraShowerAlg& ShowerRecoTools::IShowerTool::GetLArPandoraShowerAlg ( ) const
inlineprotectedinherited

Definition at line 80 of file IShowerTool.h.

Referenced by ShowerRecoTools::ShowerLengthPercentile::CalculateElement(), ShowerRecoTools::Shower3DCylinderTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerPCAPropergationStartPosition::CalculateElement(), ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerPFPVertexStartPosition::CalculateElement(), ShowerRecoTools::ShowerUnidirectiondEdx::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().

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

Definition at line 100 of file IShowerTool.h.

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

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

Definition at line 66 of file IShowerTool.h.

67  {
68  UniquePtrs = &uniqueproducerPtrs;
69  }
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:83
virtual void ShowerRecoTools::IShowerTool::InitialiseProducers ( )
inlinevirtualinherited
template<class T >
void ShowerRecoTools::IShowerTool::InitialiseProduct ( std::string  Name,
std::string  InstanceName = "" 
)
inlineprotectedinherited

Definition at line 135 of file IShowerTool.h.

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

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

Definition at line 160 of file IShowerTool.h.

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

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

160 { UniquePtrs->PrintPtr(Name); }
reco::shower::ShowerProducedPtrsHolder * UniquePtrs
Definition: IShowerTool.h:83
void PrintPtr(const std::string &Name) const
void ShowerRecoTools::IShowerTool::PrintPtrs ( )
inlineprotectedinherited
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 44 of file IShowerTool.h.

48  {
49 
50  int calculation_status = CalculateElement(pfparticle, Event, ShowerEleHolder);
51  if (calculation_status != 0) return calculation_status;
52  if (fRunEventDisplay) {
54  pfparticle, Event, ShowerEleHolder, evd_display_name_append);
55  }
56  return calculation_status;
57  }
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
virtual int CalculateElement(const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder)=0
const shower::LArPandoraShowerAlg & GetLArPandoraShowerAlg() const
Definition: IShowerTool.h:80
void ShowerRecoTools::IShowerTool::SetPtr ( art::ProducesCollector collector)
inlineinherited

Definition at line 63 of file IShowerTool.h.

63 { collectorPtr = collector; }
art::ProducesCollector * collectorPtr
Definition: IShowerTool.h:95

Member Data Documentation

geo::WireReadoutGeom const& ShowerRecoTools::ShowerLinearEnergy::fChannelMap = art::ServiceHandle<geo::WireReadout>()->Get()
private

Definition at line 52 of file ShowerLinearEnergy_tool.cc.

Referenced by CalculateElement(), and ShowerLinearEnergy().

std::vector<double> ShowerRecoTools::ShowerLinearEnergy::fGradients
private

Definition at line 42 of file ShowerLinearEnergy_tool.cc.

Referenced by CalculateEnergy(), and ShowerLinearEnergy().

std::vector<double> ShowerRecoTools::ShowerLinearEnergy::fIntercepts
private

Definition at line 43 of file ShowerLinearEnergy_tool.cc.

Referenced by CalculateEnergy(), and ShowerLinearEnergy().

unsigned int ShowerRecoTools::ShowerLinearEnergy::fNumPlanes
private

Definition at line 41 of file ShowerLinearEnergy_tool.cc.

Referenced by CalculateElement(), and ShowerLinearEnergy().

art::InputTag ShowerRecoTools::ShowerLinearEnergy::fPFParticleLabel
private

Definition at line 45 of file ShowerLinearEnergy_tool.cc.

Referenced by CalculateElement().

std::string ShowerRecoTools::ShowerLinearEnergy::fShowerBestPlaneOutputLabel
private

Definition at line 49 of file ShowerLinearEnergy_tool.cc.

Referenced by CalculateElement().

std::string ShowerRecoTools::ShowerLinearEnergy::fShowerEnergyOutputLabel
private

Definition at line 48 of file ShowerLinearEnergy_tool.cc.

Referenced by CalculateElement().

int ShowerRecoTools::ShowerLinearEnergy::fVerbose
private

Definition at line 46 of file ShowerLinearEnergy_tool.cc.


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