CandCombinerBase< OutputCollection, CandPtr > Class Template Reference

#include <CandCombinerBase.h>

Public Types
typedef std::vector< std::string >	vstring

Public Member Functions
	CandCombinerBase (const std::string="")
	default construct More...
	CandCombinerBase (int, int, const std::string="")
	construct from two charge values More...
	CandCombinerBase (int, int, int, const std::string="")
	construct from three charge values More...
	CandCombinerBase (int, int, int, int, const std::string="")
	construct from four charge values More...
	CandCombinerBase (bool checkCharge, bool checkOverlap, const std::vector< int > &, const std::string="")
	constructor from a selector, specifying optionally to check for charge More...
std::unique_ptr< OutputCollection >	combine (const std::vector< edm::Handle< reco::CandidateView > > &, const vstring &=vstring()) const
	return all selected candidate pairs More...
std::unique_ptr< OutputCollection >	combine (const edm::Handle< reco::CandidateView > &, const vstring &=vstring()) const
	return all selected candidate pairs More...
std::unique_ptr< OutputCollection >	combine (const edm::Handle< reco::CandidateView > &, const edm::Handle< reco::CandidateView > &, const vstring &=vstring()) const
	return all selected candidate pairs More...
std::unique_ptr< OutputCollection >	combine (const edm::Handle< reco::CandidateView > &, const edm::Handle< reco::CandidateView > &, const edm::Handle< reco::CandidateView > &, const vstring &=vstring()) const
	return all selected candidate pairs More...
std::unique_ptr< OutputCollection >	combine (const edm::Handle< reco::CandidateView > &, const edm::Handle< reco::CandidateView > &, const edm::Handle< reco::CandidateView > &, const edm::Handle< reco::CandidateView > &, const vstring &=vstring()) const
	return all selected candidate pairs More...
virtual	~CandCombinerBase ()
	destructor More...

Private Types
typedef std::vector< std::pair< std::pair< CandPtr, size_t >, std::vector< edm::Handle< reco::CandidateView > >::const_iterator > >	CandStack
	temporary candidate stack More...
typedef std::vector< int >	ChargeStack

Private Member Functions
virtual void	addDaughter (typename OutputCollection::value_type &cmp, const CandPtr &c, const std::string="") const =0
	add candidate daughter More...
void	combine (typename OutputCollection::value_type &, const CandPtr &, const CandPtr &, const std::string="", const std::string="") const
	returns a composite candidate combined from two daughters More...
void	combine (size_t collectionIndex, CandStack &, ChargeStack &, std::vector< edm::Handle< reco::CandidateView > >::const_iterator begin, std::vector< edm::Handle< reco::CandidateView > >::const_iterator end, OutputCollection *comps, const vstring &name=vstring()) const
	returns a composite candidate combined from two daughters More...
bool	preselect (const reco::Candidate &, const reco::Candidate &) const
	verify that the two candidate don't overlap and check charge More...
virtual bool	select (const reco::Candidate &) const =0
	select a candidate More...
virtual bool	selectPair (const reco::Candidate &c1, const reco::Candidate &c2) const =0
	select a candidate pair More...
virtual void	setup (typename OutputCollection::value_type &) const =0
	set kinematics to reconstructed composite More...

Private Attributes
bool	checkCharge_
	flag to specify the checking of electric charge More...
bool	checkOverlap_
	flag to specify the checking of overlaps More...
std::vector< int >	dauCharge_
	electric charges of the daughters More...
std::string	name_
	composite name (if applies) More...
OverlapChecker	overlap_
	utility to check candidate daughters overlap More...

Detailed Description

template<typename OutputCollection, typename CandPtr>
class CandCombinerBase< OutputCollection, CandPtr >

Author

Luca Lista, INFN

Definition at line 14 of file CandCombinerBase.h.

Member Typedef Documentation

template<typename OutputCollection, typename CandPtr>

typedef std::vector<std::pair<std::pair<CandPtr, size_t>, std::vector<edm::Handle<reco::CandidateView> >::const_iterator> > CandCombinerBase< OutputCollection, CandPtr >::CandStack

private

temporary candidate stack

Definition at line 60 of file CandCombinerBase.h.

template<typename OutputCollection, typename CandPtr>

typedef std::vector<int> CandCombinerBase< OutputCollection, CandPtr >::ChargeStack

private

Definition at line 61 of file CandCombinerBase.h.

template<typename OutputCollection, typename CandPtr>

typedef std::vector<std::string> CandCombinerBase< OutputCollection, CandPtr >::vstring

Definition at line 16 of file CandCombinerBase.h.

Constructor & Destructor Documentation

template<typename OutputCollection , typename CandPtr >

CandCombinerBase< OutputCollection, CandPtr >::CandCombinerBase ( const std::string  name = "" )

explicit

default construct

Definition at line 89 of file CandCombinerBase.h.

                                                                                  :
  checkCharge_(false), checkOverlap_(true), dauCharge_(), overlap_(), name_(name) {
}

template<typename OutputCollection , typename CandPtr >

CandCombinerBase< OutputCollection, CandPtr >::CandCombinerBase	(	int	q1,
		int	q2,
		const std::string	name = ""
	)

construct from two charge values

Definition at line 94 of file CandCombinerBase.h.

References CandCombinerBase< OutputCollection, CandPtr >::dauCharge_, q1, and q2.

                                                                                                  :
  checkCharge_(true), checkOverlap_(true), dauCharge_(2), overlap_(), name_(name) {
  dauCharge_[0] = q1;
  dauCharge_[1] = q2;
}

template<typename OutputCollection , typename CandPtr >

CandCombinerBase< OutputCollection, CandPtr >::CandCombinerBase	(	int	q1,
		int	q2,
		int	q3,
		const std::string	name = ""
	)

construct from three charge values

Definition at line 101 of file CandCombinerBase.h.

References CandCombinerBase< OutputCollection, CandPtr >::dauCharge_, q1, and q2.

                                                                                                          :
  checkCharge_(true), checkOverlap_(true), dauCharge_(3), overlap_(), name_(name) {
  dauCharge_[0] = q1;
  dauCharge_[1] = q2;
  dauCharge_[2] = q3;
}

template<typename OutputCollection , typename CandPtr >

CandCombinerBase< OutputCollection, CandPtr >::CandCombinerBase	(	int	q1,
		int	q2,
		int	q3,
		int	q4,
		const std::string	name = ""
	)

construct from four charge values

Definition at line 109 of file CandCombinerBase.h.

References CandCombinerBase< OutputCollection, CandPtr >::dauCharge_, q1, and q2.

                                                                                                                  :
  checkCharge_(true), checkOverlap_(true), dauCharge_(4), overlap_(), name_(name) {
  dauCharge_[0] = q1;
  dauCharge_[1] = q2;
  dauCharge_[2] = q3;
  dauCharge_[3] = q4;
}

template<typename OutputCollection , typename CandPtr >

CandCombinerBase< OutputCollection, CandPtr >::CandCombinerBase	(	bool	checkCharge,
		bool	checkOverlap,
		const std::vector< int > &	dauCharge,
		const std::string	name = ""
	)

constructor from a selector, specifying optionally to check for charge

Definition at line 118 of file CandCombinerBase.h.

                                                                                                                                                         :
  checkCharge_(checkCharge), checkOverlap_(checkOverlap), dauCharge_(dauCharge), overlap_(), name_(name) {
}

template<typename OutputCollection , typename CandPtr >

CandCombinerBase< OutputCollection, CandPtr >::~CandCombinerBase ( )

virtual

destructor

Definition at line 123 of file CandCombinerBase.h.

                                                               {
}

Member Function Documentation

template<typename OutputCollection, typename CandPtr>

virtual void CandCombinerBase< OutputCollection, CandPtr >::addDaughter ( typename OutputCollection::value_type &  cmp, const CandPtr &  c, const std::string  = ""  ) const

privatepure virtual

add candidate daughter

Implemented in CandCombiner< Selector, PairSelector, Cloner, OutputCollection, Setup >.

Referenced by CandCombinerBase< OutputCollection, CandPtr >::combine().

template<typename OutputCollection , typename CandPtr >

std::unique_ptr< OutputCollection > CandCombinerBase< OutputCollection, CandPtr >::combine	(	const std::vector< edm::Handle< reco::CandidateView > > &	src,
		const vstring &	names = vstring()
	)		const

return all selected candidate pairs

Definition at line 148 of file CandCombinerBase.h.

References EnergyCorrector::c, alignmentValidation::c1, CandCombinerBase< OutputCollection, CandPtr >::checkCharge_, edm::errors::Configuration, CandCombinerBase< OutputCollection, CandPtr >::dauCharge_, Exception, edm::ProductID::id(), edm::HandleBase::id(), gen::n, cscdqm::h::names, cscdqm::h::namesSize, CandCombinerBase< OutputCollection, CandPtr >::preselect(), CandCombinerBase< OutputCollection, CandPtr >::select(), edm::View< T >::size(), TrackRefitter_38T_cff::src, svgfig::stack, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by CandCombinerBase< OutputCollection, CandPtr >::combine().

                                                         {
  size_t srcSize = src.size();
  if (checkCharge_ && dauCharge_.size() != srcSize)
    throw edm::Exception(edm::errors::Configuration) 
      << "CandCombiner: trying to combine " << srcSize << " collections"
      << " but configured to check against " << dauCharge_.size() << " charges.";
  std::unique_ptr<OutputCollection> comps(new OutputCollection);
  size_t namesSize = names.size();
  if(srcSize == 2) {
    std::string name1="", name2="";
    if(namesSize > 0) {
      if(namesSize != 2)
    throw edm::Exception(edm::errors::Configuration)
      << "CandCombiner: should specify exactly two "
      << " names in configuration (" << namesSize << " specified).\n";
      name1 = names[0];
      name2 = names[1];
    }
    edm::Handle<reco::CandidateView> src1 = src[0], src2 = src[1];
    if(src1.id() == src2.id()) {
      const reco::CandidateView & cands = * src1;
      const size_t n = cands.size();
      for(size_t i1 = 0; i1 < n; ++i1) {
    const reco::Candidate & c1 = cands[i1];
    CandPtr cr1(src1, i1);
    for(size_t i2 = i1 + 1; i2 < n; ++i2) {
      const reco::Candidate & c2 = cands[i2];
      if(preselect(c1, c2)) {
        CandPtr cr2(src2, i2);
        typename OutputCollection::value_type c; 
        combine(c, cr1, cr2, name1, name2);
        if(select(c))
          comps->push_back(c);
      }
    }
      }
    } else {
      const reco::CandidateView & cands1 = * src1, & cands2 = * src2;
      const size_t n1 = cands1.size(), n2 = cands2.size();
      for(size_t i1 = 0; i1 < n1; ++i1) {
    const reco::Candidate & c1 = cands1[i1];
    CandPtr cr1(src1, i1);
    for(size_t i2 = 0; i2 < n2; ++i2) {
      const reco::Candidate & c2 = cands2[i2];
      if(preselect(c1, c2)) {
        CandPtr cr2(src2, i2);
        typename OutputCollection::value_type c;
        combine(c, cr1, cr2, name1, name2);
        if(select(c))
          comps->push_back(c);
      }
    }
      }
    }
  } else {
    CandStack stack;
    ChargeStack qStack;
    combine(0, stack, qStack, src.begin(), src.end(), comps.get(), names);
  }

  return comps;
}

template<typename OutputCollection , typename CandPtr >

std::unique_ptr< OutputCollection > CandCombinerBase< OutputCollection, CandPtr >::combine	(	const edm::Handle< reco::CandidateView > &	src,
		const vstring &	names = vstring()
	)		const

return all selected candidate pairs

Definition at line 214 of file CandCombinerBase.h.

References EnergyCorrector::c, alignmentValidation::c1, CandCombinerBase< OutputCollection, CandPtr >::checkCharge_, CandCombinerBase< OutputCollection, CandPtr >::combine(), edm::errors::Configuration, CandCombinerBase< OutputCollection, CandPtr >::dauCharge_, Exception, gen::n, cscdqm::h::namesSize, CandCombinerBase< OutputCollection, CandPtr >::preselect(), CandCombinerBase< OutputCollection, CandPtr >::select(), edm::View< T >::size(), TrackRefitter_38T_cff::src, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                         {
  if(checkCharge_ && dauCharge_.size() != 2)
    throw edm::Exception(edm::errors::Configuration) 
      << "CandCombiner: trying to combine 2 collections"
      << " but configured to check against " << dauCharge_.size() << " charges.";

  std::unique_ptr<OutputCollection> comps(new OutputCollection);
  size_t namesSize = names.size();
  std::string name1, name2;
  if(namesSize > 0) {
    if(namesSize != 2)
      throw edm::Exception(edm::errors::Configuration)
    << "CandCombiner: should specify exactly two "
    << " names in configuration (" << namesSize << " specified).\n";
    name1 = names[0];
    name2 = names[1];
  }
  const reco::CandidateView & cands = * src; 
  const size_t n = cands.size();
  for(size_t i1 = 0; i1 < n; ++i1) {
    const reco::Candidate & c1 = cands[i1];
    CandPtr cr1(src, i1);
    for(size_t i2 = i1 + 1; i2 < n; ++i2) {
      const reco::Candidate & c2 = cands[i2];
      if(preselect(c1, c2)) {
    CandPtr cr2(src, i2);
    typename OutputCollection::value_type c;
    combine(c, cr1, cr2, name1, name2);
    if(select(c))
      comps->push_back(c);
      }
    } 
  }

  return comps;
}

template<typename OutputCollection , typename CandPtr >

std::unique_ptr< OutputCollection > CandCombinerBase< OutputCollection, CandPtr >::combine	(	const edm::Handle< reco::CandidateView > &	src1,
		const edm::Handle< reco::CandidateView > &	src2,
		const vstring &	names = vstring()
	)		const

return all selected candidate pairs

Definition at line 254 of file CandCombinerBase.h.

References CandCombinerBase< OutputCollection, CandPtr >::combine(), and TrackRefitter_38T_cff::src.

                                                         {
  std::vector<edm::Handle<reco::CandidateView> > src;
  src.push_back(src1);
  src.push_back(src2);
  return combine(src, names);
}

template<typename OutputCollection , typename CandPtr >

std::unique_ptr< OutputCollection > CandCombinerBase< OutputCollection, CandPtr >::combine	(	const edm::Handle< reco::CandidateView > &	src1,
		const edm::Handle< reco::CandidateView > &	src2,
		const edm::Handle< reco::CandidateView > &	src3,
		const vstring &	names = vstring()
	)		const

return all selected candidate pairs

Definition at line 265 of file CandCombinerBase.h.

References CandCombinerBase< OutputCollection, CandPtr >::combine(), and TrackRefitter_38T_cff::src.

                                                         {
  std::vector<edm::Handle<reco::CandidateView> > src;
  src.push_back(src1);
  src.push_back(src2);
  src.push_back(src3);
  return combine(src, names);
}

template<typename OutputCollection , typename CandPtr >

std::unique_ptr< OutputCollection > CandCombinerBase< OutputCollection, CandPtr >::combine	(	const edm::Handle< reco::CandidateView > &	src1,
		const edm::Handle< reco::CandidateView > &	src2,
		const edm::Handle< reco::CandidateView > &	src3,
		const edm::Handle< reco::CandidateView > &	src4,
		const vstring &	names = vstring()
	)		const

return all selected candidate pairs

Definition at line 278 of file CandCombinerBase.h.

References CandCombinerBase< OutputCollection, CandPtr >::combine(), and TrackRefitter_38T_cff::src.

                                                         {
  std::vector<edm::Handle<reco::CandidateView> > src;
  src.push_back(src1);
  src.push_back(src2);
  src.push_back(src3);
  src.push_back(src4);
  return combine(src, names);
}

template<typename OutputCollection, typename CandPtr>

void CandCombinerBase< OutputCollection, CandPtr >::combine ( typename OutputCollection::value_type &  cmp, const CandPtr &  c1, const CandPtr &  c2, const std::string  name1 = "", const std::string  name2 = ""  ) const

private

returns a composite candidate combined from two daughters

Definition at line 138 of file CandCombinerBase.h.

References CandCombinerBase< OutputCollection, CandPtr >::addDaughter(), and CandCombinerBase< OutputCollection, CandPtr >::setup().

                                                                                  {
  addDaughter(cmp, c1, name1);
  addDaughter(cmp, c2, name2);
  setup(cmp);
}

template<typename OutputCollection, typename CandPtr>

void CandCombinerBase< OutputCollection, CandPtr >::combine ( size_t  collectionIndex, CandStack &  stack, ChargeStack &  qStack, std::vector< edm::Handle< reco::CandidateView > >::const_iterator  begin, std::vector< edm::Handle< reco::CandidateView > >::const_iterator  end, OutputCollection *  comps, const vstring &  name = vstring()  ) const

private

returns a composite candidate combined from two daughters

Definition at line 292 of file CandCombinerBase.h.

References CandCombinerBase< OutputCollection, CandPtr >::addDaughter(), EnergyCorrector::c, reco::Candidate::charge(), CandCombinerBase< OutputCollection, CandPtr >::checkCharge_, CandCombinerBase< OutputCollection, CandPtr >::checkOverlap_, CandCombinerBase< OutputCollection, CandPtr >::combine(), CandCombinerBase< OutputCollection, CandPtr >::dauCharge_, mps_fire::i, edm::HandleBase::id(), CandCombinerBase< OutputCollection, CandPtr >::overlap_, lumiQueryAPI::q, CandCombinerBase< OutputCollection, CandPtr >::select(), CandCombinerBase< OutputCollection, CandPtr >::setup(), edm::View< T >::size(), and TrackRefitter_38T_cff::src.

                                                          {
  if(collBegin == collEnd) {
    static const int undetermined = 0, sameDecay = 1, conjDecay = -1, wrongDecay = 2;
    int decayType = undetermined;
    if(checkCharge_) {
      assert(qStack.size() == stack.size());
      for(size_t i = 0; i < qStack.size(); ++i) {
    int q = qStack[i], dq = dauCharge_[i];
    if(decayType == undetermined) {
      if(q != 0 && dq != 0) {
        if(q == dq) decayType = sameDecay;
        else if(q == -dq) decayType = conjDecay;
        else decayType = wrongDecay;
      }
    } else if((decayType == sameDecay && q != dq) ||
          (decayType == conjDecay && q != -dq)) {
      decayType = wrongDecay;
    }
    if(decayType == wrongDecay) break;
      }
    }
    if(decayType != wrongDecay) { 
      typename OutputCollection::value_type c;
      size_t nameIndex = 0;
      for(typename CandStack::const_iterator i = stack.begin(); i != stack.end(); ++i, ++ nameIndex) {
    if ( names.size() > 0 )
      addDaughter(c, i->first.first, names[nameIndex]);
    else
      addDaughter(c, i->first.first);     
      }
      setup(c);
      if(select(c))
    comps->push_back(c);
    }
  } else {
    const edm::Handle<reco::CandidateView> & srcRef = * collBegin;
    const reco::CandidateView & src = * srcRef;
    size_t candBegin = 0, candEnd = src.size();
    for(typename CandStack::const_iterator i = stack.begin(); i != stack.end(); ++i) 
      if(srcRef.id() == i->second->id()) 
    candBegin = i->first.second + 1;
    for(size_t candIndex = candBegin; candIndex != candEnd; ++ candIndex) {
      CandPtr candRef(srcRef, candIndex);
      bool noOverlap = true;
      const reco::Candidate & cand = * candRef;
      for(typename CandStack::const_iterator i = stack.begin(); i != stack.end(); ++i) 
    if(checkOverlap_ && overlap_(cand, *(i->first.first))) { 
      noOverlap = false; 
      break; 
    }
      if(noOverlap) {
    stack.push_back(std::make_pair(std::make_pair(candRef, candIndex), collBegin));
    if(checkCharge_) qStack.push_back(cand.charge()); 
    combine(collectionIndex + 1, stack, qStack, collBegin + 1, collEnd, comps, names);
    stack.pop_back();
    qStack.pop_back();
      }
    }
  }
}

template<typename OutputCollection , typename CandPtr >

bool CandCombinerBase< OutputCollection, CandPtr >::preselect ( const reco::Candidate &  c1, const reco::Candidate &  c2  ) const

private

verify that the two candidate don't overlap and check charge

Definition at line 127 of file CandCombinerBase.h.

References reco::Candidate::charge(), CandCombinerBase< OutputCollection, CandPtr >::checkCharge_, CandCombinerBase< OutputCollection, CandPtr >::checkOverlap_, CandCombinerBase< OutputCollection, CandPtr >::dauCharge_, CandCombinerBase< OutputCollection, CandPtr >::overlap_, q1, q2, and CandCombinerBase< OutputCollection, CandPtr >::selectPair().

Referenced by CandCombinerBase< OutputCollection, CandPtr >::combine().

                                                                                                                    {
  if (checkCharge_) {
    int dq1 = dauCharge_[0], dq2 = dauCharge_[1], q1 = c1.charge(), q2 = c2.charge();
    bool matchCharge = (q1 == dq1 && q2 == dq2) || (q1 == -dq1 && q2 == -dq2); 
    if (!matchCharge) return false; 
  }
  if (checkOverlap_ && overlap_(c1, c2)) return false;
  return selectPair(c1, c2);
}

template<typename OutputCollection, typename CandPtr>

virtual bool CandCombinerBase< OutputCollection, CandPtr >::select ( const reco::Candidate &  ) const

privatepure virtual

select a candidate

Implemented in CandCombiner< Selector, PairSelector, Cloner, OutputCollection, Setup >.

Referenced by CandCombinerBase< OutputCollection, CandPtr >::combine(), Vispa.Views.LineDecayView.LineDecayContainer::createObject(), Vispa.Plugins.Browser.BrowserTabController.BrowserTabController::find(), Vispa.Views.LineDecayView.LineDecayContainer::mousePressEvent(), Vispa.Gui.PortConnection.PointToPointConnection::mousePressEvent(), Vispa.Gui.VispaWidget.VispaWidget::mousePressEvent(), and Vispa.Views.AbstractView.AbstractView::restoreSelection().

template<typename OutputCollection, typename CandPtr>

virtual bool CandCombinerBase< OutputCollection, CandPtr >::selectPair ( const reco::Candidate &  c1, const reco::Candidate &  c2  ) const

privatepure virtual

select a candidate pair

Implemented in CandCombiner< Selector, PairSelector, Cloner, OutputCollection, Setup >.

Referenced by CandCombinerBase< OutputCollection, CandPtr >::preselect().

template<typename OutputCollection, typename CandPtr>

virtual void CandCombinerBase< OutputCollection, CandPtr >::setup ( typename OutputCollection::value_type &  ) const

privatepure virtual

set kinematics to reconstructed composite

Implemented in CandCombiner< Selector, PairSelector, Cloner, OutputCollection, Setup >.

Referenced by CandCombinerBase< OutputCollection, CandPtr >::combine(), and o2olib.O2OTool::execute().

Member Data Documentation

template<typename OutputCollection, typename CandPtr>

bool CandCombinerBase< OutputCollection, CandPtr >::checkCharge_

private

flag to specify the checking of electric charge

Definition at line 77 of file CandCombinerBase.h.

Referenced by CandCombinerBase< OutputCollection, CandPtr >::combine(), and CandCombinerBase< OutputCollection, CandPtr >::preselect().

template<typename OutputCollection, typename CandPtr>

bool CandCombinerBase< OutputCollection, CandPtr >::checkOverlap_

private

flag to specify the checking of overlaps

Definition at line 79 of file CandCombinerBase.h.

Referenced by CandCombinerBase< OutputCollection, CandPtr >::combine(), and CandCombinerBase< OutputCollection, CandPtr >::preselect().

template<typename OutputCollection, typename CandPtr>

std::vector<int> CandCombinerBase< OutputCollection, CandPtr >::dauCharge_

private

electric charges of the daughters

Definition at line 81 of file CandCombinerBase.h.

Referenced by CandCombinerBase< OutputCollection, CandPtr >::CandCombinerBase(), CandCombinerBase< OutputCollection, CandPtr >::combine(), and CandCombinerBase< OutputCollection, CandPtr >::preselect().

template<typename OutputCollection, typename CandPtr>

std::string CandCombinerBase< OutputCollection, CandPtr >::name_

private

composite name (if applies)

Definition at line 85 of file CandCombinerBase.h.

template<typename OutputCollection, typename CandPtr>

OverlapChecker CandCombinerBase< OutputCollection, CandPtr >::overlap_

private

utility to check candidate daughters overlap

Definition at line 83 of file CandCombinerBase.h.

Referenced by CandCombinerBase< OutputCollection, CandPtr >::combine(), and CandCombinerBase< OutputCollection, CandPtr >::preselect().