LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
ToyOneShowerGen Class Reference
Inheritance diagram for ToyOneShowerGen:
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

 ToyOneShowerGen (fhicl::ParameterSet const &p)
 
virtual ~ToyOneShowerGen ()
 
void produce (art::Event &e) override
 
void beginRun (art::Run &run) override
 
std::vector< double > GetXYZDirection (double uz=0)
 
std::vector< double > GetXYZPosition ()
 
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

TF1 * fShapeMomentum
 
TF1 * fShapeTheta
 
CLHEP::RandFlat * fFlatRandom
 
double fMass
 
double fTime
 
int fPDGCode
 

Detailed Description

Definition at line 39 of file ToyOneShowerGen_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

ToyOneShowerGen::ToyOneShowerGen ( fhicl::ParameterSet const &  p)
explicit

Definition at line 61 of file ToyOneShowerGen_module.cc.

References art::EngineCreator::createEngine(), fFlatRandom, fMass, fPDGCode, fShapeMomentum, fShapeTheta, fTime, fhicl::ParameterSet::get(), art::RandomNumberGenerator::getEngine(), and art::EngineCreator::rng().

62  : fShapeMomentum(nullptr), fShapeTheta(nullptr), fFlatRandom(nullptr)
63 {
64  produces< std::vector<simb::MCTruth> >();
65  produces< sumdata::RunData, art::InRun >();
66 
67  // Time
68  fTime = p.get<double>("Time");
69 
70  // PDGCode
71  fPDGCode = p.get<int>("PDGCode");
72 
73  // Mass
74  fMass = TDatabasePDG().GetParticle(fPDGCode)->Mass();
75  if(fPDGCode != 22 && !fMass) throw std::exception();
76 
77  //
78  // Momentum distribution
79  //
80 
81  // Read-in formula
82  fShapeMomentum = new TF1("fShapeMomentum",
83  (p.get<std::string>("MomentumShapeFormula")).c_str(),
84  p.get<double>("MomentumLowerBound"),
85  p.get<double>("MomentumUpperBound"));
86  // Check formula
87  if(!fShapeMomentum)
88 
89  throw cet::exception(__PRETTY_FUNCTION__)
90  << "Failed making momentum spectrum shape from provided formula!" << std::endl;
91 
92  // Read-in parameter values
93  std::vector<double> shape_par_values = p.get<std::vector<double> >("MomentumShapeParameters");
94 
95  // Check parameter values
96  if((int)(shape_par_values.size()) != fShapeMomentum->GetNpar())
97 
98  throw cet::exception(__PRETTY_FUNCTION__)
99  << "Number of parameters provided to MomentumShapeFormula does not match with the formula!" << std::endl;
100 
101  // Set parameter values
102  for(size_t i=0; i<shape_par_values.size(); ++i)
103 
104  fShapeMomentum->SetParameter(i,shape_par_values.at(i));
105 
106  //
107  // Angular distribution
108  //
109 
110  // Read-in formula
111  fShapeTheta = new TF1("fShapeTheta",
112  (p.get<std::string>("ThetaShapeFormula")).c_str(),
113  p.get<double>("ThetaLowerBound"),
114  p.get<double>("ThetaUpperBound"));
115  // Check formula
116  if(!fShapeTheta)
117 
118  throw cet::exception(__PRETTY_FUNCTION__)
119  << "Failed making momentum spectrum shape from provided formula!" << std::endl;
120 
121  // Read-in parameter values
122  shape_par_values = p.get<std::vector<double> >("ThetaShapeParameters");
123 
124  // Check parameter values
125  if((int)(shape_par_values.size()) != fShapeTheta->GetNpar())
126 
127  throw cet::exception(__PRETTY_FUNCTION__)
128  << "Number of parameters provided to ThetaShapeFormula does not match with the formula!" << std::endl;
129 
130  // Set parameter values
131  for(size_t i=0; i<shape_par_values.size(); ++i)
132 
133  fShapeTheta->SetParameter(i,shape_par_values.at(i));
134 
135  //
136  // Random engine initialization
137  //
138  // create a default random engine; obtain the random seed from NuRandomService,
139  // unless overridden in configuration with key "Seed"
142  CLHEP::HepRandomEngine &engine = rng->getEngine();
143  fFlatRandom = new CLHEP::RandFlat(engine);
144 }
base_engine_t & getEngine() const
base_engine_t & createEngine(seed_t seed)
CLHEP::RandFlat * fFlatRandom
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
cet::coded_exception< error, detail::translate > exception
Definition: exception.h:33
ToyOneShowerGen::~ToyOneShowerGen ( )
virtual

Definition at line 159 of file ToyOneShowerGen_module.cc.

References fFlatRandom, fShapeMomentum, and fShapeTheta.

160 {
161  delete fShapeTheta;
162  delete fShapeMomentum;
163  delete fFlatRandom;
164 }
CLHEP::RandFlat * fFlatRandom

Member Function Documentation

void ToyOneShowerGen::beginRun ( art::Run run)
overridevirtual

Reimplemented from art::EDProducer.

Definition at line 147 of file ToyOneShowerGen_module.cc.

References geo::GeometryCore::DetectorName(), and art::Run::put().

148 {
149  // grab the geometry object to see what geometry we are using
151 
152  std::unique_ptr<sumdata::RunData> runData(new sumdata::RunData(geo->DetectorName()));
153 
154  run.put(std::move(runData));
155 
156  return;
157 }
art::ProductID put(std::unique_ptr< PROD > &&)
Definition: Run.h:148
std::string DetectorName() const
Returns a string with the name of the detector, as configured.
Namespace collecting geometry-related classes utilities.
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
std::vector< double > ToyOneShowerGen::GetXYZDirection ( double  uz = 0)

Definition at line 187 of file ToyOneShowerGen_module.cc.

References fFlatRandom.

Referenced by produce().

187  {
188 
189  std::vector<double> udir(3,0);
190 
191  double phi = fFlatRandom->fire(0, 2 * 3.141592653589793238);
192 
193  udir[0] = TMath::Sin(TMath::ACos(uz)) * TMath::Cos(phi);
194  udir[1] = TMath::Sin(TMath::ACos(uz)) * TMath::Sin(phi);
195  udir[2] = uz;
196 
197  return udir;
198 }
CLHEP::RandFlat * fFlatRandom
std::vector< double > ToyOneShowerGen::GetXYZPosition ( )

Definition at line 166 of file ToyOneShowerGen_module.cc.

References geo::GeometryCore::DetHalfHeight(), geo::GeometryCore::DetHalfWidth(), geo::GeometryCore::DetLength(), and fFlatRandom.

Referenced by produce().

166  {
167 
168  std::vector<double> pos(3,0);
169 
170  //pos.at(0) = fFlatRandom->fire(170.,2390.);
171  //pos.at(1) = fFlatRandom->fire(-995.,995.);
172  //pos.at(2) = fFlatRandom->fire(170.,10190.);
173 
174  //pos.at(0) = fFlatRandom->fire(17.,239.);
175  //pos.at(1) = fFlatRandom->fire(-99.5,99.5);
176  //pos.at(2) = fFlatRandom->fire(17.,1019.);
177 
179 
180  pos.at(0) = fFlatRandom->fire(0.,2.*(geo->DetHalfWidth()));
181  pos.at(1) = fFlatRandom->fire(-1.*(geo->DetHalfHeight()), geo->DetHalfHeight());
182  pos.at(2) = fFlatRandom->fire(0.,geo->DetLength());
183 
184  return pos;
185 }
geo::Length_t DetHalfWidth(geo::TPCID const &tpcid) const
Returns the half width of the active volume of the specified TPC.
geo::Length_t DetHalfHeight(geo::TPCID const &tpcid) const
Returns the half height of the active volume of the specified TPC.
geo::Length_t DetLength(geo::TPCID const &tpcid) const
Returns the length of the active volume of the specified TPC.
CLHEP::RandFlat * fFlatRandom
Namespace collecting geometry-related classes utilities.
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 ToyOneShowerGen::produce ( art::Event e)
overridevirtual

Implements art::EDProducer.

Definition at line 200 of file ToyOneShowerGen_module.cc.

References simb::MCTruth::Add(), DEFINE_ART_MODULE, dir, fMass, fPDGCode, fShapeMomentum, fShapeTheta, fTime, GetXYZDirection(), GetXYZPosition(), part, and art::Event::put().

201 {
202  std::unique_ptr< std::vector<simb::MCTruth> > mctArray(new std::vector<simb::MCTruth>);
203  double mom = fShapeMomentum->GetRandom();
204  double Uz = TMath::Cos(fShapeTheta->GetRandom());
205 
206  std::vector<double> pos = GetXYZPosition();
207 
208  std::vector<double> dir = GetXYZDirection(Uz);
209 
210  simb::MCTruth truth;
211 
212  TLorentzVector pos_lorentz(pos.at(0), pos.at(1), pos.at(2), fTime);
213  TLorentzVector mom_lorentz( dir.at(0) * mom,
214  dir.at(1) * mom,
215  dir.at(2) * mom,
216  sqrt(pow(mom,2)+pow(fMass,2)));
217 
218  simb::MCParticle part(0, fPDGCode, "primary", 0, fMass, 1);
219 
220  part.AddTrajectoryPoint(pos_lorentz, mom_lorentz);
221 
222  truth.Add(part);
223 
224  mctArray->push_back(truth);
225 
226  e.put(std::move(mctArray));
227 
228 }
void Add(simb::MCParticle &part)
Definition: MCTruth.h:77
ProductID put(std::unique_ptr< PROD > &&product)
Definition: Event.h:102
TString part[npart]
Definition: Style.C:32
std::vector< double > GetXYZDirection(double uz=0)
std::vector< double > GetXYZPosition()
TDirectory * dir
Definition: macro.C:5
Event generator information.
Definition: MCTruth.h:30
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

CLHEP::RandFlat* ToyOneShowerGen::fFlatRandom
private
double ToyOneShowerGen::fMass
private

Definition at line 55 of file ToyOneShowerGen_module.cc.

Referenced by produce(), and ToyOneShowerGen().

int ToyOneShowerGen::fPDGCode
private

Definition at line 57 of file ToyOneShowerGen_module.cc.

Referenced by produce(), and ToyOneShowerGen().

TF1* ToyOneShowerGen::fShapeMomentum
private

Definition at line 51 of file ToyOneShowerGen_module.cc.

Referenced by produce(), ToyOneShowerGen(), and ~ToyOneShowerGen().

TF1* ToyOneShowerGen::fShapeTheta
private

Definition at line 52 of file ToyOneShowerGen_module.cc.

Referenced by produce(), ToyOneShowerGen(), and ~ToyOneShowerGen().

double ToyOneShowerGen::fTime
private

Definition at line 56 of file ToyOneShowerGen_module.cc.

Referenced by produce(), and ToyOneShowerGen().


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