ana::FitVarWithPrior Class Reference

A convenience FitVar_StanSupport that wraps a pre-existing FitVar_StanSupport with a function you specify (enables re-use of functions) More...

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

Inheritance diagram for ana::FitVarWithPrior:

Public Types
typedef std::function< typename stan::math::var(stan::math::var, const osc::_IOscCalcAdjustable< stan::math::var > *)>	PriorFnType
	Function that will return the log of the value of the prior density for a given parameter. More...

Public Member Functions
	FitVarWithPrior (const StanFitSupport< IFitVar > *var, PriorFnType priorFn, const std::string &priorName)
	Constructor. Ensure that var doesn't go out of scope before this object does! More...
double	GetValue (const osc::IOscCalcAdjustable *osc) const override
	Forward to wrapped Var's GetValue() More...
stan::math::var	GetValue (const osc::_IOscCalcAdjustable< stan::math::var > *osc) const override
void	SetValue (osc::IOscCalcAdjustable *osc, double val) const override
	Forward to wrapped Var's SetValue() More...
void	SetValue (osc::_IOscCalcAdjustable< stan::math::var > *osc, stan::math::var val) const override
stan::math::var	LogPrior (const stan::math::var &val, const osc::_IOscCalcAdjustable< stan::math::var > *calc) const override
	Implement calculation of log-prior by forwarding to stored function. More...
virtual stan::math::var	GetValue (const osc::IOscCalcAdjustableStan *osc) const =0
virtual void	SetValue (osc::IOscCalcAdjustableStan *osc, stan::math::var val) const =0
virtual stan::math::var	Prior (const stan::math::var &var, const osc::IOscCalcAdjustableStan *calc) const
virtual stan::math::var	LogPrior (const stan::math::var &var, const osc::IOscCalcAdjustableStan *calc) const
virtual double	Penalty (double, osc::IOscCalcAdjustable *) const
const std::string &	ShortName () const
const std::string &	LatexName () const

Private Attributes
const StanFitSupport< IFitVar > *	fVar
PriorFnType	fPriorFn

Detailed Description

A convenience FitVar_StanSupport that wraps a pre-existing FitVar_StanSupport with a function you specify (enables re-use of functions)

Warning: the function you pass as a prior must be normalizable (i.e., finite integral) when multiplied by the likelihood over the domain of your Var. This class can't check for you (the MCMC is going to explore that space); if your prior*likelihood isn't normalizable, you are likely to get unexpected results.

Definition at line 20 of file FitVarWithPrior.h.

Member Typedef Documentation

typedef std::function<typename stan::math::var(stan::math::var, const osc::_IOscCalcAdjustable <stan::math::var>*)> ana::FitVarWithPrior::PriorFnType

Function that will return the log of the value of the prior density for a given parameter.

Definition at line 28 of file FitVarWithPrior.h.

Constructor & Destructor Documentation

ana::FitVarWithPrior::FitVarWithPrior ( const StanFitSupport< IFitVar > *  var, PriorFnType  priorFn, const std::string &  priorName  )

inline

Constructor. Ensure that var doesn't go out of scope before this object does!

Definition at line 32 of file FitVarWithPrior.h.

          : StanFitSupport<IFitVar>(dynamic_cast<const IFitVar*>(var)->ShortName() + "_" + priorName,
                                    dynamic_cast<const IFitVar*>(var)->LatexName()),
            fVar(var), fPriorFn(priorFn)
      {}

Member Function Documentation

double ana::FitVarWithPrior::GetValue ( const osc::IOscCalcAdjustable *  osc ) const

inlineoverridevirtual

Forward to wrapped Var's GetValue()

Implements ana::IFitVar.

Definition at line 41 of file FitVarWithPrior.h.

Referenced by FCCorrectSlice(), FCTutorial2020(), goodness_of_fit(), joint_fit_2017_make_fc_slice(), joint_fit_2017_make_fc_surf(), joint_fit_future_bestfit_univ(), joint_fit_future_contour_univ(), 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_2020_validation(), make_fc_surfaces_nersc_2018(), make_fc_surfaces_nersc_2018_stats(), make_fc_surfaces_nersc_2019(), plot_joint_fit_2020_contours(), RunFitter(), syst_table_fit(), and syst_table_fit_new().

      {
        return fVar->GetValue(osc);
      }

stan::math::var ana::FitVarWithPrior::GetValue ( const osc::_IOscCalcAdjustable< stan::math::var > *  osc ) const

inlineoverride

Definition at line 45 of file FitVarWithPrior.h.

      {
        return fVar->GetValue(osc);
      };

virtual stan::math::var ana::StanFitSupport< IFitVar >::GetValue ( const osc::IOscCalcAdjustableStan *  osc ) const

pure virtualinherited

Implemented in ana::FitDeltaInPiUnits.

const std::string& ana::IFitVar::LatexName ( ) const

inlineinherited

Definition at line 37 of file IFitVar.h.

References ana::IFitVar::fLatexName, ana::IFitVar::fShortName, and string.

Referenced by ana::FrequentistSurface::CreateHistograms(), ana::SurfaceKrige::SurfaceKrige(), and test_fitvarsproduct().

{ return fLatexName; };

stan::math::var ana::FitVarWithPrior::LogPrior ( const stan::math::var &  val, const osc::_IOscCalcAdjustable< stan::math::var > *  calc  ) const

inlineoverride

Implement calculation of log-prior by forwarding to stored function.

Definition at line 62 of file FitVarWithPrior.h.

      {
        return fPriorFn(val, calc);
      }

virtual stan::math::var ana::StanFitSupport< IFitVar >::LogPrior ( const stan::math::var &  var, const osc::IOscCalcAdjustableStan *  calc  ) const

inlinevirtualinherited

Log of the prior probability density. Default implementation just does log(Prior()), but this can be overridden if there optimizations that speed up the calculation.

Definition at line 102 of file IFitVar.h.

{return StanLog(Prior(var, calc));}

virtual double ana::IFitVar::Penalty ( double  , osc::IOscCalcAdjustable *    ) const

inlinevirtualinherited

Reimplemented in ana::FitDeltaCPT, ana::FitSigmaCPT, and ana::IConstrainedFitVar.

Definition at line 34 of file IFitVar.h.

Referenced by ana::FrequentistSurface::FillSurface().

{return 0;}

virtual stan::math::var ana::StanFitSupport< IFitVar >::Prior ( const stan::math::var &  var, const osc::IOscCalcAdjustableStan *  calc  ) const

inlinevirtualinherited

The prior probability density distribution on this variable (which can depend on others if needed). If there are optimizations that can make log(Prior()) more expensive than a direct implementation, consider implementing LogPrior() directly instead.

Definition at line 98 of file IFitVar.h.

{return StanExp(LogPrior(var, calc));}

void ana::FitVarWithPrior::SetValue ( osc::IOscCalcAdjustable *  osc, double  val  ) const

inlineoverridevirtual

Forward to wrapped Var's SetValue()

Implements ana::IFitVar.

Definition at line 51 of file FitVarWithPrior.h.

Referenced by bin_composition_pie_chart(), CVNCuts(), fill_col(), futureSig_reach_singlePOTcombo_syst(), GetCalculator(), GetMinChiSqSlc(), SystEntry::hDm(), SystEntry::hDmDcp(), SystEntry::hSin(), SystEntry::hSinDcp(), 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_2020_validation(), make_fc_surfaces_nersc_2018(), make_fc_surfaces_nersc_2018_stats(), make_fc_surfaces_nersc_2019(), MakeFakeData(), MakePeriCutPlot(), makeSystTable(), makeSystTable_reduced(), MakeTable(), PeripheralCuts(), predEventCountWithSystError(), ResetCalc(), SetFakeCalc(), SetSeeds(), test_nue2017Prediction(), and test_nue2018_fitter().

      {
        fVar->SetValue(osc, val);
      };

void ana::FitVarWithPrior::SetValue ( osc::_IOscCalcAdjustable< stan::math::var > *  osc, stan::math::var  val  ) const

inlineoverride

Definition at line 55 of file FitVarWithPrior.h.

      {
        fVar->SetValue(osc, val);
      };

virtual void ana::StanFitSupport< IFitVar >::SetValue ( osc::IOscCalcAdjustableStan *  osc, stan::math::var  val  ) const

pure virtualinherited

Implemented in ana::FitDeltaInPiUnits.

const std::string& ana::IFitVar::ShortName ( ) const

inlineinherited

Definition at line 36 of file IFitVar.h.

References ana::IFitVar::fShortName.

Referenced by ana::CovMxSurface::CovMxSurface(), ana::FrequentistSurface::FillSurface(), MakeSurface(), MakeSurfaceJoint(), plot_3flavor_withsysts(), ana::FrequentistSurface::ProgressBarTitle(), ana::MCMCSamples::SampleValue(), ana::StanFitter::transform_helper(), ana::MCMCSample::Val(), ana::MCMCSamples::VarOffset(), and ana::StanFitter::write_array().

{ return fShortName; };

Member Data Documentation

PriorFnType ana::FitVarWithPrior::fPriorFn

private

Definition at line 70 of file FitVarWithPrior.h.

const StanFitSupport<IFitVar>* ana::FitVarWithPrior::fVar

private

Definition at line 68 of file FitVarWithPrior.h.

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-16/CAFAna/Core/FitVarWithPrior.h