NumSigmaPid.h

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file NumSigmaPid.h

#ifndef INCLUDE_EICSMEAR_SMEAR_NUMSIGMAPID_H
#define INCLUDE_EICSMEAR_SMEAR_NUMSIGMAPID_H

#include "eicsmear/smear/Smearer.h"
#include "PID.h"

// Based on https://gitlab.com/preghenella/pid

// A smearer needs to implement
//   virtual void Smear(const erhic::VirtualParticle&, ParticleMCS&) = 0;
// And it has an Acceptance object. 



//  Hello PID Fans:
//
//  This is the base class for a simple set of objects that 
//  are used to evaluate various detector technology choices for the EIC.
//
//  The idea is simple.  Regardless of PID detector technology choice 
//  one must be able to answer some simple questions.  This virtual base class
//  organizes the method of asking and answering these simple questions to
//  allow for efficient and apples-to-apples comparisons.
//  
//  The base class requires that any derived class procide responses to several queries:
//   -- valid   (double eta, double p                      );
//   -- numSigma(double eta, double p,        numSigmaPid::type PID);
//   -- maxP    (double eta, double numSigma, numSigmaPid::type PID);
//   -- minP    (double eta, double numSigma, numSigmaPid::type PID);
//   -- name    ();
//
//  Here numSigmaPid::type is an enumerated constant set allowing one to choose pi-vs-k or k-vs-p etc...
//
//  The detector types that inherit from numSigmaPid will clearly have parameters that define their 
//  performance and these are expected to be arguments of the constructor of those derived classes.
//  For example:
//     numSigmaPid* tof = new tofBarrel(radius, etaLow, etaHigh, sigmaT);
//
//

#include <string>
#include <memory>
  
namespace Smear {

  class NumSigmaPid : public Smearer {
  public:
    NumSigmaPid();

    virtual ~NumSigmaPid() {}
    
    void Smear(const erhic::VirtualParticle&, ParticleMCS&);

    void SetNumSigmaType( const int i );

    int GetNumSigmaType( ) const;

    NumSigmaPid* Clone(const char* = "") const;

    bool valid  (double eta, double p ) const;

    double maxP (double eta, double numSigma, PID::type PID) const;

    double minP (double eta, double numSigma, PID::type PID) const;

    std::string name() const;

    void description() const;

  protected:
    std::shared_ptr<PID> ThePidObject;
    int NumSigmaType=-1;
    PID::type EnumType;
  };

}
#endif // INCLUDE_EICSMEAR_SMEAR_NUMSIGMAPID_H