pat::PATUserDataHelper< ObjectType > Class Template Reference

Assists in assimilating all pat::UserData into pat objects. More...

#include "PhysicsTools/PatAlgos/interface/PATUserDataHelper.h"

Public Types
typedef StringObjectFunction< ObjectType >	function_type

Public Member Functions
void	add (ObjectType &patObject, edm::Event const &iEvent, edm::EventSetup const &iSetup)
	PATUserDataHelper ()
	PATUserDataHelper (const edm::ParameterSet &iConfig, edm::ConsumesCollector &&iC)
	~PATUserDataHelper ()

Static Public Member Functions
static void	fillDescription (edm::ParameterSetDescription &iDesc)

Private Attributes
std::vector< std::string >	functionLabels_
std::vector< std::string >	functionNames_
std::vector< function_type >	functions_
pat::PATUserDataMerger< ObjectType, pat::helper::AddUserCand >	userCandMerger_
pat::PATUserDataMerger< ObjectType, pat::helper::AddUserPtr >	userDataMerger_
pat::PATUserDataMerger< ObjectType, pat::helper::AddUserFloat >	userFloatMerger_
pat::PATUserDataMerger< ObjectType, pat::helper::AddUserInt >	userIntMerger_

Detailed Description

template<class ObjectType>
class pat::PATUserDataHelper< ObjectType >

Assists in assimilating all pat::UserData into pat objects.

This will pull the following from the event stream (if they exist) and put them into the object in question, all indexed by the reco objects that make up the pat objects in question:

ValueMap<double> ValueMap<int> ValueMap<Ptr<UserData> > ValueMap<CandidatePtr>

This is accomplished by using PATUserDataMergers.

This also can add "in situ" string-parser-based methods directly.

Author

Salvatore Rappoccio

Version

Id

PATUserDataHelper.h,v 1.8 2010/02/20 21:00:13 wmtan Exp

Definition at line 48 of file PATUserDataHelper.h.

Member Typedef Documentation

function_type

template<class ObjectType>

typedef StringObjectFunction<ObjectType> pat::PATUserDataHelper< ObjectType >::function_type

Definition at line 50 of file PATUserDataHelper.h.

Constructor & Destructor Documentation

PATUserDataHelper() [1/2]

template<class ObjectType>

pat::PATUserDataHelper< ObjectType >::PATUserDataHelper ( )

inline

Definition at line 52 of file PATUserDataHelper.h.

{}

PATUserDataHelper() [2/2]

template<class ObjectType >

pat::PATUserDataHelper< ObjectType >::PATUserDataHelper	(	const edm::ParameterSet &	iConfig,
		edm::ConsumesCollector &&	iC
	)

Definition at line 80 of file PATUserDataHelper.h.

      : userDataMerger_(iConfig.getParameter<edm::ParameterSet>("userClasses"), iC),
        userFloatMerger_(iConfig.getParameter<edm::ParameterSet>("userFloats"), iC),
        userIntMerger_(iConfig.getParameter<edm::ParameterSet>("userInts"), iC),
        userCandMerger_(iConfig.getParameter<edm::ParameterSet>("userCands"), iC),
        functionNames_(iConfig.getParameter<std::vector<std::string> >("userFunctions")),
        functionLabels_(iConfig.getParameter<std::vector<std::string> >("userFunctionLabels")) {
    // Make sure the sizes match
    if (functionNames_.size() != functionLabels_.size()) {
      throw cms::Exception("Size mismatch")
          << "userFunctions and userFunctionLabels do not have the same size, they must be the same\n";
    }
    // Loop over the function names, create a new string-parser function object
    // with all of them. This operates on ObjectType
    std::vector<std::string>::const_iterator funcBegin = functionNames_.begin(), funcEnd = functionNames_.end(),
                                             funcIt = funcBegin;
    for (; funcIt != funcEnd; ++funcIt) {
      functions_.push_back(StringObjectFunction<ObjectType>(*funcIt));
    }
  }

~PATUserDataHelper()

template<class ObjectType>

pat::PATUserDataHelper< ObjectType >::~PATUserDataHelper ( )

inline

Definition at line 54 of file PATUserDataHelper.h.

{}

Member Function Documentation

add()

template<class ObjectType>

void pat::PATUserDataHelper< ObjectType >::add	(	ObjectType &	patObject,
		edm::Event const &	iEvent,
		edm::EventSetup const &	iSetup
	)

Definition at line 113 of file PATUserDataHelper.h.

Referenced by pat::PATCompositeCandidateProducer::produce(), pat::PATGenericParticleProducer::produce(), pat::PATMETProducer::produce(), pat::PATJetUpdater::produce(), pat::PATPFParticleProducer::produce(), pat::PATPhotonProducer::produce(), pat::PATTauProducer::produce(), pat::PATJetProducer::produce(), pat::PATElectronProducer::produce(), pat::PATMuonProducer::produce(), and counter.Counter::register().

                                                                       {
    // Add "complex" user data to the PAT object
    userDataMerger_.add(patObject, iEvent, iSetup);
    userFloatMerger_.add(patObject, iEvent, iSetup);
    userIntMerger_.add(patObject, iEvent, iSetup);
    userCandMerger_.add(patObject, iEvent, iSetup);

    // Add "inline" user-selected functions to the PAT object
    typename std::vector<function_type>::const_iterator funcBegin = functions_.begin(), funcEnd = functions_.end(),
                                                        funcIt = funcBegin;
    if (functionLabels_.size() == functions_.size()) {
      for (; funcIt != funcEnd; ++funcIt) {
        double d = (*funcIt)(patObject);
        patObject.addUserFloat(functionLabels_[funcIt - funcBegin], d);
      }
    }
  }

fillDescription()

template<class ObjectType >

void pat::PATUserDataHelper< ObjectType >::fillDescription ( edm::ParameterSetDescription &  iDesc )

static

Definition at line 134 of file PATUserDataHelper.h.

Referenced by pat::PATMETProducer::fillDescriptions(), pat::PATJetUpdater::fillDescriptions(), pat::PATPhotonProducer::fillDescriptions(), pat::PATTauProducer::fillDescriptions(), pat::PATJetProducer::fillDescriptions(), pat::PATElectronProducer::fillDescriptions(), and pat::PATMuonProducer::fillDescriptions().

                                                                                       {
    edm::ParameterSetDescription dataMergerPSet;
    pat::PATUserDataMerger<ObjectType, pat::helper::AddUserPtr>::fillDescription(dataMergerPSet);
    iDesc.add("userClasses", dataMergerPSet);
    iDesc.add("userFloats", dataMergerPSet);
    iDesc.add("userInts", dataMergerPSet);
    iDesc.add("userCands", dataMergerPSet);
    std::vector<std::string> emptyVectorOfStrings;
    iDesc.add<std::vector<std::string> >("userFunctions", emptyVectorOfStrings);
    iDesc.add<std::vector<std::string> >("userFunctionLabels", emptyVectorOfStrings);
  }

Member Data Documentation

functionLabels_

template<class ObjectType>

std::vector<std::string> pat::PATUserDataHelper< ObjectType >::functionLabels_

private

Definition at line 74 of file PATUserDataHelper.h.

functionNames_

template<class ObjectType>

std::vector<std::string> pat::PATUserDataHelper< ObjectType >::functionNames_

private

Definition at line 73 of file PATUserDataHelper.h.

functions_

template<class ObjectType>

std::vector<function_type> pat::PATUserDataHelper< ObjectType >::functions_

private

Definition at line 75 of file PATUserDataHelper.h.

userCandMerger_

template<class ObjectType>

pat::PATUserDataMerger<ObjectType, pat::helper::AddUserCand> pat::PATUserDataHelper< ObjectType >::userCandMerger_

private

Definition at line 70 of file PATUserDataHelper.h.

userDataMerger_

template<class ObjectType>

pat::PATUserDataMerger<ObjectType, pat::helper::AddUserPtr> pat::PATUserDataHelper< ObjectType >::userDataMerger_

private

Definition at line 64 of file PATUserDataHelper.h.

userFloatMerger_

template<class ObjectType>

pat::PATUserDataMerger<ObjectType, pat::helper::AddUserFloat> pat::PATUserDataHelper< ObjectType >::userFloatMerger_

private

Definition at line 66 of file PATUserDataHelper.h.

userIntMerger_

template<class ObjectType>

pat::PATUserDataMerger<ObjectType, pat::helper::AddUserInt> pat::PATUserDataHelper< ObjectType >::userIntMerger_

private

Definition at line 68 of file PATUserDataHelper.h.