Skip to content

Revert "DPL Analysis: Extended histogram registry to use TH2 and TH3" #4170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ktf merged 1 commit into from
Aug 18, 2020
Merged

Revert "DPL Analysis: Extended histogram registry to use TH2 and TH3" #4170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 15 additions & 124 deletions Framework/Core/include/Framework/HistogramRegistry.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,66 +32,31 @@ namespace o2

namespace framework
{
// Most common histogram types
enum HistogramType {
kTH1D,
kTH1F,
kTH1I,
kTH2D,
kTH2F,
kTH2I,
kTH3D,
kTH3F,
kTH3I
};

/// Description of a single histogram axis
struct AxisSpec {
AxisSpec(int nBins_, std::vector<double> bins_, std::string label_ = "")
: nBins(nBins_),
bins(bins_),
binsEqual(false),
label(label_)
{
}

AxisSpec(int nBins_, double binMin_, double binMax_, std::string label_ = "")
: nBins(nBins_),
bins({binMin_, binMax_}),
binsEqual(true),
label(label_)
{
}

AxisSpec() : nBins(1), binsEqual(false), bins(), label("") {}

int nBins;
std::vector<double> bins;
bool binsEqual; // if true, then bins specify min and max for equidistant binning
std::string label;
};

/// Data sctructure that will allow to construct a fully qualified TH* histogram
/// Currently only supports TH1F
struct HistogramConfigSpec {
HistogramConfigSpec(HistogramType type_, std::vector<AxisSpec> axes_)
: type(type_),
axes(axes_),
binsEqual(axes.size() > 0 ? axes[0].binsEqual : false)
HistogramConfigSpec(char const* const kind_, unsigned int nBins_, double xmin_, double xmax_)
: kind(kind_),
nBins(nBins_),
xmin(xmin_),
xmax(xmax_)
{
}

HistogramConfigSpec()
: type(HistogramType::kTH1F),
axes(),
binsEqual(false)
: kind(""),
nBins(1),
xmin(0),
xmax(1)
{
}
HistogramConfigSpec(HistogramConfigSpec const& other) = default;
HistogramConfigSpec(HistogramConfigSpec&& other) = default;

HistogramType type;
std::vector<AxisSpec> axes;
bool binsEqual;
std::string kind;
unsigned int nBins;
double xmin;
double xmax;
};

/// Data structure containing histogram specification for the HistogramRegistry
Expand Down Expand Up @@ -121,80 +86,6 @@ struct HistogramSpec {
HistogramConfigSpec config;
};

class HistogramFactory
{
public:
static std::unique_ptr<TH1> create(HistogramSpec& spec)
{
const auto& it = lookup().find(spec.config.type);
if (it == lookup().end()) {
return nullptr;
}
return std::move(it->second->createImpl(spec));
}

protected:
static std::map<HistogramType, HistogramFactory*>& lookup()
{
static std::map<HistogramType, HistogramFactory*> histMap;
return histMap;
}

private:
virtual std::unique_ptr<TH1> createImpl(HistogramSpec const& spec) = 0;
};

template <typename T>
class HistogramFactoryImpl : public HistogramFactory
{
public:
HistogramFactoryImpl(HistogramType type)
: position(this->lookup().insert(std::make_pair(type, this)).first)
{
}

~HistogramFactoryImpl()
{
this->lookup().erase(position);
}

private:
std::unique_ptr<TH1> createImpl(HistogramSpec const& spec) override
{
if (spec.config.axes.size() == 0) {
throw std::runtime_error("No arguments available in spec to create a histogram");
}
if constexpr (std::is_base_of_v<TH3, T>) {
if (spec.config.binsEqual) {
return std::make_unique<T>(spec.name.data(), spec.readableName.data(), spec.config.axes[0].nBins, spec.config.axes[0].bins[0], spec.config.axes[0].bins[1], spec.config.axes[1].nBins, spec.config.axes[1].bins[0], spec.config.axes[1].bins[1], spec.config.axes[2].nBins, spec.config.axes[2].bins[0], spec.config.axes[2].bins[1]);
}
return std::make_unique<T>(spec.name.data(), spec.readableName.data(), spec.config.axes[0].nBins, spec.config.axes[0].bins.data(), spec.config.axes[1].nBins, spec.config.axes[1].bins.data(), spec.config.axes[2].nBins, spec.config.axes[2].bins.data());
} else if constexpr (std::is_base_of_v<TH2, T>) {
if (spec.config.binsEqual) {
return std::make_unique<T>(spec.name.data(), spec.readableName.data(), spec.config.axes[0].nBins, spec.config.axes[0].bins[0], spec.config.axes[0].bins[1], spec.config.axes[1].nBins, spec.config.axes[1].bins[0], spec.config.axes[1].bins[1]);
}
return std::make_unique<T>(spec.name.data(), spec.readableName.data(), spec.config.axes[0].nBins, spec.config.axes[0].bins.data(), spec.config.axes[1].nBins, spec.config.axes[1].bins.data());
} else if constexpr (std::is_base_of_v<TH1, T>) {
if (spec.config.binsEqual) {
return std::make_unique<T>(spec.name.data(), spec.readableName.data(), spec.config.axes[0].nBins, spec.config.axes[0].bins[0], spec.config.axes[0].bins[1]);
}
return std::make_unique<T>(spec.name.data(), spec.readableName.data(), spec.config.axes[0].nBins, spec.config.axes[0].bins.data());
}
}

typename std::map<HistogramType, HistogramFactory*>::iterator position;
};

HistogramFactoryImpl<TH1D> const hf1d(HistogramType::kTH1D);
HistogramFactoryImpl<TH1F> const hf1f(HistogramType::kTH1F);
HistogramFactoryImpl<TH1I> const hf1i(HistogramType::kTH1I);
HistogramFactoryImpl<TH2D> const hf2d(HistogramType::kTH2D);
HistogramFactoryImpl<TH2F> const hf2f(HistogramType::kTH2F);
HistogramFactoryImpl<TH2I> const hf2i(HistogramType::kTH2I);
HistogramFactoryImpl<TH3D> const hf3d(HistogramType::kTH3D);
HistogramFactoryImpl<TH3F> const hf3f(HistogramType::kTH3F);
HistogramFactoryImpl<TH3I> const hf3i(HistogramType::kTH3I);

/// Histogram registry for an analysis task that allows to define needed histograms
/// and serves as the container/wrapper to fill them
class HistogramRegistry
Expand Down Expand Up @@ -257,7 +148,7 @@ class HistogramRegistry
for (auto j = 0u; j < MAX_REGISTRY_SIZE; ++j) {
if (mRegistryValue[imask(j + i)].get() == nullptr) {
mRegistryKey[imask(j + i)] = spec.id;
mRegistryValue[imask(j + i)] = HistogramFactory::create(spec);
mRegistryValue[imask(j + i)] = {std::make_unique<TH1F>(spec.name.data(), spec.readableName.data(), spec.config.nBins, spec.config.xmin, spec.config.xmax)};
lookup += j;
return;
}
Expand Down
2 changes: 1 addition & 1 deletion Framework/Core/test/benchmark_HistogramRegistry.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ static void BM_HashedNameLookup(benchmark::State& state)
state.PauseTiming();
std::vector<HistogramSpec> specs;
for (auto i = 0; i < state.range(0); ++i) {
specs.push_back({fmt::format("histo{}", i + 1).c_str(), fmt::format("Histo {}", i + 1).c_str(), {HistogramType::kTH1F, {{100, 0, 1}}}});
specs.push_back({(boost::format("histo%1%") % (i + 1)).str().c_str(), (boost::format("Histo %1%") % (i + 1)).str().c_str(), {"TH1F", 100, 0, 1}});
}
HistogramRegistry registry{"registry", true, specs};
state.ResumeTiming();
Expand Down
6 changes: 2 additions & 4 deletions Framework/Core/test/test_HistogramRegistry.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,18 @@ using namespace o2::framework;

HistogramRegistry foo()
{
return {"r", true, {{"histo", "histo", {HistogramType::kTH1F, {{100, 0, 1}}}}}};
return {"r", true, {{"histo", "histo", {"TH1F", 100, 0, 1}}}};
}

BOOST_AUTO_TEST_CASE(HistogramRegistryLookup)
{
/// Construct a registry object with direct declaration
HistogramRegistry registry{"registry", true, {{"eta", "#Eta", {HistogramType::kTH1F, {{100, -2.0, 2.0}}}}, {"phi", "#Phi", {HistogramType::kTH1D, {{102, 0, 2 * M_PI}}}}, {"pt", "p_{T}", {HistogramType::kTH1D, {{1002, -0.01, 50.1}}}}, {"ptToPt", "#ptToPt", {HistogramType::kTH2F, {{100, -0.01, 10.01}, {100, -0.01, 10.01}}}}}};
HistogramRegistry registry{"registry", true, {{"eta", "#Eta", {"TH1F", 100, -2.0, 2.0}}, {"phi", "#Phi", {"TH1D", 102, 0, 2 * M_PI}}, {"pt", "p_{T}", {"TH1D", 1002, -0.01, 50.1}}}};

/// Get histograms by name
BOOST_REQUIRE_EQUAL(registry.get("eta")->GetNbinsX(), 100);
BOOST_REQUIRE_EQUAL(registry.get("phi")->GetNbinsX(), 102);
BOOST_REQUIRE_EQUAL(registry.get("pt")->GetNbinsX(), 1002);
BOOST_REQUIRE_EQUAL(registry.get("ptToPt")->GetNbinsX(), 100);
BOOST_REQUIRE_EQUAL(registry.get("ptToPt")->GetNbinsY(), 100);

/// Get a pointer to the histogram
auto histo = registry.get("pt").get();
Expand Down