ana::Ratio Class Reference

Represent the ratio between two spectra. More...

#include "/cvmfs/nova.opensciencegrid.org/externals/cafanacore/v01.15/src/CAFAna/Core/Ratio.h"

Inheritance diagram for ana::Ratio:

Public Member Functions
	Ratio (const Spectrum &num, const Spectrum &denom, bool purOrEffErrs=false)
	Ratio (Eigen::ArrayXd &&arr, const std::vector< std::string > &labels, const std::vector< Binning > &bins)
virtual	~Ratio ()
	Ratio (const Ratio &rhs)=default
Ratio &	operator= (const Ratio &rhs)=default
Ratio &	operator*= (const Ratio &rhs)
Ratio	operator* (const Ratio &rhs) const
Ratio &	operator/= (const Ratio &rhs)
Ratio	operator/ (const Ratio &rhs) const
TH1D *	ToTH1 (Color_t col=kBlack, Style_t style=kSolid) const
TH2 *	ToTH2 () const
bool	HasStan () const
const Eigen::ArrayXd &	GetEigen () const
const Eigen::ArrayXstan &	GetEigenStan () const

Protected Member Functions
	Ratio (Hist &&h, std::vector< Binning > &&b, std::vector< std::string > &&l)

Protected Attributes
Hist	fHist
LabelsAndBins	fAxis

Friends
class	Spectrum

Detailed Description

Represent the ratio between two spectra.

Definition at line 8 of file Ratio.h.

Constructor & Destructor Documentation

ana::Ratio::Ratio	(	const Spectrum &	num,
		const Spectrum &	denom,
		bool	purOrEffErrs = false
	)

Parameters

num	Numerator of the ratio
denom	Denominator of the ratio
purOrEffErrs	Does this ratio represent a purity or efficiency plot? If so, error bars are calculated differently.

Definition at line 11 of file Ratio.cxx.

References ana::Hist::Divide(), fHist, ana::Spectrum::fHist, ana::Hist::GetBinContent(), ana::Hist::GetNbinsX(), MECModelEnuComparisons::i, ana::Spectrum::POT(), ana::Hist::Scale(), and ana::Hist::SetBinContent().

Referenced by ana::operator/(), and Ratio().

    : fHist(num.fHist), fAxis(num.GetLabels(), num.GetBinnings())
  {
    fHist.Divide(denom.fHist);
    fHist.Scale(denom.POT()/num.POT());

    // This is clumsy, but the old histogram operation considered 0/0 = 0,
    // which is actually pretty useful (at least PredictionInterp relies on
    // this).
    for(int i = 0; i < fHist.GetNbinsX()+2; ++i){
      if(num.fHist.GetBinContent(i) == 0 &&
         denom.fHist.GetBinContent(i) == 0){
        fHist.SetBinContent(i, 0);
      }
    }

    // TODO do something with purOrEffErrs
  }

ana::Ratio::Ratio ( Eigen::ArrayXd &&  arr, const std::vector< std::string > &  labels, const std::vector< Binning > &  bins  )

inline

Definition at line 20 of file Ratio.h.

References col, operator*(), operator*=(), operator/(), operator/=(), operator=(), Ratio(), ToTH1(), ToTH2(), and ~Ratio().

      : fHist(Hist::Adopt(std::move(arr))), fAxis(labels, bins)
    {
    }

ana::Ratio::~Ratio ( )

virtual

Definition at line 32 of file Ratio.cxx.

Referenced by Ratio().

  {
  }

ana::Ratio::Ratio ( const Ratio &  rhs )

default

ana::Ratio::Ratio ( Hist &&  h, std::vector< Binning > &&  b, std::vector< std::string > &&  l  )

inlineprotected

Definition at line 49 of file Ratio.h.

      : fHist(std::move(h)), fAxis(std::move(l), std::move(b))
    {
    }

Member Function Documentation

const Eigen::ArrayXd& ana::Ratio::GetEigen ( ) const

inline

Definition at line 44 of file Ratio.h.

References fHist, and ana::Hist::GetEigen().

Referenced by ana::PredictionExtendToPeripheral::ExtendRecoWeight(), ana::PredictionExtendToPeripheral::ExtendRecoWeightOscillatable(), ana::ReweightableSpectrum::ReweightToRecoSpectrum(), ana::ReweightableSpectrum::ReweightToTrueSpectrum(), and ana::ReweightableSpectrum::WeightedBy().

{return fHist.GetEigen();}

const Eigen::ArrayXstan& ana::Ratio::GetEigenStan ( ) const

inline

Definition at line 45 of file Ratio.h.

References fHist, and ana::Hist::GetEigenStan().

Referenced by ana::ReweightableSpectrum::WeightedBy().

{return fHist.GetEigenStan();}

bool ana::Ratio::HasStan ( ) const

inline

Definition at line 43 of file Ratio.h.

References fHist, and ana::Hist::HasStan().

Referenced by ana::ReweightableSpectrum::WeightedBy().

{return fHist.HasStan();}

Ratio ana::Ratio::operator*

(

const Ratio &

rhs

)

const

Definition at line 44 of file Ratio.cxx.

References runNovaSAM::ret.

Referenced by Ratio().

  {
    Ratio ret = *this;
    ret *= rhs;
    return ret;
  }

Ratio & ana::Ratio::operator*=

(

const Ratio &

rhs

)

Definition at line 37 of file Ratio.cxx.

References fHist, and ana::Hist::Multiply().

Referenced by Ratio().

  {
    fHist.Multiply(rhs.fHist);
    return *this;
  }

Ratio ana::Ratio::operator/

(

const Ratio &

rhs

)

const

Definition at line 59 of file Ratio.cxx.

References runNovaSAM::ret.

Referenced by Ratio().

  {
    Ratio ret = *this;
    ret /= rhs;
    return ret;
  }

Ratio & ana::Ratio::operator/=

(

const Ratio &

rhs

)

Definition at line 52 of file Ratio.cxx.

References ana::Hist::Divide(), and fHist.

Referenced by Ratio().

  {
    fHist.Divide(rhs.fHist);
    return *this;
  }

Ratio& ana::Ratio::operator= ( const Ratio &  rhs )

default

Referenced by Ratio().

TH1D * ana::Ratio::ToTH1	(	Color_t	col = kBlack,
		Style_t	style = kSolid
	)		const

Definition at line 67 of file Ratio.cxx.

References fAxis, fHist, ana::LabelsAndBins::GetBins1D(), ana::LabelsAndBins::GetLabel1D(), runNovaSAM::ret, and ana::Hist::ToTH1().

Referenced by ana::DataMCRatio(), demo::DrawUpDownRatioCanvas(), ana::MichelDecomp::GetNCMCContent(), ana::MichelDecomp::GetNCScale(), ana::MichelDecomp::GetNueScale(), ana::MichelDecomp::GetNumuMCContent(), ana::MichelDecomp::GetNumuScale(), make_xs(), make_xs_1D(), ana::CrossSectionAnalysis::PlotEfficiency(), ana::NumuCCIncAnalysis::PlotEfficiency(), Plotting_Data2DataComp(), Plotting_Data2DataComp_SingleCanvas(), Plotting_DataAndPrediction(), PredRatioToNom(), Ratio(), ana::RatioPlot(), test_nuwro(), ana::NDOscCurve::ToTH1(), ana::OscCurve::ToTH1(), ToTH2(), ana::ToTH2(), ana::ToTH3(), Unfold1D(), and Unfold3D().

  {
    TH1D* ret = fHist.ToTH1(fAxis.GetBins1D());
    ret->SetLineColor(col);
    ret->SetLineStyle(style);
    ret->GetXaxis()->SetTitle(fAxis.GetLabel1D().c_str());
    ret->GetYaxis()->SetTitle("Ratio");
    return ret;
  }

TH2 * ana::Ratio::ToTH2

(

)

const

Definition at line 78 of file Ratio.cxx.

References om::cout, allTimeWatchdog::endl, fAxis, ana::LabelsAndBins::GetBinnings(), ana::LabelsAndBins::GetLabels(), ana::LabelsAndBins::NDimensions(), runNovaSAM::ret, ToTH1(), and ana::ToTH2Helper().

Referenced by ana::SingleNucAnalysis::PlotEfficiency2D(), ana::NumuCC2p2hAnalysis::PlotEfficiency2D(), and Ratio().

  {
    if(fAxis.NDimensions() != 2){
      std::cout << "Error: This Ratio does not appear to be 2D." << std::endl;
      abort();
    }

    TH2* ret = ana::ToTH2Helper(std::unique_ptr<TH1>(ToTH1()),
                                fAxis.GetBinnings()[0], 
                                fAxis.GetBinnings()[1]);

    ret->GetXaxis()->SetTitle(fAxis.GetLabels()[0].c_str());
    ret->GetYaxis()->SetTitle(fAxis.GetLabels()[1].c_str());

    // Allow GetMean() and friends to work even if this histogram never had any
    // explicit Fill() calls made.
    if(ret->GetEntries() == 0) ret->SetEntries(1);

    return ret;
  }

Friends And Related Function Documentation

friend class Spectrum

friend

Definition at line 11 of file Ratio.h.

Member Data Documentation

LabelsAndBins ana::Ratio::fAxis

protected

Definition at line 57 of file Ratio.h.

Referenced by ToTH1(), and ToTH2().

Hist ana::Ratio::fHist

protected

Definition at line 56 of file Ratio.h.

Referenced by GetEigen(), GetEigenStan(), HasStan(), operator*=(), ana::Spectrum::operator*=(), operator/=(), ana::Spectrum::operator/=(), Ratio(), and ToTH1().

---

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

• CAFAna/Core/Ratio.h
• CAFAna/Core/Ratio.cxx