lar::test::AssnsChainPFParticleMaker Class Reference

Creates some dummy PFParticles and associations to clusters. More...

Inheritance diagram for lar::test::AssnsChainPFParticleMaker:

Classes
struct	Config

Public Types
using	Parameters = art::EDProducer::Table< Config >
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >
Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	AssnsChainPFParticleMaker (Parameters const &config)
virtual void	produce (art::Event &event) override
Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDProducer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept
	Producer (fhicl::ParameterSet const &)
	Producer (Producer const &)=delete
	Producer (Producer &&)=delete
Producer &	operator= (Producer const &)=delete
Producer &	operator= (Producer &&)=delete
void	doBeginJob (SharedResources const &resources)
void	doEndJob ()
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenOutputFiles (FileBlock const &fb)
void	doRespondToCloseOutputFiles (FileBlock const &fb)
bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
Public Member Functions inherited from art::Modifier
	~Modifier () noexcept
	Modifier ()
	Modifier (Modifier const &)=delete
	Modifier (Modifier &&)=delete
Modifier &	operator= (Modifier const &)=delete
Modifier &	operator= (Modifier &&)=delete
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Member Functions
std::vector< art::Ptr< recob::Cluster > >	collectClusters (art::Event const &event) const
	Returns a list of clusters to be combined. More...

Private Attributes
std::vector< art::InputTag >	clusterTags
	List of cluster tags. More...
unsigned int	nClustersPerPFO
	Maximum number of clusters per PFO. More...

Additional Inherited Members
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)
Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

Creates some dummy PFParticles and associations to clusters.

Configuration parameters

• clusters (list of input tags): collections of the clusters to be used if PFParticles
• clustersPerPFO (unsigned integer, default: 3): number of clusters combined into each PFParticle

Definition at line 50 of file AssnsChainPFParticleMaker_module.cc.

Member Typedef Documentation

using lar::test::AssnsChainPFParticleMaker::Parameters = art::EDProducer::Table<Config>

Definition at line 70 of file AssnsChainPFParticleMaker_module.cc.

Constructor & Destructor Documentation

lar::test::AssnsChainPFParticleMaker::AssnsChainPFParticleMaker ( Parameters const &  config )

inlineexplicit

Definition at line 72 of file AssnsChainPFParticleMaker_module.cc.

        : EDProducer{config}
        , clusterTags(config().clusters())
        , nClustersPerPFO(config().clustersPerPFO())
        {
          produces<std::vector<recob::PFParticle>>();
          produces<art::Assns<recob::Cluster, recob::PFParticle>>();
        }

Member Function Documentation

std::vector< art::Ptr< recob::Cluster > > lar::test::AssnsChainPFParticleMaker::collectClusters ( art::Event const &  event ) const

private

Returns a list of clusters to be combined.

Definition at line 198 of file AssnsChainPFParticleMaker_module.cc.

{

  std::vector<art::Ptr<recob::Cluster>> allClusters;

  for (auto const& tag: clusterTags) {
    auto clusters = event.getValidHandle<std::vector<recob::Cluster>>(tag);

    std::size_t const nClusters = clusters->size();
    for (std::size_t i = 0; i < nClusters; ++i)
      allClusters.emplace_back(clusters, i);

  } // for

  return allClusters;
} // lar::test::AssnsChainPFParticleMaker::collectClusters()

void lar::test::AssnsChainPFParticleMaker::produce ( art::Event &  event )

overridevirtual

Implements art::EDProducer.

Definition at line 101 of file AssnsChainPFParticleMaker_module.cc.

                                                              {

  //
  // prepare input: merge all hits in a single collection
  //
  std::vector<art::Ptr<recob::Cluster>> clusters = collectClusters(event);

  //
  // prepare output
  //
  auto PFOs = std::make_unique<std::vector<recob::PFParticle>>();
  auto clusterPFOassns
    = std::make_unique<art::Assns<recob::Cluster, recob::PFParticle>>();

  //
  // create the PFParticles
  //
  unsigned int nPFOs = clusters.size() / nClustersPerPFO;
  if (nPFOs * nClustersPerPFO < clusters.size()) ++nPFOs;

  art::PtrMaker<recob::PFParticle> ptrMaker(event);

  unsigned int nDaughtersPerParticle = 2;
  unsigned int nParticlesInTier = 1;
  std::size_t firstPFOinThisTier = 0;
  std::size_t firstPFOinNextTier = firstPFOinThisTier + nParticlesInTier;
  std::size_t nextDaughter = firstPFOinNextTier;
  std::vector<std::size_t> parents
    (nPFOs, std::size_t(recob::PFParticle::kPFParticlePrimary));
  for (unsigned int i = 0; i < nPFOs; ++i) {

    // prepare for the next tier, if needed
    if (i >= firstPFOinNextTier) {
      firstPFOinThisTier = firstPFOinNextTier;

      nParticlesInTier *= nDaughtersPerParticle;
      nDaughtersPerParticle += 1;
      firstPFOinNextTier += nParticlesInTier;
    } // if

    //
    // assign clusters to PFO
    //
    std::vector<art::Ptr<recob::Cluster>> PFOclusters;
    std::size_t iCluster = i;
    while (iCluster < clusters.size()) {
      PFOclusters.push_back(clusters[iCluster]);
      iCluster += nPFOs;
    } // while

    //
    // generate the PFParticle
    //
    std::size_t const endDaughter
      = std::min(nextDaughter + nDaughtersPerParticle, (std::size_t) nPFOs);
    std::vector<std::size_t> daughters;
    daughters.reserve(endDaughter - nextDaughter);
    while (nextDaughter < endDaughter) {
      parents[nextDaughter] = i;
      daughters.push_back(nextDaughter);
      ++nextDaughter;
    } // while

    PFOs->emplace_back(
      11,                  // pdgCode (11 = shower-like)
      i,                   // self
      parents[i],          // parent
      std::move(daughters)
      );

    //
    // generate associations
    //
    auto const PFOptr = ptrMaker(i); // art pointer to the new PFParticle
    for (art::Ptr<recob::Cluster> const& cluster: PFOclusters) {
      mf::LogVerbatim("AssnsChainPFParticleMaker")
        << "Associating cluster " << cluster << " with PFO " << PFOptr;
      clusterPFOassns->addSingle(cluster, PFOptr);
    }

  } // for

  mf::LogInfo("AssnsChainPFParticleMaker")
    << "Created " << PFOs->size() << " particle flow objects with about "
    << nClustersPerPFO << " clusters each from " << clusters.size()
    << " clusters and " << clusterPFOassns->size() << " associations from "
    << clusterTags.size() << " collections";

  event.put(std::move(PFOs));
  event.put(std::move(clusterPFOassns));

} // lar::test::AssnsChainClusterMaker::produce()

Member Data Documentation

std::vector<art::InputTag> lar::test::AssnsChainPFParticleMaker::clusterTags

private

List of cluster tags.

Definition at line 84 of file AssnsChainPFParticleMaker_module.cc.

unsigned int lar::test::AssnsChainPFParticleMaker::nClustersPerPFO

private

Maximum number of clusters per PFO.

Definition at line 85 of file AssnsChainPFParticleMaker_module.cc.

---

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

• lardata/test/Utilities/testAssnsChainUtils/AssnsChainPFParticleMaker_module.cc