lar::test::AssnsChainClusterMaker Class Reference

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

Inheritance diagram for lar::test::AssnsChainClusterMaker:

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
	AssnsChainClusterMaker (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::Hit > >	collectHits (art::Event const &event) const
	Returns a list of hits to be clustered. More...

Private Attributes
std::vector< art::InputTag >	hitTags
	List of hit tags for clustering. More...
unsigned int	nHitsPerCluster
	Maximum number of hits per cluster. 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 clusters and associations to hits.

Configuration parameters

• hits (list of input tags): collections of the hits to be clustered
• hitsPerCluster (unsigned integer, default: 100): number of hits associated with each cluster

Definition at line 49 of file AssnsChainClusterMaker_module.cc.

Member Typedef Documentation

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

Definition at line 69 of file AssnsChainClusterMaker_module.cc.

Constructor & Destructor Documentation

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

inlineexplicit

Definition at line 71 of file AssnsChainClusterMaker_module.cc.

        : EDProducer{config}, hitTags(config().hits())
        , nHitsPerCluster(config().hitsPerCluster())
        {
          produces<std::vector<recob::Cluster>>();
          produces<art::Assns<recob::Hit, recob::Cluster>>();
        }

Member Function Documentation

std::vector< art::Ptr< recob::Hit > > lar::test::AssnsChainClusterMaker::collectHits ( art::Event const &  event ) const

private

Returns a list of hits to be clustered.

Definition at line 207 of file AssnsChainClusterMaker_module.cc.

{

  std::vector<art::Ptr<recob::Hit>> allHits;

  for (auto const& tag: hitTags) {
    auto hits = event.getValidHandle<std::vector<recob::Hit>>(tag);

    std::size_t const nHits = hits->size();
    for (std::size_t i = 0; i < nHits; ++i)
      allHits.emplace_back(hits, i);

  } // for

  return allHits;
} // lar::test::AssnsChainClusterMaker::collectHits()

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

overridevirtual

Implements art::EDProducer.

Definition at line 107 of file AssnsChainClusterMaker_module.cc.

                                                           {

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

  //
  // prepare output
  //
  auto clusters = std::make_unique<std::vector<recob::Cluster>>();
  auto hitClusterAssns
    = std::make_unique<art::Assns<recob::Hit, recob::Cluster>>();

  //
  // create the clusters
  //
  unsigned int nClusters = hits.size() / nHitsPerCluster;
  if (nClusters * nHitsPerCluster < hits.size()) ++nClusters;

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

  for (unsigned int i = 0; i < nClusters; ++i) {

    //
    // assign hits to cluster
    //
    std::vector<art::Ptr<recob::Hit>> clusterHits;
    std::size_t iHit = i;
    while (iHit < hits.size()) {
      clusterHits.push_back(hits[iHit]);
      iHit += nClusters;
    } // while

    //
    // generate the cluster
    //
    clusters->emplace_back(
      float(clusterHits.front()->WireID().Wire), // start_wire
      1.0,                                       // sigma_start_wire
      clusterHits.front()->PeakTime(),           // start_tick
      clusterHits.front()->SigmaPeakTime(),      // sigma_start_tick
      clusterHits.front()->Integral(),           // start_charge
      0.0,                                       // start_angle
      0.0,                                       // start_opening
      float(clusterHits.back()->WireID().Wire),  // end_wire
      1.0,                                       // sigma_end_wire
      clusterHits.back()->PeakTime(),            // end_tick
      clusterHits.back()->SigmaPeakTime(),       // sigma_end_tick
      clusterHits.back()->Integral(),            // end_charge
      0.0,                                       // end_angle
      0.0,                                       // end_opening
      std::accumulate(clusterHits.cbegin(), clusterHits.cend(), 0.0,
        [](float sum, art::Ptr<recob::Hit> const& hit)
          { return sum + hit->Integral(); }
        ),                                       // integral
      std::sqrt(std::accumulate(clusterHits.cbegin(), clusterHits.cend(), 0.0,
        [](float sum, art::Ptr<recob::Hit> const& hit)
          { return sum + sqr(hit->SigmaIntegral()); }
        )),                                      // integral_stddev
      std::accumulate(clusterHits.cbegin(), clusterHits.cend(), 0.0,
        [](float sum, art::Ptr<recob::Hit> const& hit)
          { return sum + hit->SummedADC(); }
        ),                                       // summedADC
      std::sqrt(std::accumulate(clusterHits.cbegin(), clusterHits.cend(), 0.0,
        [](float sum, art::Ptr<recob::Hit> const& hit)
          { return sum + hit->SummedADC(); }
        )),                                      // summedADC_stddev
      clusterHits.size(),                        // n_hits
      0.0,                                       // multiple_hit_density
      2.0,                                       // width
      recob::Cluster::ID_t(i + 1),               // ID
      clusterHits.front()->View(),               // view
      clusterHits.front()->WireID().asPlaneID(), // plane
      recob::Cluster::Sentry
      );

    //
    // generate associations
    //
    auto const clusterPtr = ptrMaker(i); // art pointer to the new cluster
    for (art::Ptr<recob::Hit> const& hit: clusterHits)
      hitClusterAssns->addSingle(hit, clusterPtr);

  } // for

  mf::LogInfo("AssnsChainClusterMaker")
    << "Created " << clusters->size() << " clusters with about "
    << nHitsPerCluster << " hits each from " << hits.size() << " hits and "
    << hitClusterAssns->size() << " associations from "
    << hitTags.size() << " collections";

  event.put(std::move(clusters));
  event.put(std::move(hitClusterAssns));

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

Member Data Documentation

std::vector<art::InputTag> lar::test::AssnsChainClusterMaker::hitTags

private

List of hit tags for clustering.

Definition at line 82 of file AssnsChainClusterMaker_module.cc.

unsigned int lar::test::AssnsChainClusterMaker::nHitsPerCluster

private

Maximum number of hits per cluster.

Definition at line 83 of file AssnsChainClusterMaker_module.cc.

---

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

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