PhysicsTools/CandUtils/interface/EventShapeVariables.h - master - githubmirror/cmssw

PhysicsTools/CandUtils/interface/EventShapeVariables.h
120 строк5 KB
Shahzad Malik Muzaffar
[ANALYSIS] Changes suggested by new llvm18 clang-format
05 сен 2024, 17:04
05 сен 2024, 17:04a467cd9
#ifndef EventShapeVariables_h
#define EventShapeVariables_h

/**
   \class   EventShapeVariables EventShapeVariables.h "PhysicsTools/CandUtils/interface/EventShapeVariables.h"

   \brief   Class for the calculation of several event shape variables

   Class for the calculation of several event shape variables. Isotropy, sphericity,
   aplanarity and circularity are supported. The class supports vectors of 3d vectors
   and edm::Views of reco::Candidates as input. The 3d vectors can be given in 
   cartesian, cylindrical or polar coordinates. It exploits the ROOT::TMatrixDSym 
   for the calculation of the sphericity and aplanarity.

   See https://arxiv.org/pdf/hep-ph/0603175v2.pdf#page=524
   for an explanation of sphericity, aplanarity and the quantities C and D.

   Author: Sebastian Naumann-Emme, University of Hamburg
           Roger Wolf, University of Hamburg
	   Christian Veelken, UC Davis
*/

#include "DataFormats/Math/interface/Vector3D.h"
#include "DataFormats/Candidate/interface/Candidate.h"
#include "DataFormats/Candidate/interface/CandidateFwd.h"

#include "TMatrixDSym.h"
#include "TVectorD.h"

#include <vector>

class EventShapeVariables {
public:
  /// constructor from reco::Candidates
  explicit EventShapeVariables(const edm::View<reco::Candidate>& inputVectors);
  /// constructor from XYZ coordinates
  explicit EventShapeVariables(const std::vector<math::XYZVector>& inputVectors);
  /// constructor from rho eta phi coordinates
  explicit EventShapeVariables(const std::vector<math::RhoEtaPhiVector>& inputVectors);
  /// constructor from r theta phi coordinates
  explicit EventShapeVariables(const std::vector<math::RThetaPhiVector>& inputVectors);
  /// default destructor
  ~EventShapeVariables() {}

  /// the return value is 1 for spherical events and 0 for events linear in r-phi. This function
  /// needs the number of steps to determine how fine the granularity of the algorithm in phi
  /// should be
  double isotropy(const unsigned int& numberOfSteps = 1000) const;

  /// the return value is 1 for spherical and 0 linear events in r-phi. This function needs the
  /// number of steps to determine how fine the granularity of the algorithm in phi should be
  double circularity(const unsigned int& numberOfSteps = 1000) const;

  /// set exponent for computation of momentum tensor and related products
  void set_r(double r);

  /// set number of Fox-Wolfram moments to compute
  void setFWmax(unsigned m);

  /// 1.5*(q1+q2) where q0>=q1>=q2>=0 are the eigenvalues of the momentum tensor
  /// sum{p_j[a]*p_j[b]}/sum{p_j**2} normalized to 1. Return values are 1 for spherical, 3/4 for
  /// plane and 0 for linear events
  double sphericity();
  /// 1.5*q2 where q0>=q1>=q2>=0 are the eigenvalues of the momentum tensor
  /// sum{p_j[a]*p_j[b]}/sum{p_j**2} normalized to 1. Return values are 0.5 for spherical and 0
  /// for plane and linear events
  double aplanarity();
  /// 3.*(q0*q1+q0*q2+q1*q2) where q0>=q1>=q2>=0 are the eigenvalues of the momentum tensor
  /// sum{p_j[a]*p_j[b]}/sum{p_j**2} normalized to 1. Return value is between 0 and 1
  /// and measures the 3-jet structure of the event (C vanishes for a "perfect" 2-jet event)
  double C();
  /// 27.*(q0*q1*q2) where q0>=q1>=q2>=0 are the eigenvalues of the momentum tensor
  /// sum{p_j[a]*p_j[b]}/sum{p_j**2} normalized to 1. Return value is between 0 and 1
  /// and measures the 4-jet structure of the event (D vanishes for a planar event)
  double D();

  const std::vector<double>& getEigenValues() {
    if (!tensors_computed_)
      compTensorsAndVectors();
    return eigenValues_;
  }
  const std::vector<double>& getEigenValuesNoNorm() {
    if (!tensors_computed_)
      compTensorsAndVectors();
    return eigenValuesNoNorm_;
  }
  const TMatrixD& getEigenVectors() {
    if (!tensors_computed_)
      compTensorsAndVectors();
    return eigenVectors_;
  }

  double getFWmoment(unsigned l);
  const std::vector<double>& getFWmoments();

private:
  /// helper function to fill the 3 dimensional momentum tensor from the inputVectors where needed
  /// also fill the 3 dimensional vectors of eigen-values and eigen-vectors;
  /// the largest (smallest) eigen-value is stored at index position 0 (2)
  void compTensorsAndVectors();

  void computeFWmoments();

  /// caching of input vectors
  std::vector<math::XYZVector> inputVectors_;

  /// caching of output
  double r_;
  bool tensors_computed_;
  TMatrixD eigenVectors_;
  TVectorD eigenValuesTmp_, eigenValuesNoNormTmp_;
  std::vector<double> eigenValues_, eigenValuesNoNorm_;

  /// Owen ; save computed Fox-Wolfram moments
  unsigned fwmom_maxl_;
  std::vector<double> fwmom_;
  bool fwmom_computed_;
};

#endif