LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
calo::GeneralCalorimetry Class Reference
Inheritance diagram for calo::GeneralCalorimetry:
art::EDProducer art::ProducerBase art::Consumer art::EngineCreator art::ProductRegistryHelper

Public Types

using ModuleType = EDProducer
 
using WorkerType = WorkerT< EDProducer >
 
template<typename UserConfig , typename KeysToIgnore = void>
using Table = ProducerBase::Table< UserConfig, KeysToIgnore >
 

Public Member Functions

 GeneralCalorimetry (fhicl::ParameterSet const &pset)
 
void reconfigure (fhicl::ParameterSet const &pset)
 
void produce (art::Event &evt)
 
template<typename PROD , BranchType B = InEvent>
ProductID getProductID (std::string const &instanceName={}) const
 
template<typename PROD , BranchType B>
ProductID getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const
 
bool modifiesEvent () const
 
template<typename T , BranchType = InEvent>
ProductToken< T > consumes (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< T > consumes (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ViewToken< T > consumesView (InputTag const &it)
 
template<typename T , BranchType = InEvent>
ProductToken< T > mayConsume (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ProductToken< T > mayConsume (InputTag const &it)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , art::BranchType BT>
art::ViewToken< T > mayConsumeView (InputTag const &it)
 
base_engine_tcreateEngine (seed_t seed)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)
 
seed_t get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)
 

Static Public Member Functions

static cet::exempt_ptr< Consumernon_module_context ()
 

Protected Member Functions

CurrentProcessingContext const * currentContext () const
 
void validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
 
void prepareForJob (fhicl::ParameterSet const &pset)
 
void showMissingConsumes () const
 

Private Attributes

std::string fTrackModuleLabel
 module creating the track objects and assns to hits More...
 
double fADCToElectrons
 filled using the detinfo::DetectorPropertiesService service More...
 
geo::View_t fCollectionView
 view of the collection plane More...
 
unsigned int fCollectionPlane
 plane of the collection plane More...
 
art::ServiceHandle< geo::GeometryfGeo
 
CalorimetryAlg caloAlg
 

Detailed Description

Definition at line 47 of file GeneralCalorimetry_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer
inherited

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>
using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>
inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>
inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

calo::GeneralCalorimetry::GeneralCalorimetry ( fhicl::ParameterSet const &  pset)
explicit

Definition at line 72 of file GeneralCalorimetry_module.cc.

References fADCToElectrons, fCollectionPlane, fCollectionView, fGeo, geo::kCollection, geo::GeometryCore::Nplanes(), reconfigure(), geo::GeometryCore::SignalType(), and geo::GeometryCore::View().

74  , fCollectionPlane(0)
75  , caloAlg(pset.get< fhicl::ParameterSet >("CaloAlg"))
76 {
77  auto const* dp = lar::providerFrom<detinfo::DetectorPropertiesService>();
78  fADCToElectrons = 1./dp->ElectronsToADC();
79 
80  // determine the view of the collection plane
81  // just look at one cryostat, the first TPC and loop over those
82  // planes
83  geo::TPCID FirstTPC(0, 0);
84  for(unsigned int p = 0; p < fGeo->Nplanes(FirstTPC); ++p){
85  geo::PlaneID planeid{ FirstTPC, p };
86  if(fGeo->SignalType(planeid) == geo::kCollection){
87  fCollectionView = fGeo->View(planeid);
88  fCollectionPlane = p;
89  }
90  }
91 
92  this->reconfigure(pset);
93 
94  produces< std::vector<anab::Calorimetry> >();
95  produces< art::Assns<recob::Track, anab::Calorimetry> >();
96 }
double fADCToElectrons
filled using the detinfo::DetectorPropertiesService service
Unknown view.
Definition: geo_types.h:83
The data type to uniquely identify a Plane.
Definition: geo_types.h:250
SigType_t SignalType(geo::PlaneID const &pid) const
Returns the type of signal on the channels of specified TPC plane.
unsigned int Nplanes(unsigned int tpc=0, unsigned int cstat=0) const
Returns the total number of wire planes in the specified TPC.
geo::View_t fCollectionView
view of the collection plane
void reconfigure(fhicl::ParameterSet const &pset)
The data type to uniquely identify a TPC.
Definition: geo_types.h:195
View_t View(geo::PlaneID const &pid) const
Returns the view (wire orientation) on the channels of specified TPC plane.
unsigned int fCollectionPlane
plane of the collection plane
art::ServiceHandle< geo::Geometry > fGeo
Signal from collection planes.
Definition: geo_types.h:93

Member Function Documentation

template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::consumes ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it)
inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

148 {
149  if (!moduleContext_)
150  return ProductToken<T>::invalid();
151 
152  consumables_[BT].emplace_back(ConsumableType::Product,
153  TypeID{typeid(T)},
154  it.label(),
155  it.instance(),
156  it.process());
157  return ProductToken<T>{it};
158 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename T , art::BranchType BT>
void art::Consumer::consumesMany ( )
inherited

Definition at line 162 of file Consumer.h.

163 {
164  if (!moduleContext_)
165  return;
166 
167  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
168 }
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::consumesView ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it)
inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

173 {
174  if (!moduleContext_)
175  return ViewToken<T>::invalid();
176 
177  consumables_[BT].emplace_back(ConsumableType::ViewElement,
178  TypeID{typeid(T)},
179  it.label(),
180  it.instance(),
181  it.process());
182  return ViewToken<T>{it};
183 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed,
std::string const &  kind_of_engine_to_make 
)
inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

34 {
35  return rng()->createEngine(
36  placeholder_schedule_id(), seed, kind_of_engine_to_make);
37 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed,
std::string const &  kind_of_engine_to_make,
label_t const &  engine_label 
)
inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

43 {
44  return rng()->createEngine(
45  placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
46 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
CurrentProcessingContext const * art::EDProducer::currentContext ( ) const
protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

121  {
122  return current_context_.get();
123  }
CPC_exempt_ptr current_context_
Definition: EDProducer.h:116
EngineCreator::seed_t EngineCreator::get_seed_value ( fhicl::ParameterSet const &  pset,
char const  key[] = "seed",
seed_t const  implicit_seed = -1 
)
inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

52 {
53  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
54  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
55 }
template<typename PROD , BranchType B>
ProductID art::EDProducer::getProductID ( std::string const &  instanceName = {}) const
inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::moduleDescription_.

124  {
125  return ProducerBase::getProductID<PROD, B>(moduleDescription_,
126  instanceName);
127  }
ModuleDescription moduleDescription_
Definition: EDProducer.h:115
template<typename PROD , BranchType B>
ProductID art::ProducerBase::getProductID ( ModuleDescription const &  moduleDescription,
std::string const &  instanceName 
) const
inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

58  {
59  auto const& pd =
60  get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
61  return pd.productID();
62  }
Int_t B
Definition: plot.C:25
template<typename T , BranchType = InEvent>
ProductToken<T> art::Consumer::mayConsume ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it)
inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

191 {
192  if (!moduleContext_)
193  return ProductToken<T>::invalid();
194 
195  consumables_[BT].emplace_back(ConsumableType::Product,
196  TypeID{typeid(T)},
197  it.label(),
198  it.instance(),
199  it.process());
200  return ProductToken<T>{it};
201 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename T , art::BranchType BT>
void art::Consumer::mayConsumeMany ( )
inherited

Definition at line 205 of file Consumer.h.

206 {
207  if (!moduleContext_)
208  return;
209 
210  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
211 }
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const &  )
inherited
template<typename T , art::BranchType BT>
art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it)
inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

216 {
217  if (!moduleContext_)
218  return ViewToken<T>::invalid();
219 
220  consumables_[BT].emplace_back(ConsumableType::ViewElement,
221  TypeID{typeid(T)},
222  it.label(),
223  it.instance(),
224  it.process());
225  return ViewToken<T>{it};
226 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
bool art::ProducerBase::modifiesEvent ( ) const
inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

41  {
42  return true;
43  }
void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset)
protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

90 {
91  if (!moduleContext_)
92  return;
93 
94  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
95  for (auto& consumablesPerBranch : consumables_) {
96  cet::sort_all(consumablesPerBranch);
97  }
98 }
bool requireConsumes_
Definition: Consumer.h:137
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
void calo::GeneralCalorimetry::produce ( art::Event evt)
virtual

Implements art::EDProducer.

Definition at line 106 of file GeneralCalorimetry_module.cc.

References DEFINE_ART_MODULE.

107 {
108  /*************************************************************/
109  /* WARNING */
110  /*************************************************************/
111  /* The dQdx information in recob::Track has been deprecated */
112  /* since 2016 and in 11/2018 the recob::Track interface was */
113  /* changed and DQdxAtPoint and NumberdQdx were removed. */
114  /* Therefore the code below is now commented out */
115  /* (note that it was most likely not functional anyways). */
116  /* For any issue please contact: larsoft-team@fnal.gov */
117  /*************************************************************/
118  /*
119  art::Handle< std::vector<recob::Track> > trackHandle;
120  evt.getByLabel(fTrackModuleLabel, trackHandle);
121  std::vector< art::Ptr<recob::Track> > tracks;
122  art::fill_ptr_vector(tracks, trackHandle);
123 
124  auto const* dp = lar::providerFrom<detinfo::DetectorPropertiesService>();
125 
126  //create anab::Calorimetry objects and make association with recob::Track
127  std::unique_ptr< std::vector<anab::Calorimetry> > calorimetrycol(new std::vector<anab::Calorimetry>);
128  std::unique_ptr< art::Assns<recob::Track, anab::Calorimetry> > assn(new art::Assns<recob::Track, anab::Calorimetry>);
129 
130  art::FindMany<recob::Hit> fmht(trackHandle, evt, fTrackModuleLabel);
131 
132  // loop over the tracks
133  for(size_t t = 0; t < tracks.size(); ++t){
134 
135  art::Ptr<recob::Track> trk = tracks.at(t);
136 
137  double viewPitch = 0.;
138  try{
139  viewPitch = lar::util::TrackPitchInView(*trk, fCollectionView);
140  }
141  catch( cet::exception &e){
142  mf::LogWarning("GeneralCalorimetry") << "caught exception "
143  << e
144  << "\n pitch now set to 0";
145  }
146 
147  // loop over the track trajectory to get the kinetic energy,
148  // residual range and the dQdx
149  float kineticEnergy = 0.;
150  std::vector<float> vdEdx;
151  std::vector<float> vresRange;
152  std::vector<float> vdQdx;
153  std::vector<float> deadwire; //residual range for dead wires
154 
155  // Check that the number of trajectory points and number of dQdx for the
156  // collection view are the same
157  if( trk->NumberTrajectoryPoints() != trk->NumberdQdx(fCollectionView) )
158  throw cet::exception("GeneralCalorimetry") << "inconsistent number of track trajectory "
159  << " and dQdx points\n";
160 
161  if (trk->NumberTrajectoryPoints()>2){
162  for(size_t p = 1; p < trk->NumberTrajectoryPoints()-1; ++p){
163  if (!trk->DQdxAtPoint(p, fCollectionView)) continue;
164  vresRange.push_back(trk->Length(p));
165  vdQdx.push_back(trk->DQdxAtPoint(p, fCollectionView));
166  //vdEdx.push_back(vdQdx.back() * fADCToElectrons/util::kGeVToElectrons*1000);
167  vdEdx.push_back(caloAlg.dEdx_AMP(vdQdx.back(),
168  dp->ConvertXToTicks(trk->LocationAtPoint(p).X(),fCollectionPlane,0,0),
169  fCollectionPlane));
170  kineticEnergy += vdEdx.back(); // \todo should this be converted from electrons to energy?
171  std::cout<<vresRange.back()<<" "<<vdQdx.back()<<" "<<vdEdx.back()<<std::endl;
172  }
173 
174  geo::PlaneID planeID(0,0,fCollectionPlane);
175  calorimetrycol->push_back(anab::Calorimetry(kineticEnergy,
176  vdEdx,
177  vdQdx,
178  vresRange,
179  deadwire,
180  trk->Length(),
181  viewPitch,
182  planeID));
183 
184  util::CreateAssn(*this, evt, *calorimetrycol, trk, *assn);
185 
186  }
187  }// end of loop over all tracks
188 
189  if (calorimetrycol->size()){
190  evt.put(std::move(calorimetrycol));
191  evt.put(std::move(assn));
192  }
193 
194  */
195  /*************************************************************/
196  return;
197 }
void calo::GeneralCalorimetry::reconfigure ( fhicl::ParameterSet const &  pset)

Definition at line 99 of file GeneralCalorimetry_module.cc.

References fTrackModuleLabel, and fhicl::ParameterSet::get().

Referenced by GeneralCalorimetry().

100 {
101  fTrackModuleLabel = pset.get< std::string >("TrackModuleLabel");
102  return;
103 }
std::string fTrackModuleLabel
module creating the track objects and assns to hits
void art::Consumer::showMissingConsumes ( ) const
protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

126 {
127  if (!moduleContext_)
128  return;
129 
130  // If none of the branches have missing consumes statements, exit early.
131  if (std::all_of(cbegin(missingConsumes_),
132  cend(missingConsumes_),
133  [](auto const& perBranch) { return perBranch.empty(); }))
134  return;
135 
136  constexpr cet::HorizontalRule rule{60};
137  mf::LogPrint log{"MTdiagnostics"};
138  log << '\n'
139  << rule('=') << '\n'
140  << "The following consumes (or mayConsume) statements are missing from\n"
141  << module_context(moduleDescription_) << '\n'
142  << rule('-') << '\n';
143 
144  cet::for_all_with_index(
145  missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
146  for (auto const& pi : perBranch) {
147  log << " "
148  << assemble_consumes_statement(static_cast<BranchType>(i), pi)
149  << '\n';
150  }
151  });
152  log << rule('=');
153 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
bool moduleContext_
Definition: Consumer.h:136
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139
void art::Consumer::validateConsumedProduct ( BranchType const  bt,
ProductInfo const &  pi 
)
protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

103 {
104  // Early exits if consumes tracking has been disabled or if the
105  // consumed product is an allowed consumable.
106  if (!moduleContext_)
107  return;
108 
109  if (cet::binary_search_all(consumables_[bt], pi))
110  return;
111 
112  if (requireConsumes_) {
114  "Consumer: an error occurred during validation of a "
115  "retrieved product\n\n")
116  << "The following consumes (or mayConsume) statement is missing from\n"
117  << module_context(moduleDescription_) << ":\n\n"
118  << " " << assemble_consumes_statement(bt, pi) << "\n\n";
119  }
120 
121  missingConsumes_[bt].insert(pi);
122 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
bool requireConsumes_
Definition: Consumer.h:137
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139

Member Data Documentation

CalorimetryAlg calo::GeneralCalorimetry::caloAlg
private

Definition at line 64 of file GeneralCalorimetry_module.cc.

double calo::GeneralCalorimetry::fADCToElectrons
private

filled using the detinfo::DetectorPropertiesService service

Definition at line 59 of file GeneralCalorimetry_module.cc.

Referenced by GeneralCalorimetry().

unsigned int calo::GeneralCalorimetry::fCollectionPlane
private

plane of the collection plane

Definition at line 61 of file GeneralCalorimetry_module.cc.

Referenced by GeneralCalorimetry().

geo::View_t calo::GeneralCalorimetry::fCollectionView
private

view of the collection plane

Definition at line 60 of file GeneralCalorimetry_module.cc.

Referenced by GeneralCalorimetry().

art::ServiceHandle<geo::Geometry> calo::GeneralCalorimetry::fGeo
private

Definition at line 62 of file GeneralCalorimetry_module.cc.

Referenced by GeneralCalorimetry().

std::string calo::GeneralCalorimetry::fTrackModuleLabel
private

module creating the track objects and assns to hits

Definition at line 58 of file GeneralCalorimetry_module.cc.

Referenced by reconfigure().


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