Fit the product of two variables (made from angles so their ranges are 0-1). See also FitVarsProductMarg. More...

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

Inheritance diagram for ana::FitVarsProduct:

Public Member Functions
	FitVarsProduct (const IConstrainedFitVar &x, const IConstrainedFitVar &y)

virtual double	GetValue (const osc::IOscCalcAdjustable *osc) const

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

virtual double	LowLimit () const

virtual double	HighLimit () 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

Protected Attributes
const IConstrainedFitVar &	fVarX

const IConstrainedFitVar &	fVarY

Detailed Description

Fit the product of two variables (made from angles so their ranges are 0-1). See also FitVarsProductMarg.

When we set the product, how do we decide to split it between the two variables? How do we marginalize over that freedom of choice? We introduce two new variables defined as:

$\alpha=xy$ and $\beta={2\over\pi}\arctan\left({1-x\over1-y}\right)$

This class is $\alpha$ , FitVarsProductMarg is $\beta$ . They have the property of being orthogonal, and ranging over 0 to 1 as $ x $ and $ y $ do.

One should fit over this parameter and introduce the corresponding FitVarsProductMarg as a marginalization variable.

Definition at line 25 of file FitVarsProduct.h.

Constructor & Destructor Documentation

ana::FitVarsProduct::FitVarsProduct	(	const IConstrainedFitVar &	x,
		const IConstrainedFitVar &	y
	)

Definition at line 100 of file FitVarsProduct.cxx.

References ana::assert(), ana::IConstrainedFitVar::HighLimit(), and ana::IConstrainedFitVar::LowLimit().

     : IConstrainedFitVar(x.ShortName()+"*"+y.ShortName(),
                          x.LatexName()+y.LatexName()),
       fVarX(x), fVarY(y)
   {
     assert(x.LowLimit() == 0 && x.HighLimit() == 1);
     assert(y.LowLimit() == 0 && y.HighLimit() == 1);
   }

Member Function Documentation

template<typename T >

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

inlineprotectedinherited

Definition at line 60 of file IFitVar.h.

References std::max(), std::min(), ana::StanExp(), ana::StanLog(), and submit_syst::x.

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

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

virtual

Implements ana::IFitVar.

Definition at line 111 of file FitVarsProduct.cxx.

References beta, fVarX, fVarY, and ana::IFitVar::GetValue().

   {
     // Easy, just the product of the two
     double alpha, beta;
     XYToAlphaBeta(fVarX.GetValue(osc), fVarY.GetValue(osc), alpha, beta);
     return alpha;
   }

virtual double ana::FitVarsProduct::HighLimit ( ) const

inlinevirtual

Implements ana::IConstrainedFitVar.

Definition at line 35 of file FitVarsProduct.h.

35 {return 1;}

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().

37 { return fLatexName; };

ana::IFitVar::fLatexName

std::string fLatexName

Definition: IFitVar.h:41

virtual double ana::FitVarsProduct::LowLimit ( ) const

inlinevirtual

Implements ana::IConstrainedFitVar.

Definition at line 34 of file FitVarsProduct.h.

34 {return 0;}

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;
   }

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

virtual

Implements ana::IFitVar.

Definition at line 120 of file FitVarsProduct.cxx.

References beta, ana::IConstrainedFitVar::Clamp(), fVarX, fVarY, ana::IFitVar::GetValue(), ana::IFitVar::SetValue(), submit_syst::x, and submit_syst::y.

   {
     // Conver to the other space, hold beta (the marg variable) fixed and
     // adjust alpha, see where that leaves us.
     double alpha, beta;
     XYToAlphaBeta(fVarX.GetValue(osc), fVarY.GetValue(osc), alpha, beta);
     alpha = Clamp(val);
 
     double x, y;
     AlphaBetaToXY(alpha, beta, x, y);
     fVarX.SetValue(osc, x);
     fVarY.SetValue(osc, y);
   }

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().

36 { return fShortName; };

ana::IFitVar::fShortName

std::string fShortName

Definition: IFitVar.h:37

Member Data Documentation

const IConstrainedFitVar& ana::FitVarsProduct::fVarX

protected

Definition at line 37 of file FitVarsProduct.h.

Referenced by GetValue(), and SetValue().

const IConstrainedFitVar& ana::FitVarsProduct::fVarY

protected

Definition at line 38 of file FitVarsProduct.h.

Referenced by GetValue(), and SetValue().

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

/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-16/CAFAna/Vars/FitVarsProduct.h
/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-16/CAFAna/Vars/FitVarsProduct.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation