From 778963c78758e6016421ccbf1d614e6d6db06e6b Mon Sep 17 00:00:00 2001
From: Maximilian Reininghaus <maximilian.reininghaus@kit.edu>
Date: Mon, 28 Sep 2020 20:09:20 +0200
Subject: [PATCH] basic documentation
---
Framework/Utilities/SaveBoostHistogram.hpp | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Framework/Utilities/SaveBoostHistogram.hpp b/Framework/Utilities/SaveBoostHistogram.hpp
index 94b5f1bd5..7a11527d3 100644
--- a/Framework/Utilities/SaveBoostHistogram.hpp
+++ b/Framework/Utilities/SaveBoostHistogram.hpp
@@ -11,6 +11,14 @@
namespace corsika {
namespace utl {
+ /**
+ * This functions saves a boost::histogram into a numpy file. Only rather basic axis
+ * types are supported: regular, variable, integer, category<int>. Only "ordinary" bin
+ * counts (i.e. a double or int) are supported, nothing fancy like profiles.
+ *
+ * Note that this function makes a temporary, dense copy of the histogram, which could
+ * be an issue for huge sizes (e.g. for high dimensions)
+ */
template <typename hist_type>
void save_hist(hist_type const& h, std::string const& filename) {
auto const rank = h.rank();
--
GitLab