Combine multiple component experiments. More...

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-04-14/CAFAna/Experiment/MultiExperiment.h"

Inheritance diagram for ana::MultiExperiment:

Public Member Functions
	MultiExperiment (std::vector< const IExperiment * > expts={})

void	Add (const IExperiment *expt)

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

const std::vector< const IExperiment * > &	GetExperiments () const

stan::math::var	LogLikelihood (osc::IOscCalcAdjustableStan *osc, const SystShifts &syst) const override
	Sum up log-likelihoods of sub-expts. More...

void	SetSystCorrelations (int idx, const std::vector< std::pair< const ISyst , const ISyst >> &corrs)

void	Reset () const override

virtual void	SaveTo (TDirectory *dir, const std::string &name) const override

Static Public Member Functions
static std::unique_ptr< MultiExperiment >	LoadFrom (TDirectory *dir, const std::string &name)

Protected Member Functions
SystShifts	ApplySystCorrs (const SystShifts &shiftsIn, const std::vector< std::pair< const ISyst , const ISyst >> &corrs) const
	Get a new SystShifts, applying the specified correlations to it. More...

Protected Attributes
std::vector< const IExperiment * >	fExpts

std::vector< std::vector< std::pair< const ISyst , const ISyst > > >	fSystCorrelations

Detailed Description

Combine multiple component experiments.

Definition at line 11 of file MultiExperiment.h.

Constructor & Destructor Documentation

ana::MultiExperiment::MultiExperiment ( std::vector< const IExperiment * > expts = {} )

inline

Definition at line 14 of file MultiExperiment.h.

References fExpts, and fSystCorrelations.

Referenced by LoadFrom().

                                                           {}) : fExpts(expts)
     {
       fSystCorrelations.resize(expts.size());
     }

Member Function Documentation

void ana::MultiExperiment::Add ( const IExperiment * expt )

inline

Definition at line 19 of file MultiExperiment.h.

References ChiSq(), fExpts, fSystCorrelations, and ana::SystShifts::Nominal().

     {
       fExpts.push_back( expt );
       fSystCorrelations.resize( fExpts.size() );
     }

SystShifts ana::MultiExperiment::ApplySystCorrs	(	const SystShifts &	shiftsIn,
		const std::vector< std::pair< const ISyst , const ISyst >> &	corrs
	)		const

protected

Get a new SystShifts, applying the specified correlations to it.

Definition at line 20 of file MultiExperiment.cxx.

References ana::SystShifts::GetShift(), ana::SystShifts::HasStan(), it, ana::SystShifts::RemoveShift(), and ana::SystShifts::SetShift().

Referenced by ChiSq(), GetExperiments(), and LogLikelihood().

   {
     // Make a local copy we're going to rewrite into the terms this
     // sub-experiment will accept.
     SystShifts localShifts = shiftsIn;
     for(auto it: corrs)
     {
       // We're mapping prim -> sec
       const ISyst* prim = it.first;
       const ISyst* sec = it.second;
       if(shiftsIn.HasStan(prim) || shiftsIn.GetShift<double>(prim) != 0)
       {
         // sec can be unset, which means there's no representation needed
         // of prim in the sub-experiment.
         if(sec)
         {
           if (shiftsIn.HasStan(prim))
             localShifts.SetShift(sec, shiftsIn.GetShift<stan::math::var>(prim));
           else
             localShifts.SetShift(sec, shiftsIn.GetShift<double>(prim));
         }
 
         // We've either translated or discarded prim, so drop it here.
         localShifts.RemoveShift(prim);
       }
     }
 
     return localShifts;
   }

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

overridevirtual

Reimplemented from ana::IExperiment.

Definition at line 52 of file MultiExperiment.cxx.

References ApplySystCorrs(), fExpts, fSystCorrelations, runNovaSAM::ret, and SetSystCorrelations().

Referenced by Add(), and MakeSurface().

   {
     double ret = 0;
     for(unsigned int n = 0; n < fExpts.size(); ++n){
       // Don't waste time fiddling with the systematics if for sure there's
       // nothing to do.
       if(fSystCorrelations[n].empty())
         ret += fExpts[n]->ChiSq(osc, syst);
       else
         ret += fExpts[n]->ChiSq(osc, ApplySystCorrs(syst, fSystCorrelations[n]));
     }
     return ret;
   }

const std::vector<const IExperiment*>& ana::MultiExperiment::GetExperiments ( ) const

inline

Definition at line 28 of file MultiExperiment.h.

References ApplySystCorrs(), dir, fExpts, compare_h5_caf::idx, LoadFrom(), LogLikelihood(), Reset(), SaveTo(), SetSystCorrelations(), and string.

28 { return fExpts; }

ana::MultiExperiment::fExpts

std::vector< const IExperiment * > fExpts

Definition: MultiExperiment.h:58

std::unique_ptr< MultiExperiment > ana::MultiExperiment::LoadFrom	(	TDirectory *	dir,
		const std::string &	name
	)

static

Definition at line 150 of file MultiExperiment.cxx.

References ana::assert(), dir, genie::utils::style::Format(), MECModelEnuComparisons::i, ana::LoadFrom< IExperiment >(), MultiExperiment(), runNovaSAM::release, string, and cvnie::subdir.

Referenced by GetExperiments().

   {
     dir = dir->GetDirectory(name.c_str()); // switch to subdir
     assert(dir);
 
     TObjString* ptag = (TObjString*)dir->Get("type");
     assert(ptag);
     assert(ptag->GetString() == "MultiExperiment");
     delete ptag;
 
     std::vector<const IExperiment*> expts;
 
     for(int i = 0; ; ++i){
       const std::string subname = TString::Format("expt%d", i).Data();
       TDirectory* subdir = dir->GetDirectory(subname.c_str());
       if(!subdir) break;
       delete subdir;
 
       expts.push_back(ana::LoadFrom<IExperiment>(dir, name).release());
     }
 
     assert(!expts.empty());
 
     delete dir;
 
     return std::unique_ptr<MultiExperiment>(new MultiExperiment(expts));
   }

stan::math::var ana::MultiExperiment::LogLikelihood	(	osc::IOscCalcAdjustableStan *	osc,
		const SystShifts &	syst
	)		const

overridevirtual

Sum up log-likelihoods of sub-expts.

Reimplemented from ana::IExperiment.

Definition at line 109 of file MultiExperiment.cxx.

References ApplySystCorrs(), fExpts, fSystCorrelations, compare_h5_caf::idx, and runNovaSAM::ret.

Referenced by GetExperiments().

   {
     stan::math::var ret = 0.;
     for (unsigned int idx = 0; idx < fExpts.size(); ++idx)
     {
        if(fSystCorrelations[idx].empty())
          ret += fExpts[idx]->LogLikelihood(osc, syst);
        else
          ret += fExpts[idx]->LogLikelihood(osc, ApplySystCorrs(syst, fSystCorrelations[idx]));
     }
     return ret;
   }

void ana::MultiExperiment::Reset ( ) const

overridevirtual

Reimplemented from ana::IExperiment.

Definition at line 103 of file MultiExperiment.cxx.

References demo5::expt, and fExpts.

Referenced by GetExperiments().

                                     {
     for (auto expt : fExpts) expt->Reset();
   }

void ana::MultiExperiment::SaveTo	(	TDirectory *	dir,
		const std::string &	name
	)		const

overridevirtual

Reimplemented from ana::IExperiment.

Definition at line 123 of file MultiExperiment.cxx.

References om::cerr, dir, allTimeWatchdog::endl, fExpts, genie::utils::style::Format(), fSystCorrelations, MECModelEnuComparisons::i, it, and tmp.

Referenced by GetExperiments().

   {
     bool hasCorr = false;
     for(auto it: fSystCorrelations) if(!it.empty()) hasCorr = true;
 
     if(hasCorr){
       std::cerr << "Warning in MultiExperiment: systematic correlations are set and will not be serialized by this call to SaveTo(). You will have to re-set them once you load the experiment back in." << std::endl;
     }
 
     TDirectory* tmp = dir;
 
     dir = dir->mkdir(name.c_str()); // switch to subdir
     dir->cd();
 
     TObjString("MultiExperiment").Write("type");
 
     for(unsigned int i = 0; i < fExpts.size(); ++i){
       fExpts[i]->SaveTo(dir, TString::Format("expt%d", i).Data());
     }
 
     dir->Write();
     delete dir;
 
     tmp->cd();
   }

void ana::MultiExperiment::SetSystCorrelations	(	int	idx,
		const std::vector< std::pair< const ISyst , const ISyst >> &	corrs
	)

For the subexperiment idx, set up a mapping between systematics

Each element in the vector is a pair from a "primary" systematic to a "secondary". When this MultiExperiment is called with a primary systematic shifted, the sub-experiment will be called with the secondary systematic set to the same value (and the primary unset).

You can pass NULL for a secondary to indicate that the systematic simply has no effect on the experiment in question and should be filtered out.

Definition at line 69 of file MultiExperiment.cxx.

References om::cout, allTimeWatchdog::endl, fSystCorrelations, compare_h5_caf::idx, and it.

Referenced by ChiSq(), futureSig_reach_singlePOTcombo_syst(), GetExperiments(), joint_fit_2017_make_fc_slice(), joint_fit_2017_make_fc_surf(), make_fc_mass_and_oct_nersc_2018(), make_fc_mass_and_oct_nersc_2019(), make_fc_mh_nersc_2018(), make_fc_mh_nersc_2019(), make_fc_oct_nersc_2018(), make_fc_oct_nersc_2019(), make_fc_slices_nersc_2018(), make_fc_slices_nersc_2018_stats(), make_fc_slices_nersc_2019(), make_fc_surfaces_2020(), make_fc_surfaces_nersc_2018(), make_fc_surfaces_nersc_2018_stats(), and make_fc_surfaces_nersc_2019().

   {
     // Sanity-check the mapping
     std::map<const ISyst*, const ISyst*> already;
     for(auto it: corrs){
       if(it.first == it.second)
       {
         std::cout << "MultiExperiment::SetSystCorrelations(): You're trying to map a syst to itself: " << std::endl;
         auto name = it.first ? it.first->ShortName() : "nullptr";
         std::cout << name << " --> " << name << std::endl;
         abort();
       }
 
       // Don't worry if second element is null pointer
       if (!it.second) continue;
       if(already.find(it.second) == already.end()){
         already[it.second] = it.first;
       }
       else{
         std::cout << "MultiExperiment::SetSystCorrelations(): Warning!\n"
                   << "In experiment " << idx << " both "
                   << already[it.second]->ShortName() << " and "
                   << it.first->ShortName()
                   << " are configured to map to " << it.second->ShortName()
                   << ". That's probably not what you want." << std::endl;
       }
     }
 
     // Apply it
     fSystCorrelations[idx] = corrs;
   }

Member Data Documentation

std::vector<const IExperiment*> ana::MultiExperiment::fExpts

protected

Definition at line 58 of file MultiExperiment.h.

Referenced by Add(), ChiSq(), GetExperiments(), LogLikelihood(), MultiExperiment(), Reset(), and SaveTo().

std::vector<std::vector<std::pair<const ISyst*, const ISyst*> > > ana::MultiExperiment::fSystCorrelations

protected

Definition at line 60 of file MultiExperiment.h.

Referenced by Add(), ChiSq(), LogLikelihood(), MultiExperiment(), SaveTo(), and SetSystCorrelations().

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

/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-04-14/CAFAna/Experiment/MultiExperiment.h
/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-04-14/CAFAna/Experiment/MultiExperiment.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation