ana::SpectrumComponents Class Reference

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-25/CAFAna/Analysis/SpectrumComponents.h"

Classes
struct	Component

Public Member Functions
	SpectrumComponents (const ana::Cut &baseCut, const ana::HistAxis &axis, ana::SpectrumLoaderBase &loader, const Var &wei=kUnweighted, const std::map< std::string, Component > &categories={})
	SpectrumComponents makes a collection of Spectra differing by a single (often truth) Cut. More...
	SpectrumComponents (const ana::Cut &baseCut, const ana::MultiVarHistAxis &axis, ana::SpectrumLoaderBase &loader, const Var &wei=kUnweighted, const std::map< std::string, Component > &categories={})
	SpectrumComponents (Spectrum &&tot, std::map< std::string, Component > &&compDescrs, std::map< std::string, Spectrum > &&compSpecs)
	Constructor for use in LoadFrom() More...
	SpectrumComponents (const Spectrum &tot, const std::map< std::string, Component > &compDescrs, const std::map< std::string, Spectrum > &compSpecs)
	Constructor from copies... More...
TLegend *	DrawLegend (double drawThreshold=0, TLegend *leg=nullptr) const
	Draw legend on plots. More...
void	DrawComponents (bool stacked=true, EBinType bintype=kBinContent, double POT=0, bool sameAll=true) const
	Draw MC components distribution. More...
float	Purity (const std::set< std::string > &signalCatNames={}) const
	Purity of the MC selection based on the MC subcategories. More...
void	SaveTo (TDirectory *dir, const std::string &name) const
const ana::Cut &	Sel () const
Spectrum &	Tot ()
const Spectrum &	Tot () const
unsigned int	NDimensions () const
std::vector< std::string >	GetLabels () const
std::vector< Binning >	GetBinnings () const
const std::map< std::string, Component > &	ComponentDescrs () const
std::map< std::string, Component > &	ComponentDescrs ()
const std::map< std::string, Spectrum > &	ComponentSpecs () const

Static Public Member Functions
static std::unique_ptr< SpectrumComponents >	LoadFrom (TDirectory *dir, const std::string &name)

Private Attributes
ana::Cut	fSel
Spectrum	fTot
std::map< std::string, Component >	fComponentDescr
std::map< std::string, Spectrum >	fComponentSpecs

Detailed Description

Definition at line 16 of file SpectrumComponents.h.

Constructor & Destructor Documentation

ana::SpectrumComponents::SpectrumComponents	(	const ana::Cut &	baseCut,
		const ana::HistAxis &	axis,
		ana::SpectrumLoaderBase &	loader,
		const Var &	wei = kUnweighted,
		const std::map< std::string, Component > &	categories = {}
	)

SpectrumComponents makes a collection of Spectra differing by a single (often truth) Cut.

Parameters

baseCut	the selection cut shared between all components
axis	HistAxis shared between all components
loaderData	SpectrumLoader for data
loaderMC	SpectrumLoader for MC
wei	Weight to apply to events
systs	std::vector of ISyst* for drawing plots with syst bands
bkg	Cut object to define background
mcCategories	the various Cut s defining each category

Definition at line 19 of file SpectrumComponents.cxx.

References fComponentDescr, fComponentSpecs, fSel, and ana::kNoShift.

  :
    fSel(baseCut),
    fTot(loader, axis, fSel, kNoShift, wei)
  {
    if (!categories.empty())
    {
      for (const auto & componentPair : categories)
      {
        fComponentDescr.emplace(componentPair.first, componentPair.second);
        fComponentSpecs.emplace(std::piecewise_construct,
                                std::forward_as_tuple(componentPair.first),
                                std::forward_as_tuple(loader, axis, fSel && componentPair.second.cut, kNoShift, wei));
      }
    }
  }

ana::SpectrumComponents::SpectrumComponents	(	const ana::Cut &	baseCut,
		const ana::MultiVarHistAxis &	axis,
		ana::SpectrumLoaderBase &	loader,
		const Var &	wei = kUnweighted,
		const std::map< std::string, Component > &	categories = {}
	)

Definition at line 41 of file SpectrumComponents.cxx.

References fComponentDescr, fComponentSpecs, fSel, and ana::kNoShift.

  :
    fSel(baseCut),
    fTot(loader, axis, fSel, kNoShift, wei)
  {
    if (!categories.empty())
    {
      for (const auto & componentPair : categories)
      {
        fComponentDescr.emplace(componentPair.first, componentPair.second);
        fComponentSpecs.emplace(std::piecewise_construct,
                                std::forward_as_tuple(componentPair.first),
                                std::forward_as_tuple(loader, axis, fSel && componentPair.second.cut, kNoShift, wei));
      }
    }
  }

ana::SpectrumComponents::SpectrumComponents ( Spectrum &&  tot, std::map< std::string, Component > &&  compDescrs, std::map< std::string, Spectrum > &&  compSpecs  )

inline

Constructor for use in LoadFrom()

Definition at line 53 of file SpectrumComponents.h.

       : fSel(kNoCut),
         fTot(tot),
         fComponentDescr(compDescrs),
         fComponentSpecs(compSpecs)
      {}

ana::SpectrumComponents::SpectrumComponents ( const Spectrum &  tot, const std::map< std::string, Component > &  compDescrs, const std::map< std::string, Spectrum > &  compSpecs  )

inline

Constructor from copies...

Definition at line 63 of file SpectrumComponents.h.

References dir, DrawComponents(), DrawLegend(), ana::kBinContent, MECModelEnuComparisons::leg, LoadFrom(), POT, Purity(), SaveTo(), and string.

       : fSel(kNoCut),
         fTot(tot),
         fComponentDescr(compDescrs),
         fComponentSpecs(compSpecs)
      {}

Member Function Documentation

const std::map<std::string, Component>& ana::SpectrumComponents::ComponentDescrs ( ) const

inline

Definition at line 101 of file SpectrumComponents.h.

References fComponentDescr.

Referenced by ana::DataMCPair::DrawLegend(), ana::DataMCPair::SetComponentBlurb(), and ana::DataMCPair::SetComponentColor().

{ return fComponentDescr; };

std::map<std::string, Component>& ana::SpectrumComponents::ComponentDescrs ( )

inline

Definition at line 102 of file SpectrumComponents.h.

References fComponentDescr.

{ return fComponentDescr; };

const std::map<std::string, Spectrum>& ana::SpectrumComponents::ComponentSpecs ( ) const

inline

Definition at line 103 of file SpectrumComponents.h.

{ return fComponentSpecs; };

void ana::SpectrumComponents::DrawComponents	(	bool	stacked = true,
		EBinType	bintype = kBinContent,
		double	POT = 0,
		bool	sameAll = true
	)		const

Draw MC components distribution.

Parameters

stack	By default components will be shown stacked. Pass false to show them unstacked instead.
bintype	Raw bin contents or bin-width normalized?
POT	Normalize to specific POT? Otherwise use internal Spectrum POT
sameAll	Draw all hists with "same" option?

Definition at line 103 of file SpectrumComponents.cxx.

References fComponentDescr, fComponentSpecs, make_syst_table_plots::h, hists, ana::kPOT, MECModelEnuComparisons::opt, and string.

Referenced by ana::DataMCPair::DrawMCComponents(), and SpectrumComponents().

  {
    if (POT == 0)
      POT = fComponentSpecs.begin()->second.POT();

    TH1 * last = nullptr;
    std::vector<TH1*> hists;

    // iterate backwards so that they're drawn in the specified order from top to bottom
    for (auto it_comp = fComponentSpecs.rbegin(); it_comp != fComponentSpecs.rend(); it_comp++)
    {
      auto h = it_comp->second.ToTH1(POT, kBlack, kSolid, kPOT, bintype);
      if (stacked)
      {
        if (last)
         h->Add(last);
        h->SetFillColor(fComponentDescr.at(it_comp->first).color);
        h->SetLineWidth(1);
        last = h;
      }

      hists.push_back(h);
    }
    bool drawn = false;
    for (auto it_hist = hists.rbegin(); it_hist != hists.rend(); it_hist++)
    {
      std::string opt = "hist";
      if (drawn || sameAll)
        opt += " same";
      (*it_hist)->Draw(opt.c_str());
      if (!drawn)
        drawn = true;
    }
  }

TLegend * ana::SpectrumComponents::DrawLegend	(	double	drawThreshold = 0,
		TLegend *	leg = nullptr
	)		const

Draw legend on plots.

Parameters

drawThreshold

Only create entries for histograms whose integral is greater than this fraction of the total

Definition at line 63 of file SpectrumComponents.cxx.

References ana::assert(), ana::AutoPlaceLegend(), fComponentDescr, fComponentSpecs, fTot, ana::Spectrum::Integral(), MECModelEnuComparisons::leg, and ana::Spectrum::POT().

Referenced by ana::DataMCPair::DrawLegend(), and SpectrumComponents().

  {
    if (!leg)
      leg = AutoPlaceLegend(0.25, 0.18 + 0.04*fComponentDescr.size());

    double thresh = 0;
    if (drawThreshold >= 0 && drawThreshold <= 1.0)
      thresh = fTot.Integral(fTot.POT()) * drawThreshold;
    else
      // this is supposed to be a fraction
      assert(drawThreshold <= 1 && "SpectrumComponents::DrawLegend(): legend draw thresholds must be between 0.0 and 1.0");
    for (const auto & mcSpecPair : fComponentDescr)
    {
      auto spec = fComponentSpecs.at(mcSpecPair.first);
      if (spec.Integral(spec.POT()) < thresh)
        continue;

      TH1F* comp = new TH1F();
      comp->SetLineColor(kBlack);
      comp->SetFillColor(mcSpecPair.second.color);
      leg->AddEntry((TObject*)comp, mcSpecPair.second.blurb.c_str(), "f");
    }


    leg->SetFillColor(0);
    leg->SetFillStyle(0);

    for(const auto& obj:*leg->GetListOfPrimitives())
    {
      if(obj->InheritsFrom("TAttFill")){
        ((TAttFill*)obj)->SetFillStyle(0);
        //((TAttFill*)obj)->SetFillColor(0);
      }

    }
    leg->Draw();
    return leg;
  }

std::vector<Binning> ana::SpectrumComponents::GetBinnings ( ) const

inline

Definition at line 99 of file SpectrumComponents.h.

References fTot, and ana::Spectrum::GetBinnings().

{ return fTot.GetBinnings(); }

std::vector<std::string> ana::SpectrumComponents::GetLabels ( ) const

inline

Definition at line 98 of file SpectrumComponents.h.

References fTot, and ana::Spectrum::GetLabels().

{ return fTot.GetLabels(); }

std::unique_ptr< SpectrumComponents > ana::SpectrumComponents::LoadFrom ( TDirectory *  dir, const std::string &  name  )

static

Definition at line 185 of file SpectrumComponents.cxx.

References ana::assert(), dir, findDuplicateFiles::key, ana::kNoCut, ana::Spectrum::LoadFrom(), runNovaSAM::release, runNovaSAM::ret, cvnie::subdir, and PandAna.Demos.pi0_spectra::tot.

Referenced by ana::DataMCPair::LoadFrom(), and SpectrumComponents().

  {
    dir = dir->GetDirectory(name.c_str()); // switch to subdir
    assert(dir);

    Spectrum tot = *Spectrum::LoadFrom(dir, "Total");

    std::map<std::string, Component> compDescrs;
    std::map<std::string, Spectrum> compSpecs;
    TDirectory * compDir = dynamic_cast<TDirectory*>(dir->Get("Components"));
    for ( TObject * obj : *(compDir->GetListOfKeys()) )
    {
      TKey * key = dynamic_cast<TKey*>(obj);
      TDirectory * subdir = dynamic_cast<TDirectory*>(key->ReadObj());
      if (!subdir)
        continue;

      compSpecs.emplace(key->GetName(), *(Spectrum::LoadFrom(compDir, key->GetName()).release()));
      compDescrs.emplace(std::piecewise_construct,
                           std::forward_as_tuple(key->GetName()),
                           std::forward_as_tuple(kNoCut,  // Cut object won't be re-used anyhow since Spectra are already made?
                                                 dynamic_cast<TObjString*>(subdir->Get("blurb"))->String().Data(),
                                                 dynamic_cast<TParameter<int>*>(subdir->Get("color"))->GetVal() )
      );
    }

    auto ret = std::make_unique<SpectrumComponents>(
        std::move(tot),
        std::move(compDescrs),
        std::move(compSpecs)
    );

    delete dir;

    return std::move(ret);

  }

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

inline

Definition at line 97 of file SpectrumComponents.h.

References fTot, and ana::Spectrum::NDimensions().

{ return fTot.NDimensions(); }

float ana::SpectrumComponents::Purity

(

const std::set< std::string > &

signalCatNames = {}

)

const

Purity of the MC selection based on the MC subcategories.

Parameters

signalCatNames

If any of your subcategories are "signal", pass them here to avoid counting them as background

Definition at line 139 of file SpectrumComponents.cxx.

References fComponentSpecs, fTot, POT, and ana::Spectrum::ToTH1().

Referenced by ana::DataMCPair::Purity(), and SpectrumComponents().

  {
    double bkgCounts = 0;
    double POT = fComponentSpecs.begin()->second.POT();
    for (const auto & mcCatPair : fComponentSpecs)
    {
      if (signalCatNames.find(mcCatPair.first) != signalCatNames.end())
        continue;
      bkgCounts += mcCatPair.second.ToTH1(POT)->GetEntries();
    }
    return 1 - bkgCounts / fTot.ToTH1(POT)->GetEntries();
  }

void ana::SpectrumComponents::SaveTo	(	TDirectory *	dir,
		const std::string &	name
	)		const

Definition at line 153 of file SpectrumComponents.cxx.

References plot_validation_datamc_2018::color, dir, fComponentDescr, fComponentSpecs, fTot, ana::Spectrum::SaveTo(), and tmp.

Referenced by ana::DataMCPair::SaveTo(), and SpectrumComponents().

  {
    TDirectory* tmp = gDirectory;

    dir = dir->mkdir(name.c_str()); // switch to subdir
    dir->cd();

    fTot.SaveTo(dir, "Total");

    TDirectory * compsDir = dir->mkdir("Components");
    for (const auto & specPair : fComponentSpecs)
    {
      specPair.second.SaveTo(compsDir, specPair.first);

      TDirectory* compDir = compsDir->GetDirectory(specPair.first.c_str());
      compDir->cd();
      const auto & comp = fComponentDescr.at(specPair.first);
      TObjString blurb(comp.blurb.c_str());
      blurb.Write("blurb");

      TParameter<int> color;
      color.SetVal(comp.color);
      color.Write("color");
    }

    dir->Write();
    delete dir;

    tmp->cd();
  }

const ana::Cut& ana::SpectrumComponents::Sel ( ) const

inline

Definition at line 92 of file SpectrumComponents.h.

References fSel.

{ return fSel; };

Spectrum& ana::SpectrumComponents::Tot ( )

inline

Definition at line 94 of file SpectrumComponents.h.

References fTot.

Referenced by ana::DataMCPair::CreateSystTable(), ana::DataMCPair::DrawMCNormSyst(), and ana::DataMCPair::DrawMCSyst().

{ return fTot; };

const Spectrum& ana::SpectrumComponents::Tot ( ) const

inline

Definition at line 95 of file SpectrumComponents.h.

References fTot.

{ return fTot; };

Member Data Documentation

std::map<std::string, Component> ana::SpectrumComponents::fComponentDescr

private

Definition at line 108 of file SpectrumComponents.h.

Referenced by ComponentDescrs(), DrawComponents(), DrawLegend(), SaveTo(), and SpectrumComponents().

std::map<std::string, Spectrum> ana::SpectrumComponents::fComponentSpecs

private

Definition at line 109 of file SpectrumComponents.h.

Referenced by DrawComponents(), DrawLegend(), Purity(), SaveTo(), and SpectrumComponents().

ana::Cut ana::SpectrumComponents::fSel

private

Definition at line 103 of file SpectrumComponents.h.

Referenced by Sel(), and SpectrumComponents().

Spectrum ana::SpectrumComponents::fTot

private

Definition at line 107 of file SpectrumComponents.h.

Referenced by DrawLegend(), GetBinnings(), GetLabels(), NDimensions(), Purity(), SaveTo(), and Tot().

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-25/CAFAna/Analysis/SpectrumComponents.h
• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-25/CAFAna/Analysis/SpectrumComponents.cxx