CMS 3D CMS Logo

Public Member Functions | Private Member Functions | Private Attributes

pat::ObjectSpatialResolution< T > Class Template Reference

Energy scale shifting and smearing module. More...

#include <PhysicsTools/PatAlgos/interface/ObjectSpatialResolution.h>

Inheritance diagram for pat::ObjectSpatialResolution< T >:
edm::EDProducer edm::ProducerBase edm::ProductRegistryHelper

List of all members.

Public Member Functions

 ObjectSpatialResolution (const edm::ParameterSet &iConfig)
 ~ObjectSpatialResolution ()

Private Member Functions

virtual void produce (edm::Event &iEvent, const edm::EventSetup &iSetup)
void smearAngles (T &object)

Private Attributes

CLHEP::RandGaussQ * gaussian_
double iniResPhi_
double iniResPolar_
edm::InputTag objects_
bool useDefaultIniRes_
bool usePolarTheta_
bool useWorsenResPhiByFactor_
bool useWorsenResPolarByFactor_
double worsenResPhi_
double worsenResPolar_

Detailed Description

template<class T>
class pat::ObjectSpatialResolution< T >

Energy scale shifting and smearing module.

This class provides angular smearing to objects with resolutions for systematic error studies. A detailed documentation is found in PhysicsTools/PatAlgos/data/ObjectSpatialResolution.cfi

Author:
Volker Adler
Version:
Id:
ObjectSpatialResolution.h,v 1.3 2010/10/20 23:09:25 wmtan Exp

Definition at line 42 of file ObjectSpatialResolution.h.


Constructor & Destructor Documentation

template<class T >
pat::ObjectSpatialResolution< T >::ObjectSpatialResolution ( const edm::ParameterSet iConfig) [explicit]

Definition at line 74 of file ObjectSpatialResolution.h.

References edm::ParameterSet::getParameter().

{
  objects_                   = iConfig.getParameter<edm::InputTag>("movedObject");
  useDefaultIniRes_          = iConfig.getParameter<bool>         ("useDefaultInitialResolutions");
  iniResPhi_                 = iConfig.getParameter<double>       ("initialResolutionPhi");
  worsenResPhi_              = iConfig.getParameter<double>       ("worsenResolutionPhi");
  useWorsenResPhiByFactor_   = iConfig.getParameter<bool>         ("worsenResolutionPhiByFactor");
  usePolarTheta_             = iConfig.getParameter<bool>         ("usePolarTheta");
  iniResPolar_               = iConfig.getParameter<double>       ("initialResolutionPolar");
  worsenResPolar_            = iConfig.getParameter<double>       ("worsenResolutionPolar");
  useWorsenResPolarByFactor_ = iConfig.getParameter<bool>         ("worsenResolutionPolarByFactor");

  edm::Service<edm::RandomNumberGenerator> rng;
  CLHEP::HepRandomEngine& engine = rng->getEngine();
  gaussian_ = new CLHEP::RandGaussQ(engine);

  produces<std::vector<T> >();
}

Definition at line 95 of file ObjectSpatialResolution.h.

{
  delete gaussian_;
}

Member Function Documentation

template<class T >
void pat::ObjectSpatialResolution< T >::produce ( edm::Event iEvent,
const edm::EventSetup iSetup 
) [private, virtual]

Implements edm::EDProducer.

Definition at line 102 of file ObjectSpatialResolution.h.

References edm::Event::getByLabel(), i, and edm::Event::put().

{
  edm::Handle<std::vector<T> > objectsHandle;
  iEvent.getByLabel(objects_, objectsHandle);
  std::vector<T> objects = *objectsHandle;
  std::auto_ptr<std::vector<T> > objectsVector(new std::vector<T>);
  objectsVector->reserve(objectsHandle->size());

  for ( unsigned int i = 0; i < objects.size(); i++ ) {
    smearAngles(objects[i]);
    objectsVector->push_back(objects[i]);
  }
  iEvent.put(objectsVector);
}
template<class T >
void pat::ObjectSpatialResolution< T >::smearAngles ( T object) [private]

Sets initial resolution to resolution provided by input object if required, smears eta/theta and phi and sets the 4-vector accordingl.

Definition at line 121 of file ObjectSpatialResolution.h.

References relval_parameters_module::energy, eta(), funct::exp(), funct::log(), M_PI, normalizedPhi(), AlCaHLTBitMon_ParallelJobs::p, funct::pow(), funct::sin(), mathSSE::sqrt(), funct::tan(), and theta().

{
  // overwrite config file parameters 'initialResolution...' if required
  if ( useDefaultIniRes_ ) {
    // get initial resolutions from input object
    iniResPhi_   = object.resolutionPhi();    // overwrites config file parameter "initialResolution"
    iniResPolar_ = usePolarTheta_      ?
                   object.resolutionTheta():
                   object.resolutionEta();    // overwrites config file parameter "initialResolution"
  }
  // smear phi
  double finalResPhi = useWorsenResPhiByFactor_                            ?
                       (1.+fabs(1.-fabs(worsenResPhi_))) * fabs(iniResPhi_):
                       fabs(worsenResPhi_) + fabs(iniResPhi_);               // conversions as protection from "finalRes_<iniRes_"
  double smearedPhi = normalizedPhi( gaussian_->fire(object.phi(), sqrt(std::pow(finalResPhi,2)-std::pow(iniResPhi_,2))) );
  double finalResPolar = useWorsenResPolarByFactor_                              ?
                         (1.+fabs(1.-fabs(worsenResPolar_))) * fabs(iniResPolar_):
                         fabs(worsenResPolar_) + fabs(iniResPolar_);               // conversions as protection from "finalRes_<iniRes_"
  // smear theta/eta
  const double thetaMin = 2.*atan(exp(-ROOT::Math::etaMax<double>())); // to be on the safe side; however, etaMax=22765 ==> thetaMin=0 within double precision
  double smearedTheta,
         smearedEta;
  if ( usePolarTheta_ ) {
    smearedTheta = gaussian_->fire(object.theta(), sqrt(std::pow(finalResPolar,2)-std::pow(iniResPolar_,2)));
    // 0<theta<Pi needs to be assured to have proper calculation of eta
    while ( fabs(smearedTheta) > M_PI ) smearedTheta = smearedTheta < 0.     ?
                                                       smearedTheta + 2.*M_PI:
                                                       smearedTheta - 2.*M_PI;
    if ( smearedTheta < 0. ) {
      smearedTheta = -smearedTheta;
      smearedPhi   = normalizedPhi(smearedPhi+M_PI);
    }
    smearedEta = smearedTheta < thetaMin          ?
                 ROOT::Math::etaMax<double>()     :
                 ( smearedTheta > M_PI-thetaMin ?
                   -ROOT::Math::etaMax<double>():
                   -log(tan(smearedTheta/2.))    ); // eta not calculable for theta=0,Pi, which could occur
  } else {
    smearedEta = gaussian_->fire(object.eta(), sqrt(std::pow(finalResPolar,2)-std::pow(iniResPolar_,2)));
    if ( fabs(smearedEta) > ROOT::Math::etaMax<double>() ) smearedEta = smearedEta < 0.              ?
                                                                        -ROOT::Math::etaMax<double>():
                                                                         ROOT::Math::etaMax<double>();
    smearedTheta = 2. * atan(exp(-smearedEta)); // since exp(x)>0 && atan() returns solution closest to 0, 0<theta<Pi should be assured.
  }
  // set smeared new 4-vector
  math::PtEtaPhiELorentzVector newLorentzVector(object.p()*sin(smearedTheta),
                                                smearedEta,
                                                smearedPhi,
                                                object.energy());
  object.setP4(reco::Particle::LorentzVector(newLorentzVector.Px(),
                                             newLorentzVector.Py(),
                                             newLorentzVector.Pz(),
                                             newLorentzVector.E() ));
}

Member Data Documentation

template<class T >
CLHEP::RandGaussQ* pat::ObjectSpatialResolution< T >::gaussian_ [private]

Definition at line 65 of file ObjectSpatialResolution.h.

template<class T >
double pat::ObjectSpatialResolution< T >::iniResPhi_ [private]

Definition at line 56 of file ObjectSpatialResolution.h.

template<class T >
double pat::ObjectSpatialResolution< T >::iniResPolar_ [private]

Definition at line 56 of file ObjectSpatialResolution.h.

template<class T >
edm::InputTag pat::ObjectSpatialResolution< T >::objects_ [private]

Definition at line 55 of file ObjectSpatialResolution.h.

template<class T >
bool pat::ObjectSpatialResolution< T >::useDefaultIniRes_ [private]

Definition at line 60 of file ObjectSpatialResolution.h.

template<class T >
bool pat::ObjectSpatialResolution< T >::usePolarTheta_ [private]

Definition at line 60 of file ObjectSpatialResolution.h.

template<class T >
bool pat::ObjectSpatialResolution< T >::useWorsenResPhiByFactor_ [private]

Definition at line 60 of file ObjectSpatialResolution.h.

template<class T >
bool pat::ObjectSpatialResolution< T >::useWorsenResPolarByFactor_ [private]

Definition at line 60 of file ObjectSpatialResolution.h.

template<class T >
double pat::ObjectSpatialResolution< T >::worsenResPhi_ [private]

Definition at line 56 of file ObjectSpatialResolution.h.

template<class T >
double pat::ObjectSpatialResolution< T >::worsenResPolar_ [private]

Definition at line 56 of file ObjectSpatialResolution.h.