sim::DumpMCTracks Class Reference

Inheritance diagram for sim::DumpMCTracks:

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >
using	WorkerType = WorkerT< EDAnalyzer >
using	ModuleType = EDAnalyzer

Public Member Functions
	DumpMCTracks (Parameters const &config)
	Configuration-checking constructor. More...
	DumpMCTracks (DumpMCTracks const &)=delete
	DumpMCTracks (DumpMCTracks &&)=delete
DumpMCTracks &	operator= (DumpMCTracks const &)=delete
DumpMCTracks &	operator= (DumpMCTracks &&)=delete
virtual void	analyze (art::Event const &event) override
template<typename Stream >
void	DumpMCTrack (Stream &&out, sim::MCTrack const &track, std::string indent="", bool bIndentFirst=true) const
	Dumps the content of the specified particle in the output stream. More...
std::string	workerType () const
bool	modifiesEvent () const
void	registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)
std::string const &	processName () const
bool	wantAllEvents () const
bool	wantEvent (Event const &e)
fhicl::ParameterSetID	selectorConfig () const
art::Handle< art::TriggerResults >	getTriggerResults (Event const &e) 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
detail::CachedProducts &	cachedProducts ()
void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
void	prepareForJob (fhicl::ParameterSet const &pset)
void	showMissingConsumes () const

Private Attributes
art::InputTag	fInputTracks
	name of MCTrack's data product More...
std::string	fOutputCategory
	name of the stream for output More...

Detailed Description

Definition at line 85 of file DumpMCTracks_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 39 of file EDAnalyzer.h.

using sim::DumpMCTracks::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 88 of file DumpMCTracks_module.cc.

using art::EDAnalyzer::WorkerType = WorkerT<EDAnalyzer>

inherited

Definition at line 38 of file EDAnalyzer.h.

Constructor & Destructor Documentation

sim::DumpMCTracks::DumpMCTracks ( Parameters const &  config )

explicit

Configuration-checking constructor.

Definition at line 136 of file DumpMCTracks_module.cc.

  : EDAnalyzer(config)
  , fInputTracks(config().InputTracks())
  , fOutputCategory(config().OutputCategory())
{}

sim::DumpMCTracks::DumpMCTracks ( DumpMCTracks const &  )

delete

sim::DumpMCTracks::DumpMCTracks ( DumpMCTracks &&  )

delete

Member Function Documentation

void sim::DumpMCTracks::analyze ( art::Event const &  event )

overridevirtual

Implements art::EDAnalyzer.

Definition at line 213 of file DumpMCTracks_module.cc.

References DEFINE_ART_MODULE, DumpMCTrack(), art::InputTag::encode(), fInputTracks, fOutputCategory, and track.

                                                   {
  
  // get the particles from the event
  auto const& Tracks
    = *(event.getValidHandle<std::vector<sim::MCTrack>>(fInputTracks));
  
  mf::LogVerbatim(fOutputCategory)
    << "Event " << event.id() << ": data product '"
    << fInputTracks.encode() << "' contains "
    << Tracks.size() << " MCTrack objects";
  
  unsigned int iTrack = 0;
  mf::LogVerbatim log(fOutputCategory);
  for (sim::MCTrack const& track: Tracks) {
    
    // a bit of a header
    log << "\n[#" << (iTrack++) << "] ";
    DumpMCTrack(log, track, "  ", false);
    
  } // for
  log << "\n";
  
} // sim::DumpMCTracks::analyze()

detail::CachedProducts& art::EventObserverBase::cachedProducts ( )

inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

Referenced by art::EDAnalyzer::doEvent(), and art::OutputModule::doWriteEvent().

  {
    return selectors_;
  }

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::EDAnalyzer::currentContext ( ) const

protectedinherited

Definition at line 114 of file EDAnalyzer.cc.

References art::EDAnalyzer::current_context_.

Referenced by art::EDAnalyzer::workerType().

  {
    return current_context_.get();
  }

template<typename Stream >

void sim::DumpMCTracks::DumpMCTrack	(	Stream &&	out,
		sim::MCTrack const &	track,
		std::string	indent = "",
		bool	bIndentFirst = true
	)		const

Dumps the content of the specified particle in the output stream.

Template Parameters

Stream

the type of output stream

Parameters

out	the output stream
particle	the particle to be dumped
indent	base indentation string (default: none)
bIndentFirst	if first output line should be indented (default: yes)

The indent string is prepended to every line of output, with the possible exception of the first one, in case bIndentFirst is true.

The output starts on the current line, and the last line is NOT broken.

Definition at line 144 of file DumpMCTracks_module.cc.

References sim::MCTrack::AncestorEnd(), sim::MCTrack::AncestorPdgCode(), sim::MCTrack::AncestorProcess(), sim::MCTrack::AncestorStart(), sim::MCTrack::AncestorTrackID(), sim::MCTrack::dEdx(), sim::MCTrack::dQdx(), sim::MCTrack::End(), art::detail::indent(), max, sim::MCTrack::MotherEnd(), sim::MCTrack::MotherPdgCode(), sim::MCTrack::MotherProcess(), sim::MCTrack::MotherStart(), sim::MCTrack::MotherTrackID(), sim::MCTrack::Origin(), sim::MCTrack::PdgCode(), sim::MCTrack::Process(), sim::MCTrack::Start(), and sim::MCTrack::TrackID().

Referenced by analyze().

        {
  if (bIndentFirst) out << indent;
  out
    << "from GEANT track ID=" << track.TrackID()
    << " PDG ID=" << track.PdgCode()
    << " from " << OriginDescription(track.Origin())
    << " via '" << track.Process() << "'";
  out << "\n" << indent
    << "  starting at ";
  ::PrintMCStep(out, track.Start());
  out << "\n" << indent
    << "  ending at ";
  ::PrintMCStep(out, track.End());
  
  std::vector<std::vector<double>> const& dQdx = track.dQdx(); // dQdx[MCStep][plane]
  std::vector<double> const& dEdx = track.dEdx(); // dEdx[MCStep]
  size_t const nQSteps = dQdx.size(), nESteps = dEdx.size();
  size_t const nSteps = std::max(nQSteps, nESteps);
  out << "\n" << indent;
  if (nSteps > 0) {
    out
      << "energy information for " << nSteps
      << " steps (dE/dX in MeV/cm, then dQ/dx per plane):";
    for (size_t iStep = 0; iStep < nSteps; ++iStep) {
      out << "\n" << indent
        << "  [#" << iStep << "] dE/dx=";
      if (iStep < nESteps) out << dEdx[iStep];
      else                 out << "<N/A>";
      out << "; dQ/dx:";
      if (iStep < nQSteps) {
        std::vector<double> const& step_dQdx = dQdx[iStep]; // dQdx[plane]
        for (size_t iPlane = 0; iPlane < step_dQdx.size(); ++iPlane) {
          out << " [#" << iPlane << "] " << step_dQdx[iPlane];
        } // for plane
      }
      else                 out << "<N/A>";
    } // for iStep
  }
  else out << "no energy or charge information available";
  
  out << "\n" << indent
    << "mother ID=" << track.MotherTrackID()
    << " PDG ID=" << track.MotherPdgCode()
    << " via '" << track.MotherProcess() << "'";
  out << "\n" << indent
    << "  starting at ";
  ::PrintMCStep(out, track.MotherStart());
  out << "\n" << indent
    << "  ending at ";
  ::PrintMCStep(out, track.MotherEnd());
  
  out << "\n" << indent
    << "ancestor ID=" << track.AncestorTrackID()
    << " PDG ID=" << track.AncestorPdgCode()
    << " via '" << track.AncestorProcess() << "'";
  out << "\n" << indent
    << "  starting at ";
  ::PrintMCStep(out, track.AncestorStart());
  out << "\n" << indent
    << "  ending at ";
  ::PrintMCStep(out, track.AncestorEnd());

} // sim::DumpMCTracks::DumpMCTrack()

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();
}

art::Handle<art::TriggerResults> art::EventObserverBase::getTriggerResults ( Event const &  e ) const

inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

Referenced by art::OutputModule::doWriteEvent().

  {
    return selectors_.getOneTriggerResults(e);
  }

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::EventObserverBase::modifiesEvent ( ) const

inlineinherited

Definition at line 25 of file EventObserverBase.h.

  {
    return false;
  }

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;
}

DumpMCTracks& sim::DumpMCTracks::operator= ( DumpMCTracks const &  )

delete

DumpMCTracks& sim::DumpMCTracks::operator= ( DumpMCTracks &&  )

delete

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);
  }
}

std::string const& art::EventObserverBase::processName ( ) const

inlineinherited

Definition at line 41 of file EventObserverBase.h.

References art::EventObserverBase::process_name_.

Referenced by art::FileDumperOutput::printPrincipal(), and art::RootOutput::RootOutput().

  {
    return process_name_;
  }

void art::EventObserverBase::registerProducts ( MasterProductRegistry &  , ProductDescriptions &  , ModuleDescription const &    )

inlineinherited

Definition at line 33 of file EventObserverBase.h.

  {}

fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const

inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

Referenced by art::RootOutputFile::writeOne().

  {
    return selector_config_id_;
  }

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);
}

bool art::EventObserverBase::wantAllEvents ( ) const

inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), art::RootOutput::RootOutput(), and art::OutputWorker::wantAllEvents().

  {
    return wantAllEvents_;
  }

bool art::EventObserverBase::wantEvent ( Event const &  e )

inlineinherited

Definition at line 51 of file EventObserverBase.h.

References art::EventObserverBase::selectors_, and art::detail::CachedProducts::wantEvent().

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), and art::OutputModule::doWriteEvent().

  {
    return selectors_.wantEvent(e);
  }

std::string art::EDAnalyzer::workerType ( ) const

inlineinherited

Definition at line 109 of file EDAnalyzer.h.

References art::EDAnalyzer::currentContext().

    {
      return "WorkerT<EDAnalyzer>";
    }

Member Data Documentation

art::InputTag sim::DumpMCTracks::fInputTracks

private

name of MCTrack's data product

Definition at line 126 of file DumpMCTracks_module.cc.

Referenced by analyze().

std::string sim::DumpMCTracks::fOutputCategory

private

name of the stream for output

Definition at line 127 of file DumpMCTracks_module.cc.

Referenced by analyze().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/MCDumpers/DumpMCTracks_module.cc