hit::MCHitFinder Class Reference

Inheritance diagram for hit::MCHitFinder:

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

Public Member Functions
	MCHitFinder (fhicl::ParameterSet const &p)
virtual	~MCHitFinder ()
void	produce (art::Event &e) override
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_t &	createEngine (seed_t seed)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)
base_engine_t &	createEngine (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< Consumer >	non_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	fLArG4ModuleName
bool	fVerbose
bool	fMakeMCWire

Detailed Description

Definition at line 32 of file MCHitFinder_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

hit::MCHitFinder::MCHitFinder ( fhicl::ParameterSet const &  p )

explicit

Definition at line 48 of file MCHitFinder_module.cc.

References fLArG4ModuleName, fMakeMCWire, fVerbose, and fhicl::ParameterSet::get().

  {
    fLArG4ModuleName = p.get<std::string>("LArG4ModuleName");
    fMakeMCWire      = p.get<bool>("MakeMCWire");
    fVerbose         = p.get<bool>("Verbose");
    produces< std::vector< sim::MCHitCollection> >();
    if(fMakeMCWire)
      produces< std::vector< sim::MCWireCollection> >();
  }

hit::MCHitFinder::~MCHitFinder ( )

virtual

Definition at line 58 of file MCHitFinder_module.cc.

  {
  }

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

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

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

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

{
  return rng()->createEngine(placeholder_schedule_id(), seed);
}

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

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make);
}

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

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
}

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

  {
    return current_context_.get();
  }

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

{
  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
}

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_.

  {
    return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                               instanceName);
  }

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

  {
    auto const& pd =
      get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
    return pd.productID();
  }

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

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

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

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

    {
      return true;
    }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

{
  static Consumer invalid{InvalidTag{}};
  return &invalid;
}

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

{
  if (!moduleContext_)
    return;

  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
  for (auto& consumablesPerBranch : consumables_) {
    cet::sort_all(consumablesPerBranch);
  }
}

void hit::MCHitFinder::produce ( art::Event &  e )

overridevirtual

Implements art::EDProducer.

Definition at line 62 of file MCHitFinder_module.cc.

References sim::SimChannel::Channel(), DEFINE_ART_MODULE, edep, fLArG4ModuleName, fMakeMCWire, fVerbose, art::DataViewImpl::getByLabel(), art::Handle< T >::isValid(), geo::GeometryCore::Nchannels(), art::Event::put(), art::DataViewImpl::removeCachedProduct(), sim::MCHit::SetCharge(), sim::MCEnDep::SetEnergy(), sim::MCHit::SetParticleInfo(), sim::MCWire::SetStartTDC(), sim::MCHit::SetTime(), sim::MCEnDep::SetTrackId(), sim::MCEnDep::SetVertex(), and sim::SimChannel::TDCIDEMap().

  {
    
    art::ServiceHandle<geo::Geometry> geo;
    
    const unsigned int nch = geo->Nchannels();
    
    std::unique_ptr< std::vector<sim::MCHitCollection> > hits_v ( new std::vector<sim::MCHitCollection>() );
    std::unique_ptr< std::vector<sim::MCWireCollection> > wires_v ( new std::vector<sim::MCWireCollection>() );
    
    hits_v->reserve(nch);
    wires_v->reserve(nch);
    for(size_t ch=0; ch<nch; ++ch) {
      
      hits_v->push_back(sim::MCHitCollection(ch));
      wires_v->push_back(sim::MCWireCollection(ch));
      
    }
    
    art::Handle< std::vector<sim::SimChannel> > simchArray;
    e.getByLabel(fLArG4ModuleName,simchArray);
    if(!simchArray.isValid())
      throw cet::exception(__PRETTY_FUNCTION__) 
        << "Did not find sim::SimChannel with a label: " << fLArG4ModuleName.c_str() << std::endl;
    
    // Loop over SimChannel
    for(size_t simch_index=0; simch_index<simchArray->size(); ++simch_index) {
      
      const art::Ptr<sim::SimChannel> simch_ptr(simchArray,simch_index);
      
      size_t ch = simch_ptr->Channel();
      
      if(ch >= hits_v->size())
        
        throw cet::exception(__PRETTY_FUNCTION__)
          << "Channel number " << ch << " exceeds total # of channels: " << nch << std::endl;
      
      auto &mchits  = hits_v->at(ch);
      auto &mcwires = wires_v->at(ch);
      
      std::map<sim::MCEnDep,sim::MCWire> edep_wire_map;
      auto tdc_ide_map = simch_ptr->TDCIDEMap();
      
      // Loop over stored data for a particular sim::SimChannel //
      
      //
      // Read & Convert
      //
      if(fVerbose)
        std::cout<<std::endl<<"Processing Ch: "<<ch<<std::endl;
      
      for(auto const& tdc_ide_pair : tdc_ide_map) {
        
        auto const& tdc   = tdc_ide_pair.first;
        auto const& ide_v = tdc_ide_pair.second;
        
        for(auto const& ide : ide_v) {
          sim::MCEnDep edep;
          edep.SetVertex(ide.x,ide.y,ide.z);
          edep.SetEnergy(ide.energy);
          edep.SetTrackId(ide.trackID);
          
          sim::MCWire wire;
          wire.SetStartTDC(tdc);
          
          auto edep_iter = edep_wire_map.insert(std::make_pair(edep,wire));
          
          //auto edep_iter = edep_wire_map.find(edep);
          
          auto last_tdc = (edep_iter).first->second.StartTDC() + (edep_iter).first->second.size() - 1;
          
          if(fVerbose) {
            
            if( edep_iter.second ) std::cout<<std::endl;
            
            std::cout<<"  Track: "<<ide.trackID
                     <<" Vtx: " <<ide.x << " " << ide.y << " " <<ide.z << " " <<ide.energy
                     << " ...  @ TDC = "<<tdc<<" ... "<<ide.numElectrons << std::endl;
          }
          
          if( !(edep_iter.second) ) {
            
            if( last_tdc+1 != tdc ) {
              /*
              std::cerr 
                << "Found discontinuous TDC! "
                << " Last (ADC @ TDC): " << (*(edep_iter.first->second.rbegin())) << " @ " << last_tdc 
                << " while current (ADC @ TDC): " << (ide.numElectrons * detp->ElectronsToADC()) << " @ " << tdc
                << " ... skipping to store!"
                << std::endl;
              */
              continue;
            }
          }
          (edep_iter).first->second.push_back(ide.numElectrons);
        }// Done looping over IDEs in a particular TDC
      }// Done looping over TDC
      
      // 
      // Store
      //
      for(auto const& edep_wire_pair : edep_wire_map) {
        
        auto const& edep = edep_wire_pair.first;
        auto const& wire = edep_wire_pair.second;
        
        // Create MCHit
        ::sim::MCHit hit;
        float vtx[3] = {float(edep.Vertex()[0]),
                        float(edep.Vertex()[1]),
                        float(edep.Vertex()[2])};
        hit.SetParticleInfo(vtx, edep.Energy(), edep.TrackId());
        
        double max_time = 0;
        double qsum     = 0;
        double qmax     = 0;
        for(size_t wire_index=0; wire_index < wire.size(); ++wire_index) {
          
          auto q = wire.at(wire_index);
          
          qsum += q;
          
          if( q > qmax) { qmax = q; max_time = wire.StartTDC() + wire_index; }
          
        }       
        hit.SetCharge(qsum,qmax);
        hit.SetTime(max_time,0);
        
        mchits.push_back(hit);
        
        if(!fMakeMCWire) continue;
        
      mcwires.push_back(wire);
      } // End looping over all MCEnDep-MCWire pairs
    } // End looping over all SimChannels

    e.removeCachedProduct(simchArray);
    
    std::sort((*hits_v).begin(),(*hits_v).end());
    e.put(std::move(hits_v));
    
    if(fMakeMCWire) {
      std::sort((*wires_v).begin(),(*wires_v).end());
      e.put(std::move(wires_v));
    }
    
  }

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

{
  if (!moduleContext_)
    return;

  // If none of the branches have missing consumes statements, exit early.
  if (std::all_of(cbegin(missingConsumes_),
                  cend(missingConsumes_),
                  [](auto const& perBranch) { return perBranch.empty(); }))
    return;

  constexpr cet::HorizontalRule rule{60};
  mf::LogPrint log{"MTdiagnostics"};
  log << '\n'
      << rule('=') << '\n'
      << "The following consumes (or mayConsume) statements are missing from\n"
      << module_context(moduleDescription_) << '\n'
      << rule('-') << '\n';

  cet::for_all_with_index(
    missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
      for (auto const& pi : perBranch) {
        log << "  "
            << assemble_consumes_statement(static_cast<BranchType>(i), pi)
            << '\n';
      }
    });
  log << rule('=');
}

void art::Consumer::validateConsumedProduct ( BranchType const  bt, ProductInfo const &  pi  )

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

{
  // Early exits if consumes tracking has been disabled or if the
  // consumed product is an allowed consumable.
  if (!moduleContext_)
    return;

  if (cet::binary_search_all(consumables_[bt], pi))
    return;

  if (requireConsumes_) {
    throw Exception(errors::ProductRegistrationFailure,
                    "Consumer: an error occurred during validation of a "
                    "retrieved product\n\n")
      << "The following consumes (or mayConsume) statement is missing from\n"
      << module_context(moduleDescription_) << ":\n\n"
      << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
  }

  missingConsumes_[bt].insert(pi);
}

Member Data Documentation

std::string hit::MCHitFinder::fLArG4ModuleName

private

Definition at line 41 of file MCHitFinder_module.cc.

Referenced by MCHitFinder(), and produce().

bool hit::MCHitFinder::fMakeMCWire

private

Definition at line 43 of file MCHitFinder_module.cc.

Referenced by MCHitFinder(), and produce().

bool hit::MCHitFinder::fVerbose

private

Definition at line 42 of file MCHitFinder_module.cc.

Referenced by MCHitFinder(), and produce().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/HitFinder/MCHitFinder_module.cc