lar::example::TotallyCheatTracker Class Reference

Module: creates tracks from simulated particles. More...

Inheritance diagram for lar::example::TotallyCheatTracker:

Classes
struct	Config
	Module configuration data. More...

Public Types
using	Parameters = art::EDProducer::Table< Config >
	Standard art alias for module configuration table. More...
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

Public Member Functions
	TotallyCheatTracker (Parameters const &config)
	Constructor; see the class documentation for the configuration. More...
virtual void	produce (art::Event &event) override
bool	acceptParticle (simb::MCParticle const &particle) const
	Returns whether the particle satisfies the selection criteria. More...
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
art::InputTag	particleTag
	Label of the input data product. More...
double	minLength
	Minimum particle length [cm]. More...
double	minEnergy
	Minimum energy [GeV]. More...
lar::example::TotallyCheatTrackingAlg	trackMaker
	Reconstruction algorithm. More...

Detailed Description

Module: creates tracks from simulated particles.

See also

TotallyCheatTracks example overview

This module creates one LArSoft reconstructed track (lar::example::CheatTrack) for each input simulated particle (simb::MCParticle) passing the selection criteria.

Input

A collection of simb::MCParticle is required.

Output

A collection of lar::example::CheatTrack is produced, a one-to-one association of each of them to its original simb::MCParticle. Associations are inserted in the same order as the trajectories.

Configuration parameters

• particles (input tag, default: largeant): label of the data product with input simulated particles
• minLength (parameter set, default: 1.0): minimum length of the particle trajectory, in centimeters
• minEnergy (parameter set, default: 1.0): minimum energy of the particle, in GeV

Definition at line 75 of file TotallyCheatTracker_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

using lar::example::TotallyCheatTracker::Parameters = art::EDProducer::Table<Config>

Standard art alias for module configuration table.

Definition at line 112 of file TotallyCheatTracker_module.cc.

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

lar::example::TotallyCheatTracker::TotallyCheatTracker ( Parameters const &  config )

explicit

Constructor; see the class documentation for the configuration.

Definition at line 146 of file TotallyCheatTracker_module.cc.

References particleTag.

  : particleTag(config().particles())
  , minLength(config().minLength())
  , minEnergy(config().minEnergy())
  , trackMaker(config().algoConfig())
{
  
  consumes<std::vector<simb::MCParticle>>(particleTag);
  
  produces<std::vector<lar::example::CheatTrack>>();
  produces<art::Assns<lar::example::CheatTrack, simb::MCParticle>>();
  
} // lar::example::TotallyCheatTracker::TotallyCheatTracker()

Member Function Documentation

bool lar::example::TotallyCheatTracker::acceptParticle

(

simb::MCParticle const &

particle

)

const

Returns whether the particle satisfies the selection criteria.

Definition at line 229 of file TotallyCheatTracker_module.cc.

References DEFINE_ART_MODULE, simb::MCParticle::E(), lar::example::TotallyCheatTracker::Config::minEnergy, lar::example::TotallyCheatTracker::Config::minLength, simb::MCParticle::NumberTrajectoryPoints(), simb::MCTrajectory::TotalLength(), and simb::MCParticle::Trajectory().

Referenced by produce().

{
  // skip empty particle
  if (particle.NumberTrajectoryPoints() == 0) return false;
  
  // energy at the first point
  if (particle.E() < minEnergy) return false;
  
  // path length
  if (particle.Trajectory().TotalLength() < minLength) return false;
  
  // good enough!
  return true;
  
} // lar::example::TotallyCheatTracker::acceptParticle()

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 lar::example::TotallyCheatTracker::produce ( art::Event &  event )

overridevirtual

Implements art::EDProducer.

Definition at line 162 of file TotallyCheatTracker_module.cc.

References acceptParticle(), art::InputTag::encode(), art::Event::id(), lar::example::TotallyCheatTrackingAlg::makeTrack(), lar::example::TotallyCheatTracker::Config::particles, particleTag, lar::example::TotallyCheatTrackingAlg::setup(), and trackMaker.

                                                           {
  
  //
  // read the input
  //
  auto particleHandle
    = event.getValidHandle<std::vector<simb::MCParticle>>(particleTag);
  auto const& particles = *particleHandle;
  
  //
  // prepare the output structures
  //
  auto tracks = std::make_unique<std::vector<lar::example::CheatTrack>>();
  auto trackToPart =
    std::make_unique<art::Assns<lar::example::CheatTrack, simb::MCParticle>>();
  
  art::PtrMaker<simb::MCParticle> makePartPtr(event, particleHandle.id());
  art::PtrMaker<lar::example::CheatTrack> makeTrackPtr(event, *this);
  
  
  //
  // set up the algorithm
  //
  trackMaker.setup();
  
  //
  // run the algorithm
  //
  for (std::size_t iParticle = 0U; iParticle < particles.size(); ++iParticle) {
    simb::MCParticle const& particle = particles[iParticle];
    
    //
    // apply filters
    //
    if (!acceptParticle(particle)) continue;
    
    //
    // run the algorithm
    //
    tracks->push_back(trackMaker.makeTrack(particle));
    
    //
    // create the association
    //
    auto const iTrack = tracks->size() - 1;
    art::Ptr<lar::example::CheatTrack> const trackPtr = makeTrackPtr(iTrack);
    art::Ptr<simb::MCParticle> const partPtr = makePartPtr(iParticle);
    trackToPart->addSingle(trackPtr, partPtr);
    
  } // for
  
  //
  // store the data products into the event (and print a short summary)
  //
  mf::LogInfo("TotallyCheatTracker")
    << "Reconstructed " << tracks->size() << " tracks out of "
    << particleHandle->size() << " particles from '"
    << particleTag.encode() << "'";
  
  event.put(std::move(tracks));
  event.put(std::move(trackToPart));
  
} // lar::example::TotallyCheatTracker::produce()

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

double lar::example::TotallyCheatTracker::minEnergy

private

Minimum energy [GeV].

Definition at line 129 of file TotallyCheatTracker_module.cc.

double lar::example::TotallyCheatTracker::minLength

private

Minimum particle length [cm].

Definition at line 128 of file TotallyCheatTracker_module.cc.

art::InputTag lar::example::TotallyCheatTracker::particleTag

private

Label of the input data product.

Definition at line 126 of file TotallyCheatTracker_module.cc.

Referenced by produce(), and TotallyCheatTracker().

lar::example::TotallyCheatTrackingAlg lar::example::TotallyCheatTracker::trackMaker

private

Reconstruction algorithm.

Definition at line 132 of file TotallyCheatTracker_module.cc.

Referenced by produce().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larexamples/v07_00_19/source/larexamples/Algorithms/TotallyCheatTracks/TotallyCheatTracker_module.cc