ana::_HistAxis< T > Class Template Reference

Collect information describing the x-axis of an analysis histogram. More...

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

Inheritance diagram for ana::_HistAxis< T >:

Public Member Functions
	_HistAxis (const std::vector< std::string > &labels, const std::vector< Binning > &bins, const std::vector< T > &vars={})
	_HistAxis (const std::string &label, const Binning &bins, const T &var)
	_HistAxis (const std::string &label, const Binning &bins)
	_HistAxis (const std::string &labelX, const Binning &binsX, const T &varX, const std::string &labelY, const Binning &binsY, const T &varY)
	_HistAxis (const std::string &label, int nx, double x0, double x1, const T &var)
	Shortcut for simple binnings. More...
	_HistAxis (const std::string &labelX, int nx, double x0, double x1, const T &varX, const std::string &labelY, int ny, double y0, double y1, const T &varY)
	Shortcut for simple binnings. More...
	_HistAxis (const _HistAxis< T > &ax)=default
	_HistAxis (const std::vector< _HistAxis< T >> &axes)
	_HistAxis (const _HistAxis< T > &xax, const _HistAxis< T > &yax)
	_HistAxis (const _HistAxis< T > &xax, const _HistAxis< T > &yax, const _HistAxis< T > &zax)
bool	HasVars () const
const std::vector< T > &	GetVars () const
T	GetVar1D () const
unsigned int	NDimensions () const
const std::vector< std::string > &	GetLabels () const
const std::vector< Binning > &	GetBinnings () const
const Binning &	GetBins1D () const
	Appropriate binning and labelling for that 1D Var. More...
const std::string &	GetLabel1D () const

Protected Attributes
std::vector< T >	fVars
std::vector< std::string >	fLabels
std::vector< Binning >	fBins
std::optional< Binning >	fBins1D
std::optional< std::string >	fLabel1D

Detailed Description

template<class T>
class ana::_HistAxis< T >

Collect information describing the x-axis of an analysis histogram.

That is, what it should be labelled, what the binning should be, and what variable will be being filled into it.

Definition at line 18 of file HistAxis.h.

Constructor & Destructor Documentation

template<class T>

ana::_HistAxis< T >::_HistAxis	(	const std::vector< std::string > &	labels,
		const std::vector< Binning > &	bins,
		const std::vector< T > &	vars = {}
	)

Definition at line 19 of file HistAxis.cxx.

References ana::assert(), ana::LabelsAndBins::fBins, and ana::_HistAxis< T >::fVars.

Referenced by ana::_HistAxis< Var >::_HistAxis().

    : LabelsAndBins(labels, bins), fVars(vars)
  {
    assert(fBins.size() == fVars.size() || fVars.empty());
  }

template<class T>

ana::_HistAxis< T >::_HistAxis ( const std::string &  label, const Binning &  bins, const T &  var  )

inline

Definition at line 27 of file HistAxis.h.

      : _HistAxis(std::vector<std::string>(1, label),
                  std::vector<Binning>(1, bins),
                  std::vector<T>(1, var))
    {
    }

template<class T>

ana::_HistAxis< T >::_HistAxis ( const std::string &  label, const Binning &  bins  )

inline

Definition at line 36 of file HistAxis.h.

      : _HistAxis(std::vector<std::string>(1, label),
                        std::vector<Binning>(1, bins))
    {
    }

template<class T>

ana::_HistAxis< T >::_HistAxis ( const std::string &  labelX, const Binning &  binsX, const T &  varX, const std::string &  labelY, const Binning &  binsY, const T &  varY  )

inline

Definition at line 43 of file HistAxis.h.

      : _HistAxis({labelX, labelY}, {binsX, binsY}, {varX, varY})
    {
    }

template<class T>

ana::_HistAxis< T >::_HistAxis ( const std::string &  label, int  nx, double  x0, double  x1, const T &  var  )

inline

Shortcut for simple binnings.

Definition at line 54 of file HistAxis.h.

      : _HistAxis(label, Binning::Simple(nx, x0, x1), var)
    {
    }

template<class T>

ana::_HistAxis< T >::_HistAxis ( const std::string &  labelX, int  nx, double  x0, double  x1, const T &  varX, const std::string &  labelY, int  ny, double  y0, double  y1, const T &  varY  )

inline

Shortcut for simple binnings.

Definition at line 62 of file HistAxis.h.

      :  _HistAxis(labelX, Binning::Simple(nx, x0, x1), varX,
                   labelY, Binning::Simple(ny, y0, y1), varY)
    {
    }

template<class T>

ana::_HistAxis< T >::_HistAxis ( const _HistAxis< T > &  ax )

default

template<class T>

ana::_HistAxis< T >::_HistAxis

(

const std::vector< _HistAxis< T >> &

axes

)

Definition at line 29 of file HistAxis.cxx.

References a, ana::assert(), file_size_ana::axes, ana::LabelsAndBins::fBins, ana::LabelsAndBins::fLabels, and ana::_HistAxis< T >::fVars.

    : LabelsAndBins(std::vector<std::string>(), std::vector<Binning>())
  {
    for(const auto& a: axes){
      fLabels.insert(fLabels.end(), a.fLabels.begin(), a.fLabels.end());
      fBins.insert(fBins.end(), a.fBins.begin(), a.fBins.end());
      fVars.insert(fVars.end(), a.fVars.begin(), a.fVars.end());
    }

    assert(fLabels.size() == fBins.size());
    assert(fBins.size() == fVars.size() || fVars.empty());
  }

template<class T>

ana::_HistAxis< T >::_HistAxis ( const _HistAxis< T > &  xax, const _HistAxis< T > &  yax  )

inline

Definition at line 77 of file HistAxis.h.

      : _HistAxis(std::vector<_HistAxis<T>>{xax, yax})
    {
    }

template<class T>

ana::_HistAxis< T >::_HistAxis ( const _HistAxis< T > &  xax, const _HistAxis< T > &  yax, const _HistAxis< T > &  zax  )

inline

Definition at line 83 of file HistAxis.h.

      : _HistAxis(std::vector<_HistAxis<T>>{xax, yax, zax})
    {
    }

Member Function Documentation

const std::vector<Binning>& ana::LabelsAndBins::GetBinnings ( ) const

inlineinherited

Definition at line 69 of file LabelsAndBins.h.

References ana::LabelsAndBins::fBins, ana::LabelsAndBins::GetBins1D(), ana::LabelsAndBins::GetLabel1D(), and string.

Referenced by ana::ReweightableSpectrum::_SaveTo(), datamc_ND_numu_kinematics(), datamc_ND_numu_kinematics_FHC(), datamc_ND_numu_kinematics_FHC_REW(), datamc_ND_numu_kinematics_FHC_REW_pTBins(), datamc_ND_numu_kinematics_REW(), datamc_ND_numu_kinematics_RHC(), datamc_ND_numu_kinematics_RHC_REW(), datamc_ND_numu_kinematics_RHC_REW_pTBins(), FDDataMC(), get_data_and_cosmic(), ana::covmx::Sample::GetBinning(), ana::ReweightableSpectrum::GetBinnings(), ana::Spectrum::GetBinnings(), ana::GetQuantileBins(), ana::ReweightableSpectrum::GetTrueBinnings(), HistAxis2D(), ana::HistAxisFromNuTruthHistAxis(), nue_data_mc_validation(), nue_decomp_scales(), nue_fd_mc_validation(), nus17_fiducial_accounting(), ana::QuantileCutGenerator::operator()(), PlotResolution(), ana::TwoSampleDecomp::RatioCalc(), rock(), and signal_count().

{return fBins;}

const Binning & ana::LabelsAndBins::GetBins1D ( ) const

inherited

Appropriate binning and labelling for that 1D Var.

Definition at line 27 of file LabelsAndBins.cxx.

References ana::assert(), b, ana::LabelsAndBins::fBins, ana::LabelsAndBins::fBins1D, getGoodRuns4SAM::n, and ana::Binning::Simple().

Referenced by ana::ReweightableSpectrum::Fill(), ana::Spectrum::Fill(), ana::LabelsAndBins::GetBinnings(), ana::ReweightableSpectrum::LoadFrom(), ana::Spectrum::Mean(), ana::Spectrum::SaveTo(), ana::Spectrum::Spectrum(), ana::Spectrum::ToTH1(), and ana::ReweightableSpectrum::ToTH2().

  {
    if(fBins.size() == 1) return fBins[0];

    if(fBins1D) return *fBins1D;

    assert(!fBins.empty());

    int n = 1;
    for(const Binning& b: fBins) n *= b.NBins();
    fBins1D = Binning::Simple(n, 0, n);

    return *fBins1D;
  }

const std::string & ana::LabelsAndBins::GetLabel1D ( ) const

inherited

Definition at line 43 of file LabelsAndBins.cxx.

References ana::LabelsAndBins::fLabel1D, ana::LabelsAndBins::fLabels, submit_hadd::l, and string.

Referenced by ana::LabelsAndBins::GetBinnings(), ana::Spectrum::ToTH1(), and ana::ReweightableSpectrum::ToTH2().

  {
    if(fLabels.size() == 1) return fLabels[0];

    if(fLabel1D) return *fLabel1D;

    fLabel1D = "";
    for(const std::string& l: fLabels) *fLabel1D += l + " and ";
    fLabel1D->resize(fLabel1D->size()-5); // drop extra "and"

    return *fLabel1D;
  }

const std::vector<std::string>& ana::LabelsAndBins::GetLabels ( ) const

inlineinherited

Definition at line 68 of file LabelsAndBins.h.

References ana::LabelsAndBins::fLabels.

Referenced by ana::ReweightableSpectrum::_SaveTo(), datamc_ND_numu_kinematics(), datamc_ND_numu_kinematics_FHC(), datamc_ND_numu_kinematics_FHC_REW(), datamc_ND_numu_kinematics_FHC_REW_pTBins(), datamc_ND_numu_kinematics_REW(), datamc_ND_numu_kinematics_RHC(), datamc_ND_numu_kinematics_RHC_REW(), datamc_ND_numu_kinematics_RHC_REW_pTBins(), FDDataMC(), get_data_and_cosmic(), ana::ReweightableSpectrum::GetLabels(), ana::Spectrum::GetLabels(), ana::GetQuantileBins(), HistAxis2D(), ana::HistAxisFromNuTruthHistAxis(), nue_data_mc_validation(), nue_decomp_scales(), nue_fd_mc_validation(), nus17_fiducial_accounting(), Nus18SystsBeamTranspAna(), Nus18SystsCalibAbsAna(), Nus18SystsCalibRelAna(), Nus18SystsGENIEAna(), Nus18SystsKaonAna(), Nus18SystsLightLevelAna(), Nus18SystsLLMethodAna(), Nus18SystsNeutronAna(), Nus18SystsPPFXAna(), Nus18SystsTauAna(), Nus18SystsXSecOnOffAna(), PlotResolution(), rock(), and signal_count().

{return fLabels;}

template<class T >

T ana::_HistAxis< T >::GetVar1D

(

)

const

A variable "flattening" all the dimensions into one 1D value. Use sparingly.

Definition at line 43 of file HistAxis.cxx.

References om::cout, allTimeWatchdog::endl, ana::LabelsAndBins::fBins, ana::_HistAxis< T >::fVars, ana::MultiVar2D(), ana::Var2D(), and ana::Var3D().

Referenced by ana::FluxReweight::FluxReweight(), ana::_HistAxis< Var >::GetVars(), ana::Multiverse::Multiverse(), ana::NoReweight::NoReweight(), ana::RecoReweight::RecoReweight(), and ana::TrivialExtrap::TrivialExtrap().

  {
    switch(fVars.size()){
    case 1:
      return fVars[0];
    case 2:
      if constexpr(std::is_same_v<T, MultiVar>)
        return MultiVar2D(fVars[0], fBins[0], fVars[1], fBins[1]);
      else
        return Var2D(fVars[0], fBins[0],
                     fVars[1], fBins[1]);
    case 3:
      if constexpr(!std::is_same_v<T, MultiVar>) // for MultiVar fall-through to the error
        return Var3D(fVars[0], fBins[0],
                     fVars[1], fBins[1],
                     fVars[2], fBins[2]);
    default:
      std::cout << "Error: HistAxis::GetVar1D() doesn't support "
                << fVars.size() << "-dimensional axes" << std::endl;
      abort();
    }
  }

template<class T>

const std::vector<T>& ana::_HistAxis< T >::GetVars ( ) const

inline

Definition at line 92 of file HistAxis.h.

Referenced by datamc_ND_numu_kinematics(), datamc_ND_numu_kinematics_FHC(), datamc_ND_numu_kinematics_FHC_REW(), datamc_ND_numu_kinematics_FHC_REW_pTBins(), datamc_ND_numu_kinematics_REW(), datamc_ND_numu_kinematics_RHC(), datamc_ND_numu_kinematics_RHC_REW(), datamc_ND_numu_kinematics_RHC_REW_pTBins(), ana::Efficiency(), FDDataMC(), get_data_and_cosmic(), ana::HistAxisFromNuTruthHistAxis(), nue_data_mc_validation(), nue_decomp_scales(), nue_fd_mc_validation(), nus17_fiducial_accounting(), ana::QuantileCutGenerator::operator()(), and rock().

{return fVars;}

template<class T>

bool ana::_HistAxis< T >::HasVars ( ) const

inline

Definition at line 90 of file HistAxis.h.

{return !fVars.empty();}

unsigned int ana::LabelsAndBins::NDimensions ( ) const

inlineinherited

Definition at line 66 of file LabelsAndBins.h.

References ana::LabelsAndBins::fLabels.

Referenced by ana::ReweightableSpectrum::_SaveTo(), ana::GetQuantileBins(), ana::ReweightableSpectrum::NDimensions(), ana::Spectrum::NDimensions(), ana::QuantileCut(), ana::QuantileCutGenerator::QuantileCutGenerator(), ana::TrivialCrossSectionAnalysis::TrivialCrossSectionAnalysis(), and ana::TwoSampleDecomp::TwoSampleDecomp().

{return fLabels.size();}

Member Data Documentation

std::vector<Binning> ana::LabelsAndBins::fBins

protectedinherited

Definition at line 77 of file LabelsAndBins.h.

Referenced by ana::_HistAxis< T >::_HistAxis(), ana::LabelsAndBins::GetBinnings(), ana::LabelsAndBins::GetBins1D(), ana::_HistAxis< T >::GetVar1D(), and ana::LabelsAndBins::LabelsAndBins().

std::optional<Binning> ana::LabelsAndBins::fBins1D

mutableprotectedinherited

Definition at line 79 of file LabelsAndBins.h.

Referenced by ana::LabelsAndBins::GetBins1D().

std::optional<std::string> ana::LabelsAndBins::fLabel1D

mutableprotectedinherited

Definition at line 80 of file LabelsAndBins.h.

Referenced by ana::LabelsAndBins::GetLabel1D().

std::vector<std::string> ana::LabelsAndBins::fLabels

protectedinherited

Definition at line 76 of file LabelsAndBins.h.

Referenced by ana::_HistAxis< T >::_HistAxis(), ana::LabelsAndBins::GetLabel1D(), ana::LabelsAndBins::GetLabels(), ana::LabelsAndBins::LabelsAndBins(), and ana::LabelsAndBins::NDimensions().

template<class T>

std::vector<T> ana::_HistAxis< T >::fVars

protected

Definition at line 99 of file HistAxis.h.

Referenced by ana::_HistAxis< T >::_HistAxis(), ana::_HistAxis< T >::GetVar1D(), ana::_HistAxis< Var >::GetVars(), and ana::_HistAxis< Var >::HasVars().

---

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

• CAFAna/Core/HistAxis.h
• CAFAna/Core/HistAxis.cxx