QuantileCuts.h

Go to the documentation of this file.

#pragma once

#include "CAFAna/Core/SpectrumLoader.h"
#include "CAFAna/Core/Spectrum.h"
#include "CAFAna/Core/HistAxis.h"
#include "CAFAna/Core/Cut.h"
#include "CAFAna/Core/Var.h"
#include "CAFAna/Core/SystShifts.h"
#include "CAFAna/Core/Var.h"
#include "CAFAna/Cuts/SpillCuts.h"
#include "3FlavorAna/Cuts/NumuCuts2018.h"

class TH2;

namespace ana{
  /// \brief Returns a TH2D with xAxis as independentAxis and yAxis as quantileAxis
  /// Quantiles in yAxis can be calculated from this using \ref ana::GetQuantileBins
  TH2* MakeQuantileHistogram(SpectrumLoader& loader,
                             const HistAxis& independentAxis,
                             const HistAxis& quantileAxis,
                             const Cut& cut,
                             const SpillCut& spillCut = kStandardSpillCuts,
                             const SystShifts& shift = kNoShift,
                             const Var& wei = kUnweighted);
  /// \brief Returns a 2D vector
  /// First index is the independentAxis bin number
  /// Second index is the high bin edge for a quantile
  /// [i][j-1] is jth quantile's low  edge for ith independentAxis bin
  /// [i][j]   is jth quantile's high edge for ith independentAxis bin
  std::vector<std::vector<double>> GetQuantileBins(TH2* quantileHist,
                                                   const HistAxis& independentAxis,
                                                   const HistAxis& quantileAxis,
                                                   const unsigned int& numQuantiles,
                                                   const bool verbose = true);
  /// \brief Returns a 2D vector
  /// First index is the independentAxis bin number
  /// Second index is the high bin edge for a quantile
  /// [i][j-1] is jth quantile's low  edge for ith independentAxis bin
  /// [i][j]   is jth quantile's high edge for ith independentAxis bin
  std::vector<std::vector<double>> GetQuantileBins(SpectrumLoader& loader,
                                                   const HistAxis& independentAxis,
                                                   const HistAxis& quantileAxis,
                                                   const Cut& cut,
                                                   const unsigned int& numQuantiles,
                                                   const SpillCut& spillCut = kStandardSpillCuts,
                                                   const SystShifts& shift = kNoShift,
                                                   const Var& wei = kUnweighted,
                                                   const bool verbose = true);

  /// \brief Class to Generate a \ref ana::Cut that passes events that fall into the requested quantile in quantile axis. It is specialised via the constructor arguments
  /// \param independentAxis - each bin on this axis will be treated independently (i.e. quantiles will be calculated for each independentAxis bin)
  /// \param quantileAxis - the axis to split into quantiles. This is done separately for each independentAxis bin
  /// \param quantile - the quantile to pass, other quantiles fail. The first quantile is 1
  /// \param quantileBins - 2D array specifying quantileAxis quantile edges. 1st index is over independentAxis, second over quantile

  class QuantileCutGenerator{
  public:

  QuantileCutGenerator(const HistAxis& independentAxis,
                       const HistAxis& quantileAxis,
                       const unsigned int& quantile,
                       const std::vector<std::vector<double>>& quantileBins);

    /// \brief Defines the Cut this Instance generates. Returns true if the slice is in the quantile set in quantile
    bool operator() (const caf::SRProxy* sr) const;
  protected:
    HistAxis fIndependentAxis;
    HistAxis fQuantileAxis;
    unsigned int fQuantile;
    std::vector<std::vector<double>> fQuantileBins;
  };

  /// \brief Returns a Cut that will only pass events falling into a particular quantile of quantileAxis, where quantiles have been calculated for each independentAxis bin
  /// Quantiles have been precalculated in 'quantileBins' (number of quantiles, bin edges etc.)
  const Cut QuantileCut(const std::vector<std::vector<double>>& quantileBins,
                        const HistAxis& independentAxis,
                        const HistAxis& quantileAxis,
                        const unsigned int& quantile);

  /// \brief Returns a vector of Cuts, each one for a different quantile
  /// An individual cut will only pass events falling into a particular quantile of quantileAxis, where quantiles have been calculated for each independentAxis bin
  std::vector<Cut> QuantileCuts(SpectrumLoader& loader,
                                const HistAxis& independentAxis,
                                const HistAxis& quantileAxis,
                                const Cut& cut,
                                const unsigned int& numQuantiles,
                                const SpillCut& spillCut = kStandardSpillCuts,
                                const SystShifts& shift = kNoShift,
                                const Var& wei = kUnweighted,
                                const bool verbose = true);

  /// \brief Returns a vector of Cuts, each one for a different quantile
  /// An individual cut will only pass events falling into a particular quantile of quantileAxis, where quantiles have been calculated for each independentAxis bin
  /// This function takes in a 2D FD spectra which has already been filled (by whatever means.)
  std::vector<Cut> QuantileCutsFromTH2(
    TH2* quantileHist,
    const HistAxis& independentAxis,
    const HistAxis& quantileAxis,
    const unsigned int& numQuantiles,
    const bool verbose = true
  );

  std::vector<Cut> QuantileAndPIDCutsFromTH2(
    TH2* quantileHist,
    const HistAxis& independentAxis,
    const HistAxis& quantileAxis,
    const unsigned int& numQuantiles,
    const bool rhc = true,
    const bool verbose = true
  );


}//namespace