util::PxHitConverter Class Reference

#include "PxHitConverter.h"

Public Member Functions
virtual	~PxHitConverter ()=default
	Default destructor (virtual) More...
void	GeneratePxHit (const std::vector< unsigned int > &hit_index, const std::vector< art::Ptr< recob::Hit >> hits, std::vector< util::PxHit > &pxhits) const
	Generate: from 1 set of hits => 1 set of PxHits using indexes (association) More...
void	GeneratePxHit (std::vector< art::Ptr< recob::Hit >> const &hits, std::vector< util::PxHit > &pxhits) const
	Generate: from 1 set of hits => 1 set of PxHits using using all hits. More...
void	GenerateSinglePxHit (art::Ptr< recob::Hit > const &hit, util::PxHit &pxhits) const
util::PxHit	HitToPxHit (recob::Hit const &hit) const
	Generates and returns a PxHit out of a recob::Hit. More...
template<typename HitObj >
util::PxHit	ToPxHit (HitObj const &hit) const
template<typename Cont , typename Hit = typename Cont::value_type>
std::vector< util::PxHit >	ToPxHitVector (Cont const &hits) const
	Returns a vector of util::PxHit out of a vector of hits. More...

Detailed Description

Definition at line 41 of file PxHitConverter.h.

Constructor & Destructor Documentation

virtual util::PxHitConverter::~PxHitConverter ( )

virtualdefault

Default destructor (virtual)

Member Function Documentation

void util::PxHitConverter::GeneratePxHit	(	const std::vector< unsigned int > &	hit_index,
		const std::vector< art::Ptr< recob::Hit >>	hits,
		std::vector< util::PxHit > &	pxhits
	)		const

Generate: from 1 set of hits => 1 set of PxHits using indexes (association)

Definition at line 70 of file PxHitConverter.cxx.

References GenerateSinglePxHit(), and hits().

Referenced by evd::HitSelector::ChangeHit(), GeneratePxHit(), cluster::SimpleClusterMerger::produce(), cluster::FuzzyClusterMerger::produce(), ShowerReco3D::produce(), and evd::HitSelector::SaveHits().

  {

    if(!(hit_index.size())) throw UtilException(Form("Hit list empty! (%s)",__FUNCTION__));
    
    pxhits.clear();
    pxhits.reserve(hit_index.size());

    for(auto const& index : hit_index) {
      
      auto const& hit = hits[index];

      PxHit h;
      GenerateSinglePxHit(hit,h);

      pxhits.push_back(h);
    }      
    
  }

void util::PxHitConverter::GeneratePxHit	(	std::vector< art::Ptr< recob::Hit >> const &	hits,
		std::vector< util::PxHit > &	pxhits
	)		const

Generate: from 1 set of hits => 1 set of PxHits using using all hits.

Generate: from 1 set of hits => 1 set of PxHits using indexes (association)

Definition at line 25 of file PxHitConverter.cxx.

References GeneratePxHit(), and hits().

  {

    if(!(hits.size())) throw UtilException(Form("Hit list empty! (%s)",__FUNCTION__));
    
    std::vector<unsigned int> hit_index;
    
    hit_index.clear();
    hit_index.reserve(hits.size());

    //generate full index
    for(unsigned int ix=0; ix<hits.size();++ix ) hit_index.push_back(ix);

    GeneratePxHit(hit_index,hits,pxhits);
    
  }

void util::PxHitConverter::GenerateSinglePxHit	(	art::Ptr< recob::Hit > const &	hit,
		util::PxHit &	pxhits
	)		const

Definition at line 44 of file PxHitConverter.cxx.

References ToPxHit().

Referenced by GeneratePxHit().

  {
    pxhit = ToPxHit(hit);
  }

PxHit util::PxHitConverter::HitToPxHit

(

recob::Hit const &

hit

)

const

Generates and returns a PxHit out of a recob::Hit.

Definition at line 51 of file PxHitConverter.cxx.

References util::PxHit::charge, recob::Hit::Integral(), util::PxHit::peak, recob::Hit::PeakAmplitude(), recob::Hit::PeakTime(), util::PxPoint::plane, geo::PlaneID::Plane, util::PxHit::sumADC, recob::Hit::SummedADC(), util::PxPoint::t, util::GeometryUtilities::TimeToCm(), util::PxPoint::w, geo::WireID::Wire, recob::Hit::WireID(), and util::GeometryUtilities::WireToCm().

Referenced by ToPxHit().

  {
    
    util::GeometryUtilities  gser;
    
    PxHit pxhit;
    pxhit.t      = hit.PeakTime() * gser.TimeToCm();
    pxhit.w      = hit.WireID().Wire * gser.WireToCm();
    pxhit.charge = hit.Integral();
    pxhit.sumADC = hit.SummedADC();
    pxhit.peak   = hit.PeakAmplitude();
    pxhit.plane  = hit.WireID().Plane;
    
    return pxhit;
  } // PxHitConverter::HitToPxHit(recob::Hit)

template<typename HitObj >

util::PxHit util::PxHitConverter::ToPxHit

(

HitObj const &

hit

)

const

Generates and returns a PxHit out of a pointer to recob::Hit or a hit itself

Definition at line 115 of file PxHitConverter.h.

References lar::util::dereference(), HitToPxHit(), ToPxHitVector(), and fhicl::detail::atom::value().

Referenced by GenerateSinglePxHit(), and ToPxHitVector().

{
  // check that the argument is an object convertible to a recob::Hit,
  // or it is a pointer to such an object
  static_assert(
    std::is_convertible<
      typename lar::util::dereferenced_type<HitObj>::type,
      recob::Hit
    >::value,
    "The argument to PxHitConverter::ToPxHit() does not point to a recob::Hit"
    );
  return HitToPxHit(lar::util::dereference(hit));
} // PxHitConverter::ToPxHit()

template<typename Cont , typename Hit >

std::vector< util::PxHit > util::PxHitConverter::ToPxHitVector

(

Cont const &

hits

)

const

Returns a vector of util::PxHit out of a vector of hits.

Definition at line 132 of file PxHitConverter.h.

References ToPxHit().

Referenced by cluster::StandardClusterParamsAlg::SetHits(), and ToPxHit().

{
  std::vector<util::PxHit> pxhits;
  pxhits.reserve(hits.size());
  std::transform(hits.begin(), hits.end(), std::back_inserter(pxhits),
    [this](Hit const& hit) { return this->ToPxHit(hit); });
  return pxhits;
} // util::PxHitConverter::ToPxHitVector()

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/Utilities/PxHitConverter.h
• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/Utilities/PxHitConverter.cxx