ana::ConstrainedFitVarWithPrior Class Reference

Version of FitVarWithPrior for use with constrained FitVar_StanSupports. More...

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

Inheritance diagram for ana::ConstrainedFitVarWithPrior:

Public Types
typedef std::function< typename stan::math::var(const stan::math::var &, const osc::_IOscCalcAdjustable< stan::math::var > *)>	PriorFnType

Public Member Functions
	ConstrainedFitVarWithPrior (const StanFitSupport< IConstrainedFitVar > *var, FitVarWithPrior::PriorFnType priorFn, const std::string &priorName)
double	GetValue (const osc::IOscCalcAdjustable *osc) const override
stan::math::var	GetValue (const osc::IOscCalcAdjustableStan *osc) const override
void	SetValue (osc::IOscCalcAdjustable *osc, double val) const override
void	SetValue (osc::IOscCalcAdjustableStan *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
double	LowLimit () const override
double	HighLimit () const override
const std::string &	PriorName () const
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
double	Penalty (double val, osc::IOscCalcAdjustable *) const override
	Override the default implementation with one that pushes back towards the center of the constrained space. More...
const std::string &	ShortName () const
const std::string &	LatexName () const

Protected Member Functions
template<typename T >
T	Clamp (T val) const

Private Attributes
const StanFitSupport< IConstrainedFitVar > *	fVar
PriorFnType	fPriorFn
std::string	fPriorFnName

Detailed Description

Version of FitVarWithPrior for use with constrained FitVar_StanSupports.

Definition at line 74 of file FitVarWithPrior.h.

Member Typedef Documentation

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

Definition at line 82 of file FitVarWithPrior.h.

Constructor & Destructor Documentation

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

inline

Definition at line 85 of file FitVarWithPrior.h.

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

Member Function Documentation

template<typename T >

T ana::IConstrainedFitVar::Clamp ( T  val ) const

inlineprotectedinherited

Definition at line 61 of file IFitVar.h.

References clamp(), ana::StanExp(), ana::StanLog(), and submit_syst::x.

Referenced by ana::FitEpsMuTau::SetValue(), ana::FitDmSq32CPT::SetValue(), ana::FitVarsProduct::SetValue(), ana::FitVarsProductMarg::SetValue(), ana::FitDmSq32ScaledCPT::SetValue(), ana::FitDmSq32CPTHierarchy::SetValue(), FitSinSqTheta23UO::SetValue(), FitSinSqTheta23LO::SetValue(), ana::FitDmSq21CPT::SetValue(), ana::FitSinSq2Theta23CPT::SetValue(), ana::FitSinSqTheta23CPT::SetValue(), ana::FitSinSq2Theta13CPT::SetValue(), ana::FitSinSq2Theta12CPT::SetValue(), FitSinSqTheta23LowerOctant::SetValue(), FitSinSqTheta23MaxMix::SetValue(), and FitSinSqTheta23UpperOctant::SetValue().

      {
        return std::clamp(val, util::GetValAs<T>(LowLimit()), util::GetValAs<T>(HighLimit()));
      }

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

inlineoverridevirtual

Implements ana::IFitVar.

Definition at line 95 of file FitVarWithPrior.h.

Referenced by demoFitContours(), demoFitSlices(), FCCorrectSlice(), FCTutorial2020(), fill_col(), goodness_of_fit(), joint_fit_2017_make_fc_slice(), joint_fit_2018_contours(), joint_fit_2018_slices(), joint_fit_2019_bestfit(), joint_fit_2019_contours(), joint_fit_2019_slices(), 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(), make_mass_and_oct_fc_input_2019(), make_starplots(), plot_joint_fit_2020_contours(), run_joint_fit_2020_bestfit(), run_joint_fit_2020_contours(), run_joint_fit_2020_slices(), starPlot(), syst_table_fit(), and syst_table_fit_new().

      {
        return fVar->GetValue(osc);
      }

stan::math::var ana::ConstrainedFitVarWithPrior::GetValue ( const osc::IOscCalcAdjustableStan *  osc ) const

inlineoverridevirtual

Implements ana::StanFitSupport< IConstrainedFitVar >.

Definition at line 99 of file FitVarWithPrior.h.

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

double ana::ConstrainedFitVarWithPrior::HighLimit ( ) const

inlineoverridevirtual

Implements ana::IConstrainedFitVar.

Definition at line 124 of file FitVarWithPrior.h.

      {
        return fVar->HighLimit();
      };

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

inlineinherited

Definition at line 38 of file IFitVar.h.

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

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

{ return fLatexName; };

virtual stan::math::var ana::StanFitSupport< IConstrainedFitVar >::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 103 of file IFitVar.h.

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

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

inlineoverride

Definition at line 114 of file FitVarWithPrior.h.

      {
        return fPriorFn(val, calc);
      }

double ana::ConstrainedFitVarWithPrior::LowLimit ( ) const

inlineoverridevirtual

Implements ana::IConstrainedFitVar.

Definition at line 119 of file FitVarWithPrior.h.

      {
        return fVar->LowLimit();
      };

double ana::IConstrainedFitVar::Penalty ( double  val, osc::IOscCalcAdjustable *    ) const

overridevirtualinherited

Override the default implementation with one that pushes back towards the center of the constrained space.

Reimplemented from ana::IFitVar.

Definition at line 8 of file IFitVar.cxx.

References hi(), ana::IConstrainedFitVar::HighLimit(), lo(), ana::IConstrainedFitVar::LowLimit(), extractScale::mean, Munits::rad, and util::sqr().

Referenced by ana::SigmaDelta::SigmaPenalty().

  {
    const auto lo = LowLimit();
    const auto hi = HighLimit();

    if (val >= lo && val <= hi) return 0;

    // Try to direct fit back towards centre of the space. Engineer penalty to
    // be zero at the limits.
    const auto mean = (lo + hi) / 2;
    const auto rad = (hi - lo) / 2;
    return util::sqr((val - mean) / rad) - 1;


    //    if(val < lo) return util::sqr(lo-val);
    //    if(val > hi) return util::sqr(val-hi);
    //    return 0;
  }

virtual stan::math::var ana::StanFitSupport< IConstrainedFitVar >::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 99 of file IFitVar.h.

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

const std::string& ana::ConstrainedFitVarWithPrior::PriorName ( ) const

inline

Definition at line 129 of file FitVarWithPrior.h.

      {
        return fPriorFnName;
      };

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

inlineoverridevirtual

Implements ana::IFitVar.

Definition at line 104 of file FitVarWithPrior.h.

Referenced by bin_composition_pie_chart(), CVNCuts(), fill_col(), futureSig_reach_singlePOTcombo_syst(), GetCalculator(), getHists_FNEX(), SystEntry::hDm(), SystEntry::hDmDcp(), SystEntry::hSin(), SystEntry::hSinDcp(), joint_fit_2017_make_fc_slice(), joint_fit_2017_make_fc_surf(), make_fc_mh_nersc_2018(), make_fc_mh_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(), makeSystTable(), makeSystTable_reduced(), MakeTable(), monoprob(), PeripheralCuts(), predEventCountWithSystError(), prob_biprob_pedagogical(), ResetCalc(), SetFakeCalc(), SetHierOct(), SetSeeds(), test_nue2017Prediction(), test_nue2018_fitter(), test_numupred2017(), and test_stanfit_statsonly().

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

void ana::ConstrainedFitVarWithPrior::SetValue ( osc::IOscCalcAdjustableStan *  osc, stan::math::var  val  ) const

inlineoverridevirtual

Implements ana::StanFitSupport< IConstrainedFitVar >.

Definition at line 108 of file FitVarWithPrior.h.

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

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

inlineinherited

Definition at line 37 of file IFitVar.h.

References ana::IFitVar::fShortName.

Referenced by ana::FrequentistSurface::FillSurface(), ana::MCMCDiagnostics::GetAutocorrelations(), ana::MCMCDiagnostics::GetIdx(), MakeSurface(), 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::ConstrainedFitVarWithPrior::fPriorFn

private

Definition at line 137 of file FitVarWithPrior.h.

std::string ana::ConstrainedFitVarWithPrior::fPriorFnName

private

Definition at line 139 of file FitVarWithPrior.h.

const StanFitSupport<IConstrainedFitVar>* ana::ConstrainedFitVarWithPrior::fVar

private

Definition at line 132 of file FitVarWithPrior.h.

---

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

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