RecoTauCommonUtilities.h

Go to the documentation of this file.

#ifndef RecoTauTag_RecoTau_RecoTauCommonUtilities_h
#define RecoTauTag_RecoTau_RecoTauCommonUtilities_h

/*
 * RecoTauCommonUtilities - utilities for extracting PFCandidates from
 * PFJets and summing over collections of PFCandidates.
 *
 * Author: Evan K. Friis (UC Davis)
 *
 */

#include "DataFormats/ParticleFlowCandidate/interface/PFCandidateFwd.h"
#include "DataFormats/ParticleFlowCandidate/interface/PFCandidate.h"
#include "DataFormats/TauReco/interface/PFTau.h"
#include "DataFormats/VertexReco/interface/VertexFwd.h"
#include <vector>
#include <algorithm>
#include <numeric>

// Boost helpers
#include <boost/iterator/transform_iterator.hpp>
#include <boost/iterator/indirect_iterator.hpp>
#include <boost/mem_fn.hpp>

#include <boost/type_traits/is_base_of.hpp>

namespace reco { namespace tau {

class SortPFCandsDescendingPt {
  public:
    bool operator()(const PFCandidatePtr& a, const PFCandidatePtr& b) const {
      return a->pt() > b->pt();
    }
};

template<typename Iterator> std::vector<PFCandidatePtr>
filterPFCandidates(const Iterator& begin, const Iterator& end,
    int particleId, bool sort=true) {
  std::vector<PFCandidatePtr> output;
  for(Iterator iter = begin; iter != end; ++iter) {
    reco::PFCandidatePtr ptr(*iter);
    if (ptr->particleId() == particleId)
      output.push_back(ptr);
  }
  if (sort) std::sort(output.begin(), output.end(), SortPFCandsDescendingPt());
  return output;
}

std::vector<PFCandidatePtr> pfCandidates(const PFJet& jet,
                                         int particleId, bool sort=true);

std::vector<PFCandidatePtr> pfCandidates(const PFJet& jet,
                                         const std::vector<int>& particleIds,
                                         bool sort=true);

std::vector<PFCandidatePtr> pfChargedCands(const PFJet& jet, bool sort=true);

std::vector<PFCandidatePtr> pfGammas(const PFJet& jet, bool sort=true);

std::vector<PFCandidatePtr> flattenPiZeros(const std::vector<RecoTauPiZero>::const_iterator&, const std::vector<RecoTauPiZero>::const_iterator&);
std::vector<PFCandidatePtr> flattenPiZeros(const std::vector<RecoTauPiZero>&);

template<typename RefVectorType, typename BaseView>
RefVectorType castView(const edm::Handle<BaseView>& view) {
  typedef typename RefVectorType::value_type OutputRef;
  // Double check at compile time that the inheritance is okay.  It can still
  // fail at runtime if you pass it the wrong collection.
  static_assert(
      (boost::is_base_of<typename BaseView::value_type,
                         typename RefVectorType::member_type>::value));
  RefVectorType output;
  size_t nElements = view->size();
  output.reserve(nElements);
  // Cast each of our Refs
  for (size_t i = 0; i < nElements; ++i) {
    output.push_back(view->refAt(i).template castTo<OutputRef>());
  }
  return output;
}

/*
 *Given a range over a container of type C, return a new 'end' iterator such
 *that at max <N> elements are taken.  If there are less than N elements in the
 *array, leave the <end>  as it is
 */
template<typename InputIterator> InputIterator takeNElements(
    const InputIterator& begin, const InputIterator& end, size_t N) {
  size_t input_size = end - begin;
  return (N > input_size) ? end : begin + N;
}

template<typename InputIterator, typename FunctionPtr, typename ReturnType>
  ReturnType sumPFVector(InputIterator begin, InputIterator end,
      FunctionPtr func, ReturnType init) {
    ReturnType output = init;
    for(InputIterator cand = begin; cand != end; ++cand) {
      //#define CALL_MEMBER_FN(object,ptrToMember)  ((object).*(ptrToMember))
      output += ((**cand).*(func))();
    }
    return output;
  }

template<typename InputIterator> reco::Candidate::LorentzVector sumPFCandP4(
    InputIterator begin, InputIterator end) {
  return sumPFVector(begin, end, &PFCandidate::p4,
      reco::Candidate::LorentzVector());
}

template<typename InputIterator> double sumPFCandPt(InputIterator begin,
    InputIterator end) {
    return sumPFVector(begin, end, &PFCandidate::pt, 0.0);
  }

template<typename InputIterator> int sumPFCandCharge(InputIterator begin,
    InputIterator end) {
    return sumPFVector(begin, end, &PFCandidate::charge, 0);
  }

template<typename InputIterator> InputIterator leadPFCand(InputIterator begin,
    InputIterator end) {
    double max_pt = 0;
    InputIterator max_cand = begin;
    for(InputIterator cand = begin; cand != end; ++cand) {
      if( (*cand)->pt() > max_pt ) {
        max_pt = (*cand)->pt();
        max_cand = cand;
      }
    }
    return max_cand;
  }
}}  // end namespace reco::tau
#endif