ana::IFitter Class Reference

Base class for fitters. More...

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-16/CAFAna/Fit/IFitter.h"

Inheritance diagram for ana::IFitter:

Classes
class	IFitSummary
struct	SeedPt

Public Types
enum	Verbosity { kQuiet, kVerbose }

Public Member Functions
	IFitter (const std::vector< const IFitVar * > &vars, const std::vector< const ISyst * > &systs={})
	IFitter (const IFitter &f)
virtual	~IFitter ()
virtual std::unique_ptr< IFitSummary >	Fit (osc::IOscCalcAdjustable *seed, SystShifts &bestSysts=junkShifts, const SeedList &seedPts=SeedList(), const std::vector< SystShifts > &systSeedPts={}, Verbosity verb=kVerbose) const
	Master fitting method. Depends on FitHelper and FitHelperSeeded. More...
virtual std::unique_ptr< IFitSummary >	Fit (osc::IOscCalcAdjustable *seed, SystShifts &systSeed, Verbosity verb) const
	Variant with no seedPts. More...
virtual std::unique_ptr< IFitSummary >	Fit (osc::IOscCalcAdjustable *seed, Verbosity verb) const
	Variant with no seedPts and no systematics result returned. More...
virtual std::unique_ptr< IFitSummary >	Fit (SystShifts &systSeed, Verbosity verb=kVerbose) const
	Variant with no oscillations - useful for ND fits. More...
std::unique_ptr< SystShifts >	GetSystShifts () const

Protected Member Functions
std::vector< SeedPt >	ExpandSeeds (const SeedList &seedPts, const std::vector< SystShifts > &systSeedPts) const
virtual std::unique_ptr< IFitSummary >	FitHelperSeeded (osc::IOscCalcAdjustable *seed, SystShifts &systSeed, Verbosity verb) const =0
	Helper for FitHelper – actually does fitting. Reimplement in derived classes. More...
virtual std::unique_ptr< IFitSummary >	FitHelper (osc::IOscCalcAdjustable *seed, SystShifts &bestSysts, const SeedList &seedPts, const std::vector< SystShifts > &systSeedPts, Verbosity verb) const
	Helper for Fit. More...
void	ValidateSeeds (osc::IOscCalcAdjustable *seed, const SeedList &seedPts, const std::vector< SystShifts > &systSeedPts) const
	Check that the seeds that were specified are compatible with the vars being fitted. More...

Protected Attributes
std::vector< const IFitVar * >	fVars
std::vector< const ISyst * >	fSysts
std::unique_ptr< SystShifts >	fShifts
Verbosity	fVerb

Static Protected Attributes
static SystShifts	junkShifts = SystShifts()

Detailed Description

Base class for fitters.

Definition at line 16 of file IFitter.h.

Member Enumeration Documentation

enum ana::IFitter::Verbosity

Enumerator
kQuiet
kVerbose

Definition at line 22 of file IFitter.h.

{kQuiet, kVerbose};

Constructor & Destructor Documentation

ana::IFitter::IFitter	(	const std::vector< const IFitVar * > &	vars,
		const std::vector< const ISyst * > &	systs = {}
	)

Definition at line 21 of file IFitter.cxx.

    : fVars(vars), fSysts(systs)
  {
  }

ana::IFitter::IFitter

(

const IFitter &

f

)

Definition at line 28 of file IFitter.cxx.

      : fVars(other.fVars),
        fSysts(other.fSysts),
        fShifts(std::make_unique<SystShifts>(*other.fShifts))
  {}

ana::IFitter::~IFitter ( )

virtual

Definition at line 35 of file IFitter.cxx.

  {
  }

Member Function Documentation

std::vector< IFitter::SeedPt > ana::IFitter::ExpandSeeds ( const SeedList &  seedPts, const std::vector< SystShifts > &  systSeedPts  ) const

protected

Definition at line 46 of file IFitter.cxx.

References ana::SeedList::GetSeeds(), ana::SystShifts::Nominal(), gen_hdf5record::pt, runNovaSAM::ret, and seed.

Referenced by FitHelper().

  {
    std::vector<SeedPt> ret;
    for(Seed seed: seedPts.GetSeeds()) ret.emplace_back(seed, SystShifts::Nominal());

    // Now duplicate as many times as required for the syst seeds
    if(!systSeedPts.empty()){
      std::vector<SeedPt> newret;
      for(const SystShifts& s: systSeedPts){
        for(SeedPt pt: ret){
          pt.shift = s;
          newret.push_back(pt);
        }
      }
      ret = newret;
    }

    return ret;
  }

std::unique_ptr< IFitter::IFitSummary > ana::IFitter::Fit ( osc::IOscCalcAdjustable *  seed, SystShifts &  bestSysts = junkShifts, const SeedList &  seedPts = SeedList(), const std::vector< SystShifts > &  systSeedPts = {}, Verbosity  verb = kVerbose  ) const

virtual

Master fitting method. Depends on FitHelper and FitHelperSeeded.

Parameters

[out]	seed	Seed parameter and output best-fit point
[out]	bestSysts	Best systematics result returned here
	seedPts	List of oscillation parameter seeds
	systSeedPts	If non-empty, try fit starting at each of these
	verb	If quiet, no printout

Returns

-2x the log-likelihood of the best-fit point

Reimplemented in ana::StanFitter.

Definition at line 69 of file IFitter.cxx.

References om::cout, allTimeWatchdog::endl, FitHelper(), fSysts, fVars, fVerb, ana::SystShifts::GetShift(), kVerbose, registry_explorer::v, and ValidateSeeds().

Referenced by BlessedPlotsAna(), BlessedPlotsAnaByPeriod(), cc(), ana::CovMxSurface::CovMxSurface(), fake_future_data(), FCContour(), FCTutorial2020(), fill_col(), ana::FrequentistSurface::FillSurfacePoint(), ana::FrequentistSurface::FindMinimum(), ana::FindValley(), Fit(), ana::StanFitter::Fit(), ana::MinuitFitter::FitHelperSeeded(), getBestFit(), joint_fit_2017_contours(), joint_fit_2017_make_fc_slice(), joint_fit_2017_make_fc_surf(), joint_fit_2017_slices(), joint_fit_2018_contours(), joint_fit_2018_slices(), joint_fit_future_bestfit_univ(), joint_fit_future_contour_univ(), make_fc_mass_and_oct_nersc_2018(), make_fc_mh_nersc_2018(), make_fc_nus_surfs_nersc_2018(), make_fc_nus_surfs_nersc_2019(), make_fc_oct_nersc_2018(), make_fc_slices_nersc_2018(), make_fc_slices_nersc_2018_stats(), make_fc_surfaces_2020(), make_fc_surfaces_2020_validation(), make_fc_surfaces_nersc_2018(), make_fc_surfaces_nersc_2018_stats(), make_nus17_fc_surfs(), make_nus_fc_surfs(), make_starplots(), MakeCAFSensitivities_for_FNEX(), numu_sig_nonmax(), plot_shifts(), PlotNus17Prediction(), ana::Profile(), reach_2018_dCPfractions(), ana::RefineSeeds(), run_joint_fit_2020_bestfit(), run_joint_fit_2020_contours(), run_joint_fit_2020_slices(), RunFitter(), sensitivity2018(), sensitivity2020(), starPlot(), syst_test(), and test_ana().

  {
    fVerb = verb;
    ValidateSeeds(seed, seedPts, systSeedPts);

    if (fVerb == kVerbose)
    {
      std::cout << "Finding best fit for";
      for (const auto *v: fVars) std::cout << " " << v->ShortName();
      for (const auto *s: fSysts) std::cout << " " << s->ShortName();
//      if (fSupportsDerivatives) std::cout << " using analytic derivatives";
      std::cout << "..." << std::endl;
    }

    // Do all the actual work. This wrapper function is just so we can have
    // better control of printing.
    auto fitSummary = FitHelper(seed, bestSysts, seedPts, systSeedPts, verb);

    if (fVerb == kVerbose)
    {
      std::cout << "Best fit";
      for (const auto *v: fVars)
      {
        std::cout << ", " << v->ShortName() << " = " << v->GetValue(seed);
      }
      for (const auto *s: fSysts)
      {
        std::cout << ", " << s->ShortName() << " = " << bestSysts.GetShift(s);
      }
      std::cout << ", eval metric = " << fitSummary->EvalMetricVal() << std::endl;

//      std::cout << "  found with " << fNEval << " evaluations of the likelihood";
//      if (fNEvalFiniteDiff > 0)
//        std::cout << " (" << fNEvalFiniteDiff << " to evaluate gradients numerically)";
//      if (fNEvalGrad > 0)
//        std::cout << " and " << fNEvalGrad << " evaluations of the gradient";
//      std::cout << std::endl;
    }

    return fitSummary;
  }

virtual std::unique_ptr<IFitSummary> ana::IFitter::Fit ( osc::IOscCalcAdjustable *  seed, SystShifts &  systSeed, Verbosity  verb  ) const

inlinevirtual

Variant with no seedPts.

Definition at line 61 of file IFitter.h.

References Fit().

      {
        return Fit(seed, systSeed, {}, std::vector<SystShifts>(1, systSeed), verb);
      }

virtual std::unique_ptr<IFitSummary> ana::IFitter::Fit ( osc::IOscCalcAdjustable *  seed, Verbosity  verb  ) const

inlinevirtual

Variant with no seedPts and no systematics result returned.

Definition at line 69 of file IFitter.h.

References Fit().

      {
        return Fit(seed, junkShifts, {}, {}, verb);
      }

virtual std::unique_ptr<IFitSummary> ana::IFitter::Fit ( SystShifts &  systSeed, Verbosity  verb = kVerbose  ) const

inlinevirtual

Variant with no oscillations - useful for ND fits.

Definition at line 76 of file IFitter.h.

References Fit().

      {
        return Fit(nullptr, systSeed, {}, std::vector<SystShifts>(1, systSeed), verb);
      }

std::unique_ptr< IFitter::IFitSummary > ana::IFitter::FitHelper ( osc::IOscCalcAdjustable *  seed, SystShifts &  bestSysts, const SeedList &  seedPts, const std::vector< SystShifts > &  systSeedPts, Verbosity  verb  ) const

protectedvirtual

Helper for Fit.

Definition at line 117 of file IFitter.cxx.

References ana::assert(), ana::SystShifts::Copy(), osc::_IOscCalcAdjustable< T >::Copy(), ExpandSeeds(), FitHelperSeeded(), fShifts, fSysts, fVars, MECModelEnuComparisons::i, gen_hdf5record::pt, seed, ana::SystShifts::SetShift(), and registry_explorer::v.

Referenced by Fit().

  {
    // if user passed a derived kind of SystShifts, this preserves it
    fShifts = bestSysts.Copy();
    fShifts->ResetToNominal();

    const std::vector<SeedPt> pts = ExpandSeeds(seedPts, systSeedPts);

    std::unique_ptr<IFitSummary> bestFitSummary;
    std::vector<double> bestFitPars, bestSystPars;

    for (const SeedPt &pt: pts)
    {
      osc::IOscCalcAdjustable* seed = nullptr;
      if(initseed) seed = initseed->Copy();

      pt.fitvars.ResetCalc(seed);

      // be sure to keep any derived class stuff around
      auto shift = fShifts->Copy();
      *shift = pt.shift;
      auto fitSummary = FitHelperSeeded(seed, *shift, verb);
      if (fitSummary->IsBetterThan(bestFitSummary.get()))
      {
         bestFitSummary = std::move(fitSummary);
        // Store the best fit values of all the parameters we know are being
        // varied.
        bestFitPars.clear();
        bestSystPars.clear();
        for (const auto *v: fVars)
          bestFitPars.push_back(v->GetValue(seed));
        for (const auto *s: fSysts)
          bestSystPars.push_back(shift->GetShift<double>(s));
      }

      delete seed;
    } // end for pt

    assert(bestFitSummary);
    // Stuff the results of the actual best fit back into the seeds
    for (unsigned int i = 0; i < fVars.size(); ++i)
      fVars[i]->SetValue(initseed, bestFitPars[i]);
    for (unsigned int i = 0; i < fSysts.size(); ++i)
      bestSysts.SetShift(fSysts[i], bestSystPars[i]);

    return std::move(bestFitSummary);
  }

virtual std::unique_ptr<IFitSummary> ana::IFitter::FitHelperSeeded ( osc::IOscCalcAdjustable *  seed, SystShifts &  systSeed, Verbosity  verb  ) const

protectedpure virtual

Helper for FitHelper – actually does fitting. Reimplement in derived classes.

Implemented in ana::StanFitter, and ana::MinuitFitter.

Referenced by FitHelper().

std::unique_ptr<SystShifts> ana::IFitter::GetSystShifts ( ) const

inline

Definition at line 82 of file IFitter.h.

References fShifts.

Referenced by plot_shifts().

{return fShifts->Copy();}

void ana::IFitter::ValidateSeeds ( osc::IOscCalcAdjustable *  seed, const SeedList &  seedPts, const std::vector< SystShifts > &  systSeedPts  ) const

protected

Check that the seeds that were specified are compatible with the vars being fitted.

Definition at line 170 of file IFitter.cxx.

References ana::SeedList::ActiveFitVars(), om::cout, allTimeWatchdog::endl, fSysts, fVars, gen_hdf5record::pt, and registry_explorer::v.

Referenced by Fit().

  {
    if(!seed && !fVars.empty()){
      std::cout << "ERROR: MinuitFitter::Fit() trying to fit oscillation parameters without an oscillation calculator" << std::endl;
      abort();
    }

    for(const IFitVar* v: seedPts.ActiveFitVars()){
      if (std::find(fVars.begin(), fVars.end(), v) == fVars.end()){
        std::cout << "ERROR MinuitFitter::Fit() trying to seed '"
                  << v->ShortName()
                  << "' which is not part of the fit." << std::endl;
        abort();
      }
    }

    for(const SystShifts& pt: systSeedPts){
      for(const ISyst* s: pt.ActiveSysts()){
        if(std::find(fSysts.begin(), fSysts.end(), s) == fSysts.end()){
          std::cout << "ERROR MinuitFitter::Fit() trying to seed '"
                    << s->ShortName()
                    << "' which is not part of the fit." << std::endl;
          abort();
        }
      }
    }
  }

Member Data Documentation

std::unique_ptr<SystShifts> ana::IFitter::fShifts

mutableprotected

Definition at line 116 of file IFitter.h.

Referenced by ana::MinuitFitter::DecodePars(), FitHelper(), ana::MinuitFitter::FitHelperSeeded(), ana::StanFitter::FitHelperSeeded(), GetSystShifts(), ana::StanFitter::log_prob(), ana::MinuitFitter::operator()(), and ana::StanFitter::TestGradients().

std::vector<const ISyst*> ana::IFitter::fSysts

protected

Definition at line 115 of file IFitter.h.

Referenced by ana::StanFitter::BuildInitContext(), ana::MinuitFitter::DecodePars(), Fit(), FitHelper(), ana::MinuitFitter::FitHelperSeeded(), ana::StanFitter::FitHelperSeeded(), ana::StanFitter::get_param_names(), ana::StanFitter::log_prob(), ana::MinuitFitter::operator()(), ana::MinuitFitter::SetFitOpts(), ana::StanFitter::transform_inits(), and ValidateSeeds().

std::vector<const IFitVar*> ana::IFitter::fVars

protected

Definition at line 114 of file IFitter.h.

Referenced by ana::StanFitter::BuildInitContext(), ana::MinuitFitter::DecodePars(), Fit(), FitHelper(), ana::MinuitFitter::FitHelperSeeded(), ana::StanFitter::FitHelperSeeded(), ana::StanFitter::get_param_names(), ana::StanFitter::log_prob(), ana::MinuitFitter::operator()(), ana::StanFitter::transform_inits(), ValidateSeeds(), and ana::StanFitter::write_array().

Verbosity ana::IFitter::fVerb

mutableprotected

Definition at line 117 of file IFitter.h.

Referenced by Fit(), and ana::MinuitFitter::FitHelperSeeded().

SystShifts ana::IFitter::junkShifts = SystShifts()

staticprotected

Definition at line 19 of file IFitter.h.

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-16/CAFAna/Fit/IFitter.h
• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-16/CAFAna/Fit/IFitter.cxx