Compare a single data spectrum to the MC + cosmics expectation. More...

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N19-12-08/CAFAna/Experiment/SingleSampleExperiment.h"

Inheritance diagram for ana::SingleSampleExperiment:

Public Member Functions
	SingleSampleExperiment (const IPrediction *pred, const Spectrum &data, const Spectrum &cosmic, double cosmicScaleError=0)

	SingleSampleExperiment (const IPrediction pred, const Spectrum &data, const TH1D cosmic, double cosmicScaleError=0, double fromlivetime=1., double topotlivetime=1.)
	Fallback to manual cosmic scaling. More...

	SingleSampleExperiment (const IPrediction *pred, const Spectrum &data)
	In MC studies you might not want to bother with cosmics. More...

virtual	~SingleSampleExperiment ()

virtual double	ChiSq (osc::IOscCalculatorAdjustable *osc, const SystShifts &syst=SystShifts::Nominal()) const override

virtual void	Derivative (osc::IOscCalculator calc, const SystShifts &shift, std::unordered_map< const ISyst , double > &dch) const override

virtual void	SaveTo (TDirectory *dir) const override

	SingleSampleExperiment (const SingleSampleExperiment &)=delete

SingleSampleExperiment &	operator= (const SingleSampleExperiment &)=delete

	SingleSampleExperiment (SingleSampleExperiment &&s)

Static Public Member Functions
static std::unique_ptr< SingleSampleExperiment >	LoadFrom (TDirectory *dir)

Protected Member Functions
TH1D *	PredHistIncCosmics (osc::IOscCalculator *calc, const SystShifts &syst) const

Protected Attributes
const IPrediction *	fMC

Spectrum	fData

TH1D *	fCosmic

double	fCosmicScaleError

Detailed Description

Compare a single data spectrum to the MC + cosmics expectation.

Definition at line 21 of file SingleSampleExperiment.h.

Constructor & Destructor Documentation

ana::SingleSampleExperiment::SingleSampleExperiment	(	const IPrediction *	pred,
		const Spectrum &	data,
		const Spectrum &	cosmic,
		double	cosmicScaleError = `0`
	)

Parameters

pred	Source of oscillated MC beam predictions
data	Data spectrum to compare to
cosmic	Cosmic ray background component
cosmicScaleError	fractional uncertainty on cosmic normalization

Definition at line 18 of file SingleSampleExperiment.cxx.

     : fMC(pred), fData(data),
       fCosmic(cosmic.ToTH1(data.Livetime(), kLivetime)),
       fCosmicScaleError(cosmicScaleError)
   {
   }

ana::SingleSampleExperiment::SingleSampleExperiment	(	const IPrediction *	pred,
		const Spectrum &	data,
		const TH1D *	cosmic,
		double	cosmicScaleError = `0`,
		double	fromlivetime = `1.`,
		double	topotlivetime = `1.`
	)

Fallback to manual cosmic scaling.

cosmic must be already scaled so that its bin contents can be directly summed onto data. If you're using the out-of-time part of the beam spill, the easiest thing to do is to pass kTimingSidebandWeight as the weight argument when you fill it.

Definition at line 29 of file SingleSampleExperiment.cxx.

References om::cout, allTimeWatchdog::endl, and fCosmic.

     : fMC(pred), fData(data), fCosmic(HistCache::Copy(cosmic)),
       fCosmicScaleError(cosmicScaleError)
   {
     //default for backward capacity 
     if(fromlivetime ==1 && tolivetime ==1){
 //      std::cout<< "Single Experiment Warning: using TH1D for cosmic, please double check POT/Livetime... And switch to Spectrum if possible."<<std::endl;
     }
     //other cases, always positive livetimes
     else if(fromlivetime > 0 && tolivetime > 0){
 
       std::cout<<"Single Experiment rescaling cosmic Livetime from: "<<
                  fromlivetime<<" to: "<<
                  tolivetime<<
                  "Please use Spectrum for cosmic next time."<<std::endl;
 
       fCosmic->Scale(tolivetime/fromlivetime);
     }
     // others not allowed
     else{
       std::cout<<"Single Experiment Warning: please double check cosmic POT/Livetime setting."<<std::endl;
       abort();
     }
 
   }

ana::SingleSampleExperiment::SingleSampleExperiment	(	const IPrediction *	pred,
		const Spectrum &	data
	)

inline

In MC studies you might not want to bother with cosmics.

Definition at line 47 of file SingleSampleExperiment.h.

References calc, dir, ana::LoadFrom(), ana::SystShifts::Nominal(), ana::ISyst::operator=(), ana::SaveTo(), plotSysts::shift, and plotSysts::syst.

       : fMC(pred), fData(data), fCosmic(0)
     {
     }

ana::SingleSampleExperiment::~SingleSampleExperiment ( )

virtual

Definition at line 61 of file SingleSampleExperiment.cxx.

References ana::HistCache::Delete(), fCosmic, and PredHistIncCosmics().

   {
     HistCache::Delete(fCosmic);
   }

ana::SingleSampleExperiment::SingleSampleExperiment ( const SingleSampleExperiment & )

delete

ana::SingleSampleExperiment::SingleSampleExperiment ( SingleSampleExperiment && s )

inline

Definition at line 70 of file SingleSampleExperiment.h.

References plotSysts::syst.

       : fMC(s.fMC), fData(std::move(s.fData)), fCosmic(s.fCosmic), fCosmicScaleError(s.fCosmicScaleError)
     {
       s.fMC = nullptr;
       s.fCosmic = nullptr;
       s.fCosmicScaleError = 0;
     };

Member Function Documentation

double ana::SingleSampleExperiment::ChiSq	(	osc::IOscCalculatorAdjustable *	osc,
		const SystShifts &	syst = `SystShifts::Nominal()`
	)		const

overridevirtual

Implements ana::IChiSqExperiment.

Reimplemented in ana::BigChi2SingleSampleExperiment, and ana::CovMxExperiment.

Definition at line 92 of file SingleSampleExperiment.cxx.

References ana::HistCache::Delete(), Derivative(), fData, chisquared::hpred, ana::LogLikelihood(), ana::Spectrum::POT(), PredHistIncCosmics(), and ana::Spectrum::ToTH1().

Referenced by ana::BigChi2SingleSampleExperiment::ChiSq().

   {
     TH1D* hpred = PredHistIncCosmics(calc, syst);
     TH1D* hdata = fData.ToTH1(fData.POT());
 
     const double ll = LogLikelihood(hpred, hdata);
 
     HistCache::Delete(hpred);
     HistCache::Delete(hdata);
 
     return ll;
   }

void ana::SingleSampleExperiment::Derivative	(	osc::IOscCalculator *	calc,
		const SystShifts &	shift,
		std::unordered_map< const ISyst *, double > &	dch
	)		const

overridevirtual

Reimplemented from ana::IChiSqExperiment.

Definition at line 108 of file SingleSampleExperiment.cxx.

References ana::HistCache::Delete(), ana::IPrediction::Derivative(), fCosmic, fCosmicScaleError, fData, fMC, chisquared::hpred, MECModelEnuComparisons::i, it, ana::LogLikelihoodDerivative(), pot, ana::Spectrum::POT(), PredHistIncCosmics(), and ana::Spectrum::ToTH1().

Referenced by ChiSq().

   {
     const double pot = fData.POT();
 
     std::unordered_map<const ISyst*, std::vector<double>> dp;
     for(auto it: dchi) dp[it.first] = {};
     fMC->Derivative(calc, shift, pot, dp);
 
     if(dp.empty()){ // prediction doesn't implement derivatives
       dchi.clear(); // pass on that info to our caller
       return;
     }
 
     TH1D* hpred = PredHistIncCosmics(calc, shift);
     TH1D* hdata = fData.ToTH1(pot);
 
     for(auto& it: dchi){
       if(it.first != &kCosmicBkgScaleSyst){
         it.second += LogLikelihoodDerivative(hpred, hdata, dp[it.first]);
       }
       else{
         const unsigned int N = fCosmic->GetNbinsX()+2;
         const double* ca = fCosmic->GetArray();
         std::vector<double> cosErr(N);
         for(unsigned int i = 0; i < N; ++i) cosErr[i] = ca[i]*fCosmicScaleError;
         it.second += LogLikelihoodDerivative(hpred, hdata, cosErr);
       }
     }
 
     HistCache::Delete(hpred);
     HistCache::Delete(hdata);
   }

std::unique_ptr< SingleSampleExperiment > ana::SingleSampleExperiment::LoadFrom ( TDirectory * dir )

static

Definition at line 160 of file SingleSampleExperiment.cxx.

References ana::Spectrum::LoadFrom(), ana::LoadFrom< IPrediction >(), mc, runNovaSAM::release, and runNovaSAM::ret.

Referenced by getHists_FNEX(), and ana::LoadFrom< IChiSqExperiment >().

   {
     TObjString* ptag = (TObjString*)dir->Get("type");
     assert(ptag);
     assert(ptag->GetString() == "SingleSampleExperiment");
 
     assert(dir->GetDirectory("mc"));
     assert(dir->GetDirectory("data"));
     
 
     const IPrediction* mc = ana::LoadFrom<IPrediction>(dir->GetDirectory("mc")).release();
     const std::unique_ptr<Spectrum> data = Spectrum::LoadFrom(dir->GetDirectory("data"));
 
     TH1D* cosmic = 0;
     if(dir->Get("cosmic")) cosmic = (TH1D*)dir->Get("cosmic");
 
     auto ret = std::make_unique<SingleSampleExperiment>(mc, *data);
     if(cosmic) ret->fCosmic = cosmic;
     return ret;
   }

SingleSampleExperiment& ana::SingleSampleExperiment::operator= ( const SingleSampleExperiment & )

delete

TH1D * ana::SingleSampleExperiment::PredHistIncCosmics	(	osc::IOscCalculator *	calc,
		const SystShifts &	syst
	)		const

protected

Definition at line 68 of file SingleSampleExperiment.cxx.

References fCosmic, fCosmicScaleError, fData, fMC, ana::SystShifts::GetShift(), chisquared::hpred, ana::Spectrum::POT(), plot_validation_datamc::pred, ana::IPrediction::PredictSyst(), scale, ana::SystShifts::SetShift(), plotSysts::syst, and ana::Spectrum::ToTH1().

Referenced by ChiSq(), Derivative(), and ~SingleSampleExperiment().

   {
     SystShifts systNoCosmic = syst;
     systNoCosmic.SetShift(&kCosmicBkgScaleSyst, 0);
 
     const Spectrum pred = fMC->PredictSyst(calc, systNoCosmic);
 
     TH1D* hpred = pred.ToTH1(fData.POT());
 
     if(fCosmic){
       if(fCosmicScaleError != 0){
         const double scale = 1 + syst.GetShift(&kCosmicBkgScaleSyst) * fCosmicScaleError;
         hpred->Add(fCosmic, scale);
       }
       else{
         hpred->Add(fCosmic);
       }
     }
 
     return hpred;
   }

void ana::SingleSampleExperiment::SaveTo ( TDirectory * dir ) const

overridevirtual

Reimplemented from ana::IChiSqExperiment.

Definition at line 144 of file SingleSampleExperiment.cxx.

References dir, fCosmic, fData, fMC, ana::IPrediction::SaveTo(), ana::Spectrum::SaveTo(), and tmp.

Referenced by joint_fit_make_experiments().

   {
     TDirectory* tmp = dir;
 
     dir->cd();
     TObjString("SingleSampleExperiment").Write("type");
 
     fMC->SaveTo(dir->mkdir("mc"));
     fData.SaveTo(dir->mkdir("data"));
 
     if(fCosmic) fCosmic->Write("cosmic");
 
     tmp->cd();
   }

Member Data Documentation

TH1D* ana::SingleSampleExperiment::fCosmic

protected

Definition at line 84 of file SingleSampleExperiment.h.

Referenced by ana::CovMxExperiment::ChiSq(), Derivative(), PredHistIncCosmics(), SaveTo(), SingleSampleExperiment(), and ~SingleSampleExperiment().

double ana::SingleSampleExperiment::fCosmicScaleError

protected

Definition at line 86 of file SingleSampleExperiment.h.

Referenced by ana::CovMxExperiment::ChiSq(), Derivative(), and PredHistIncCosmics().

Spectrum ana::SingleSampleExperiment::fData

protected

Definition at line 83 of file SingleSampleExperiment.h.

Referenced by ChiSq(), ana::CovMxExperiment::ChiSq(), Derivative(), PredHistIncCosmics(), and SaveTo().

const IPrediction* ana::SingleSampleExperiment::fMC

protected

Definition at line 82 of file SingleSampleExperiment.h.

Referenced by ana::CovMxExperiment::ChiSq(), Derivative(), PredHistIncCosmics(), and SaveTo().

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

/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N19-12-08/CAFAna/Experiment/SingleSampleExperiment.h
/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N19-12-08/CAFAna/Experiment/SingleSampleExperiment.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation