HistogramPoolTest.cxx

Go to the documentation of this file.

 
#include <catch2/catch_test_macros.hpp>
#include <catch2/matchers/catch_matchers.hpp>  // IWYU pragma: keep
 
#include "Framework/HistogramPool.h"
#include "TFile.h"  //to open and check root files
 
using framework::HistogramPool;
 
TDirectory* cantCreateDir() {
  throw std::runtime_error("NOFILEGIVEN");
  return nullptr;
}
 
TEST_CASE("HistogramPool Functions", "[Framework][functionality]") {
  const char* test_file = "/tmp/test_histogram_pool.root";
 
  SECTION("exception on request") {
    HistogramPool test_pool{cantCreateDir};
    // raise exception from get_directory
    REQUIRE_THROWS_WITH(test_pool.create("dne", "foo", 10, 0.0, 1.0),
                        "NOFILEGIVEN");
  }
 
  SECTION("creation on request") {
    TFile* histogram_file{nullptr};
    auto open_on_request = [&histogram_file, &test_file]() -> TDirectory* {
      if (histogram_file == nullptr) {
        histogram_file = TFile::Open(test_file, "recreate");
      }
      return histogram_file->mkdir("histo_directory");
    };
    HistogramPool test_pool{open_on_request};
    // test_file has not been opened yet
    REQUIRE(histogram_file == nullptr);
    test_pool.create("h", "bla", 10, 0, 1);
    // test_file exists with histo_directory/ inside of it
    REQUIRE(histogram_file != nullptr);
    CHECK(histogram_file->Get("histo_directory") != nullptr);
    histogram_file->Write();
    // test_file exists with histo_directory/h inside of it
    CHECK(histogram_file->Get("histo_directory/h") != nullptr);
  }
 
  SECTION("separate pools") {
    TFile histogram_file{test_file, "recreate"};
    HistogramPool test_pool_1{[&histogram_file]() {
      static TDirectory* d{histogram_file.mkdir("p1")};
      return d;
    }};
    HistogramPool test_pool_2{[&histogram_file]() {
      static TDirectory* d{histogram_file.mkdir("p2")};
      return d;
    }};
    CHECK(histogram_file.Get("p1") == nullptr);
    CHECK(histogram_file.Get("p2") == nullptr);
    test_pool_1.create("h", "bar", 10, 0, 1);
    CHECK(histogram_file.Get("p1") != nullptr);
    CHECK(histogram_file.Get("p2") == nullptr);
    test_pool_2.create("h", "buz", 10, 0, 10);
    CHECK(histogram_file.Get("p1") != nullptr);
    CHECK(histogram_file.Get("p2") != nullptr);
    histogram_file.Write();
    // test_file exists with
    //  p1/h -> 10 bins between 0 and 1
    //  p2/h -> 10 bins between 0 and 10
    auto h1 = dynamic_cast<TH1F*>(histogram_file.Get("p1/h"));
    auto h2 = dynamic_cast<TH1F*>(histogram_file.Get("p2/h"));
    REQUIRE(h1 != nullptr);
    REQUIRE(h2 != nullptr);
    CHECK(h1->GetNbinsX() == 10);
    CHECK(h2->GetNbinsX() == 10);
    CHECK(h1->GetBinLowEdge(10) == 0.9);
    CHECK(h2->GetBinLowEdge(10) == 9);
  }
 
  // different types of creation
  SECTION("different types of histograms") {
    TFile histogram_file{test_file, "recreate"};
    HistogramPool test_pool{[&histogram_file]() {
      static TDirectory* d{histogram_file.mkdir("p")};
      return d;
    }};
    std::vector<std::string> cats{"one", "two", "three"};
 
    test_pool.create("h1_1", "foo", 10, 0, 1);
    test_pool.create("h1_2", "bar", {0.0, 0.5, 0.8, 1.0}, true);
    test_pool.create("h1_3", "", cats);
 
    test_pool.create("h2_1", "baz", 5, -5, 5, "foo", 10, -5, 5);
    test_pool.create("h2_2", "baz", {-5.0, -1.0, 0.0, 1.0, 5.0}, "foo",
                     {0.0, 1.0, 5.0});
    test_pool.create("h2_3", "", cats, "", cats);
 
    test_pool.setWeight(0.75);
    test_pool.fill("h1_2", 0.75);
    test_pool.fillw("h1_2", 0.1, 0.5);
    test_pool.fill("h1_2", 0.75);
    test_pool.setWeight(1);
 
    test_pool.fill("h1_3", "one");
    // "one" again because categories are zero-indexed into bins
    test_pool.fill("h1_3", 0);
    // "two" because categories are zero-indexed into bins
    test_pool.fill("h1_3", 1);
    // "three" into third bin
    test_pool.fill("h1_3", "three");
    // unknown category auto-expands Nbins when
    // doing categorical axes
    // test_pool.fill("h1_3", "four");
 
    test_pool.fill("h2_3", "one", "two");
 
    histogram_file.Write();
 
    auto h1_1 = dynamic_cast<TH1F*>(histogram_file.Get("p/h1_1"));
    REQUIRE(h1_1 != nullptr);
    CHECK(h1_1->GetNbinsX() == 10);
    CHECK(h1_1->GetBinLowEdge(1) == 0.0);
    CHECK(h1_1->GetBinLowEdge(11) == 1.0);
    REQUIRE(h1_1->GetSumw2() != nullptr);
    CHECK(h1_1->GetSumw2()->fN == 0);
 
    auto h1_2 = dynamic_cast<TH1F*>(histogram_file.Get("p/h1_2"));
    REQUIRE(h1_2 != nullptr);
    CHECK(h1_2->GetNbinsX() == 3);
    CHECK(h1_2->GetBinLowEdge(1) == 0.0);
    CHECK(h1_2->GetBinLowEdge(2) == 0.5);
    CHECK(h1_2->GetBinLowEdge(3) == 0.8);
    CHECK(h1_2->GetBinLowEdge(4) == 1.0);
    CHECK(h1_2->GetBinContent(1) == 0.5);
    CHECK(h1_2->GetBinContent(2) == 2 * 0.75);
    REQUIRE(h1_2->GetSumw2() != nullptr);
    CHECK(h1_2->GetSumw2()->fN == 5);
    CHECK(h1_2->GetSumw2()->At(1) == 0.25);
    CHECK(h1_2->GetSumw2()->At(2) == 0.75 * 0.75 * 2);
 
    auto h1_3 = dynamic_cast<TH1F*>(histogram_file.Get("p/h1_3"));
    REQUIRE(h1_3 != nullptr);
    CHECK(h1_3->GetNbinsX() == 3);
 
    CHECK(h1_3->GetBinContent(0) == 0);  // under
    CHECK(h1_3->GetBinContent(1) == 2);  // one
    CHECK(h1_3->GetBinContent(2) == 1);  // two
    CHECK(h1_3->GetBinContent(3) == 1);  // three
    CHECK(h1_3->GetBinContent(4) == 0);  // over
 
    auto h2_1 = dynamic_cast<TH2F*>(histogram_file.Get("p/h2_1"));
    REQUIRE(h2_1 != nullptr);
    CHECK(h2_1->GetNbinsX() == 5);
    CHECK(h2_1->GetNbinsY() == 10);
 
    auto h2_2 = dynamic_cast<TH2F*>(histogram_file.Get("p/h2_2"));
    REQUIRE(h2_2 != nullptr);
    CHECK(h2_2->GetNbinsX() == 4);
    CHECK(h2_2->GetNbinsY() == 2);
 
    auto h2_3 = dynamic_cast<TH2F*>(histogram_file.Get("p/h2_3"));
    REQUIRE(h2_3 != nullptr);
    CHECK(h2_3->GetBinContent(1, 2) == 1);
  }
}