Public Member Functions | Private Attributes | List of all members
ana::ISyst Class Reference

Encapsulate code to systematically shift a caf::SRProxy. More...

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N20-12-01/CAFAna/Core/ISyst.h"

Inheritance diagram for ana::ISyst:
ana::BeamIntensitySyst ana::BeamNueScaleSyst ana::BeamSyst ana::BolombMuESyst2019 ana::ContainmentSyst ana::CorrMuEScaleSyst2019 ana::CorrMuEScaleSyst2020 ana::CosmicBkgScaleSyst ana::DirectHadEScaleSyst2017 ana::DirectRelHadEScaleSyst2017 ana::DISHighWScaleSyst ana::DummyAnaSyst ana::DummyNue2017Syst ana::DummyNumu2017Syst ana::DummyRockScaleSyst ana::EvtRNGSyst ana::GenericSystComponentScale< T > ana::GeniePCASyst ana::HadEnergyScaleSyst ana::IRescaledSigmaSyst ana::KaonScaleSyst ana::KeySyst ana::LEMScaleSyst ana::LeptonAngleSyst ana::MECDoubleGaussEnhSyst ana::MECDoubleGaussEnhSystDOWN ana::MECDoubleGaussEnhSystNux ana::MECDoubleGaussEnhSystUP ana::MECGaussEnhSyst ana::MichelTaggingSyst2018 ana::MichelTaggingSyst2020 ana::MinosResSuppSyst ana::MuEnergyScaleSyst ana::MuEScaleSyst2017 ana::MyWrongSignScale ana::NCScaleSyst ana::NCtest ana::NormSyst ana::NOvARwgtSyst ana::NueAcceptSystBkg2018FHC ana::NueAcceptSystBkg2018RHC ana::NueAcceptSystSignalKin2018FHC ana::NueAcceptSystSignalKin2018RHC ana::NueAcceptSystSignalKin2020FHC ana::NueAcceptSystSignalKin2020RHC ana::NueExtrapSystBkg2017 ana::NueExtrapSystSignalKin2017 ana::Nuetest ana::NuISyst ana::NumuCCScaleSyst ana::NumuEnergyScaleSyst ana::NumuGEANTNormSyst ana::NumuGEANTScaleSyst ana::NumuNCScaleSyst ana::NumuNormSyst ana::NumuRelEnergyScaleSyst ana::NumuRelNormSyst ana::NumuSummedSmallGENIESyst ana::NumuTauContaminationSyst ana::Numutest ana::Nus17FlatSyst ana::Nus17SystFromHist ana::Nus18BaseSyst ana::Nus18FlatSyst ana::Nus18SystFromHist ana::NusAna2020KaonSyst ana::NusAna2020TauSyst ana::NusFlatSyst ana::NusSystFromHist ana::NuWROSyst ana::PileupMuESyst2019 ana::PileupMuESyst2020 ana::RelMuEScaleSyst2017 ana::RelNormSyst ana::RemIDScaleSyst ana::RockMuonNormSyst ana::SummedSyst ana::SystFromWeight ana::UnCorrFDMuEScaleSyst2019 ana::UnCorrFDMuEScaleSyst2020 ana::UnCorrMuCatMuESyst2019 ana::UnCorrMuCatMuESyst2020 ana::UnCorrNDMuEScaleSyst2019 ana::UnCorrNDMuEScaleSyst2020 ana::WrongSignContamination ana::WrongSignEnergyBin ana::WrongSignEnergyBinRHC ana::WrongSignScale ana::WrongSignScale100 demo::DemoSyst1 demo::DemoSyst2 jw::IRescaledSigmaSyst test::QuadraticParameter

Public Member Functions

 ISyst (const std::string &shortName, const std::string &latexName)
 
 ISyst (const ISyst &)=delete
 
 ISyst (ISyst &&rhs)=delete
 
virtual ~ISyst ()
 
ISystoperator= (const ISyst &)=delete
 
ISystoperator= (ISyst &&)=delete
 
virtual const std::stringShortName () const final
 The name printed out to the screen. More...
 
virtual const std::stringLatexName () const final
 The name used on plots (ROOT's TLatex syntax) More...
 
virtual void Shift (double sigma, caf::SRProxy *sr, double &weight) const
 Perform the systematic shift. More...
 
virtual void TruthShift (double sigma, caf::SRNeutrinoProxy *nu, double &weight) const
 
virtual bool IsGenieReweight () const
 GENIE reweights can only provide +/-1,2sigma. More...
 

Private Attributes

std::string fShortName
 
std::string fLatexName
 

Detailed Description

Encapsulate code to systematically shift a caf::SRProxy.

The Shift() function alters the caf::StandardRecord or the weight associated with the event.

Definition at line 14 of file ISyst.h.

Constructor & Destructor Documentation

ana::ISyst::ISyst ( const std::string shortName,
const std::string latexName 
)

Definition at line 10 of file ISyst.cxx.

References ana::Registry< T >::Register().

12  : fShortName(shortName), fLatexName(latexName)
13  {
15  }
static void Register(const T *s)
Definition: Registry.cxx:20
std::string fLatexName
Definition: ISyst.h:60
std::string fShortName
Definition: ISyst.h:59
string shortName
THUMBNAIL BLOCK: We need to make a thumbnail for each.
ana::ISyst::ISyst ( const ISyst )
delete
ana::ISyst::ISyst ( ISyst &&  rhs)
delete
ana::ISyst::~ISyst ( )
virtual

Definition at line 18 of file ISyst.cxx.

References ana::Registry< T >::UnRegister().

19  {
20  // Normally ISysts should last for the life of the process, but in case one
21  // is deleted it's best not to leave a dangling pointer in Registry.
23  }
static void UnRegister(const T *s)
Definition: Registry.cxx:44

Member Function Documentation

virtual bool ana::ISyst::IsGenieReweight ( ) const
inlinevirtual

GENIE reweights can only provide +/-1,2sigma.

Reimplemented in ana::SummedSyst.

Definition at line 56 of file ISyst.h.

56 {return false;}
virtual const std::string& ana::ISyst::LatexName ( ) const
inlinefinalvirtual

The name used on plots (ROOT's TLatex syntax)

Definition at line 30 of file ISyst.h.

References fLatexName, Shift(), sigma(), sr, and ana::weight.

Referenced by ana::PredictionInterp::DebugPlotColz(), GetGENIEShiftLabels(), ana::NuISyst::SaveTo(), SystsGENIEAna(), and WriteSystName().

30 {return fLatexName;}
std::string fLatexName
Definition: ISyst.h:60
ISyst& ana::ISyst::operator= ( const ISyst )
delete
ISyst& ana::ISyst::operator= ( ISyst &&  )
delete
void ana::ISyst::Shift ( double  sigma,
caf::SRProxy sr,
double &  weight 
) const
virtual

Perform the systematic shift.

Override this function if your systematic depends on non-SRNeutrino quantities. If it is SRNeutrino-only, implement the other function, and let this default forward to you when necessary.

Parameters
sigmaNumber of sigma to shift record by
srThe record to inspect and alter
weightScale this weight for reweighting systematics

Reimplemented in ana::MinosResSuppSyst, ana::MECDoubleGaussEnhSystDOWN, ana::MECDoubleGaussEnhSystUP, ana::MECDoubleGaussEnhSyst, ana::MECGaussEnhSyst, ana::MECDoubleGaussEnhSystNux, jw::MECInitStateNPFracShift, jw::CompNormSyst, ana::CompNormSyst, ana::BolombMuESyst2019, ana::DISHighWScaleSyst, ana::ContainmentSyst, ana::PileupMuESyst2019, ana::PileupMuESyst2020, ana::NumuRelEnergyScaleSyst, ana::RockMuonNormSyst, ana::NumuEnergyScaleSyst, ana::RemIDScaleSyst, ana::UnCorrMuCatMuESyst2019, ana::LEMScaleSyst, ana::NumuRelNormSyst, ana::UnCorrMuCatMuESyst2020, demo::DemoSyst2, ana::DirectRelHadEScaleSyst2017, ana::BeamIntensitySyst, ana::NumuNormSyst, ana::Nus18BaseSyst, ana::UnCorrNDMuEScaleSyst2019, ana::KaonScaleSyst, ana::FDMuEnergyScaleSyst, ana::UnCorrNDMuEScaleSyst2020, ana::NumuTauContaminationSyst, ana::MyWrongSignScale, ana::NueAcceptSystSignalKin2020RHC, ana::DirectHadEScaleSyst2017, ana::NumuCCScaleSyst, ana::Nus18FlatSyst, ana::FDHadEnergyScaleSyst, ana::NumuNCScaleSyst, ana::NueAcceptSystSignalKin2018RHC, ana::BeamNueScaleSyst, ana::NueAcceptSystBkg2018RHC, ana::UnCorrFDMuEScaleSyst2019, ana::UnCorrFDMuEScaleSyst2020, ana::MuEnergyScaleSyst, ana::WrongSignScale100, ana::NCScaleSyst, ana::NusFlatSyst, ana::RelMuEScaleSyst2017, ana::Nus17FlatSyst, ana::Numutest, ana::NumuSummedSmallGENIESyst, ana::Nus18SystFromHist, ana::NueAcceptSystSignalKin2020FHC, ana::WrongSignEnergyBin, ana::RelNormSyst, ana::MichelTaggingSyst2018, ana::Nuetest, ana::NusAna2020TauSyst, ana::GenericSystComponentScale< T >, ana::CorrMuEScaleSyst2019, ana::CorrMuEScaleSyst2020, ana::NumuGEANTScaleSyst, ana::GenericSystComponentScale< T >, ana::HadEnergyScaleSyst, ana::NueAcceptSystSignalKin2018FHC, ana::NormSyst, ana::WrongSignEnergyBinRHC, ana::NuWROSyst, ana::GenericSystComponentScale< T >, ana::LeptonAngleSyst, ana::NueExtrapSystSignalKin2017, ana::SystFromWeight, ana::MuEScaleSyst2017, ana::NCtest, ana::NusSystFromHist, ana::NueSyst, ana::Nus17SystFromHist, ana::SummedSyst, ana::DummyNue2017Syst, ana::DummyNumu2017Syst, ana::GeniePCASyst, ana::NueAcceptSystBkg2018FHC, ana::NumuGEANTNormSyst, ana::NusAna2020KaonSyst, ana::DummyAnaSyst, ana::NeutronVisEScaleSyst2018, ana::NueExtrapSystBkg2017, ana::DummyRockScaleSyst, ana::MichelTaggingSyst2020, ana::CosmicBkgScaleSyst, ana::WrongSignScale, ana::WrongSignContamination, ana::NCSyst, and ana::NumuSyst.

Definition at line 26 of file ISyst.cxx.

References caf::Proxy< caf::StandardRecord >::mc, caf::Proxy< caf::SRTruthBranch >::nnu, caf::Proxy< caf::SRTruthBranch >::nu, and TruthShift().

Referenced by fnex::CAFToEventList::FillMCVarVals(), LatexName(), and ana::GenericSystComponentScale< T >::Shift().

27  {
28  // Override this function if your systematic depends on non-SRNeutrino
29  // quantities. If it is SRNeutrino-only, implement the other function,
30  // and let this default forward to you when necessary.
31  if(sr->mc.nnu > 0) TruthShift(sigma, &sr->mc.nu[0], weight);
32  }
const Var weight
caf::Proxy< std::vector< caf::SRNeutrino > > nu
Definition: SRProxy.h:618
caf::Proxy< short int > nnu
Definition: SRProxy.h:617
virtual void TruthShift(double sigma, caf::SRNeutrinoProxy *nu, double &weight) const
Definition: ISyst.h:46
double sigma(TH1F *hist, double percentile)
caf::Proxy< caf::SRTruthBranch > mc
Definition: SRProxy.h:2138
virtual const std::string& ana::ISyst::ShortName ( ) const
inlinefinalvirtual
virtual void ana::ISyst::TruthShift ( double  sigma,
caf::SRNeutrinoProxy nu,
double &  weight 
) const
inlinevirtual

For systematics that deal only with the neutrino truth and not any reconstruction/PID details. Systematics defined this way will work on nuTree-derived spectra too (e.g. denominators of efficiencies).

Reimplemented in demo::DemoSyst1, ana::BeamSyst, ana::GenericSystComponentScale< T >, ana::GenericSystComponentScale< T >, ana::GenericSystComponentScale< T >, and ana::NOvARwgtSyst.

Definition at line 46 of file ISyst.h.

Referenced by Shift().

49  {
50  // Implement this function if your systematic depends only
51  // SRNeutrino. Left blank by default, since systematics using other
52  // information can do nothing sensible to the nuTree.
53  }

Member Data Documentation

std::string ana::ISyst::fLatexName
private

Definition at line 60 of file ISyst.h.

Referenced by LatexName().

std::string ana::ISyst::fShortName
private

Definition at line 59 of file ISyst.h.

Referenced by ShortName().


The documentation for this class was generated from the following files: