[ntuplebrowse] Add CreateTreeMapFromRNTuple

Author: magnustymoteus

gui/treemap/CMakeLists.txt

@@ -15,11 +15,8 @@ ROOT_STANDARD_LIBRARY_PACKAGE(ROOTTreeMap
     ROOT/RTreeMapPainter.hxx
   SOURCES
     RTreeMapBase.cxx
-    RTreeMapImporter.cxx
     RTreeMapPainter.cxx
   DEPENDENCIES
-    ROOTNTuple
-    ROOTNTupleUtil
     Gpad
     RIO
 )

gui/treemap/inc/ROOT/RTreeMapPainter.hxx

@@ -26,8 +26,6 @@
 #include <vector>
 
 namespace ROOT::Experimental {
-class RNTupleInspector;
-
 // clang-format off
 /**
 \class ROOT::Experimental::RTreeMapPainter
@@ -36,22 +34,14 @@ class RNTupleInspector;
 
 One can visualize an RNTuple in a TCanvas as a treemap like this:
 ~~~ {.cpp}
-auto tm = RTreeMapPainter::ImportRNTuple("file.root", "ntuple_name");
+auto tm = ROOT::Experimental::CreateTreeMapFromRNTuple("file.root", "ntuple_name");
 auto c = new TCanvas("c_tm","TreeMap");
 c->Add(tm.release());
 ~~~
 */
 // clang-format on
 class RTreeMapPainter final : public ROOT::Experimental::RTreeMapBase, public TObject {
 public:
-   /////////////////////////////////////////////////////////////////////////////
-   /// \brief Logic for converting an RNTuple to RTreeMapPainter given RNTupleInspector
-   static std::unique_ptr<RTreeMapPainter> ImportRNTuple(const ROOT::Experimental::RNTupleInspector &insp);
-
-   /////////////////////////////////////////////////////////////////////////////
-   /// \brief Logic for converting an RNTuple to RTreeMapPainter given file and tuple names
-   static std::unique_ptr<RTreeMapPainter> ImportRNTuple(std::string_view sourceFileName, std::string_view tupleName);
-
    struct Node final : public ROOT::Experimental::RTreeMapBase::Node, public TObject {
    public:
       ClassDefOverride(Node, 1);
@@ -74,4 +64,4 @@ private:
                 bool alignCenter = false) const final;
 };
 } // namespace ROOT::Experimental
-#endif
+#endif

tree/ntuplebrowse/CMakeLists.txt

@@ -14,10 +14,12 @@ HEADERS
   ROOT/RNTupleBrowseUtils.hxx
   ROOT/RNTupleClassicBrowse.hxx
   ROOT/RNTupleDrawVisitor.hxx
+  ROOT/RNTupleTreeMap.hxx
 SOURCES
   src/RNTupleBrowseUtils.cxx
   src/RNTupleClassicBrowse.cxx
   src/RNTupleDrawVisitor.cxx
+  src/RNTupleTreeMap.cxx
 LINKDEF
   LinkDef.h
 DEPENDENCIES
@@ -26,6 +28,7 @@ DEPENDENCIES
   Graf
   Hist
   ROOTNTuple
+  ROOTNTupleUtil
   ROOTTreeMap
 )
 

tree/ntuplebrowse/inc/ROOT/RNTupleTreeMap.hxx

@@ -0,0 +1,38 @@
+/// \file ROOT/RNTupleTreeMap.hxx
+/// \ingroup NTuple
+/// \author Patryk Tymoteusz Pilichowski <[email protected]>
+/// \date 2025-09-15
+/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
+/// is welcome!
+
+/*************************************************************************
+ * Copyright (C) 1995-2025, Rene Brun and Fons Rademakers.               *
+ * All rights reserved.                                                  *
+ *                                                                       *
+ * For the licensing terms see $ROOTSYS/LICENSE.                         *
+ * For the list of contributors see $ROOTSYS/README/CREDITS.             *
+ *************************************************************************/
+
+#ifndef ROOT_RNTupleTreeMap
+#define ROOT_RNTupleTreeMap
+
+#include <ROOT/RNTupleInspector.hxx>
+#include <ROOT/RTreeMapPainter.hxx>
+
+#include <memory>
+#include <string>
+
+namespace ROOT {
+namespace Experimental {
+/////////////////////////////////////////////////////////////////////////////
+/// \brief Logic for converting an RNTuple to RTreeMapPainter given RNTupleInspector
+std::unique_ptr<RTreeMapPainter> CreateTreeMapFromRNTuple(const RNTupleInspector &insp);
+
+/////////////////////////////////////////////////////////////////////////////
+/// \brief Logic for converting an RNTuple to RTreeMapPainter given file and tuple names
+std::unique_ptr<RTreeMapPainter> CreateTreeMapFromRNTuple(std::string_view sourceFileName, std::string_view tupleName);
+} // namespace Experimental
+
+} // namespace ROOT
+
+#endif

tree/ntuplebrowse/src/RNTupleClassicBrowse.cxx

@@ -17,17 +17,13 @@
 #include <ROOT/RNTupleDrawVisitor.hxx>
 #include <ROOT/RNTupleDescriptor.hxx>
 #include <ROOT/RNTupleReader.hxx>
-#include <ROOT/RTreeMapPainter.hxx>
-#include <ROOT/RNTupleInspector.hxx>
+#include <ROOT/RNTupleTreeMap.hxx>
 
 #include <TBrowser.h>
 #include <TObject.h>
 #include <TPad.h>
 #include <TText.h>
 
-#include <memory>
-#include <string>
-
 namespace {
 
 class RFieldBrowsable final : public TObject {
@@ -108,7 +104,7 @@ class RVisualizationBrowsable : public TObject {
       if (!b || !gPad)
          return;
       gPad->GetListOfPrimitives()->Clear();
-      fTreeMap = ROOT::Experimental::RTreeMapPainter::ImportRNTuple(*fInspector);
+      fTreeMap = ROOT::Experimental::CreateTreeMapFromRNTuple(*fInspector);
       fTreeMap->Paint("");
       gPad->Update();
    }

gui/treemap/src/RTreeMapImporter.cxx renamed to tree/ntuplebrowse/src/RNTupleTreeMap.cxx

@@ -1,7 +1,7 @@
-/// \file RTreeMapImporter.cxx
-/// \ingroup TreeMap ROOT7
+/// \file ROOT/RNTupleTreeMap.cxx
+/// \ingroup NTuple
 /// \author Patryk Tymoteusz Pilichowski <[email protected]>
-/// \date 2025-08-21
+/// \date 2025-09-15
 /// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
 /// is welcome!
 
@@ -13,32 +13,31 @@
  * For the list of contributors see $ROOTSYS/README/CREDITS.             *
  *************************************************************************/
 
-#include <ROOT/RTreeMapPainter.hxx>
-#include <ROOT/RNTupleInspector.hxx>
+#include <ROOT/RNTupleTreeMap.hxx>
 #include <ROOT/RColumnElementBase.hxx>
 
 #include <queue>
 
-using namespace ROOT::Experimental;
-
-static RTreeMapBase::Node CreateNode(const RNTupleInspector &insp, const ROOT::RFieldDescriptor &fldDesc,
-                                     std::uint64_t childrenIdx, std::uint64_t nChildren, ROOT::DescriptorId_t rootId,
-                                     size_t rootSize)
+static ROOT::Experimental::RTreeMapBase::Node
+CreateNode(const ROOT::Experimental::RNTupleInspector &insp, const ROOT::RFieldDescriptor &fldDesc,
+           std::uint64_t childrenIdx, std::uint64_t nChildren, ROOT::DescriptorId_t rootId, size_t rootSize)
 {
    uint64_t size =
       (rootId != fldDesc.GetId()) ? insp.GetFieldTreeInspector(fldDesc.GetId()).GetCompressedSize() : rootSize;
    return {fldDesc.GetFieldName(), "", size, childrenIdx, nChildren};
 }
 
-static RTreeMapBase::Node CreateNode(const RNTupleInspector::RColumnInspector &colInsp, std::uint64_t childrenIdx)
+static ROOT::Experimental::RTreeMapBase::Node
+CreateNode(const ROOT::Experimental::RNTupleInspector::RColumnInspector &colInsp, std::uint64_t childrenIdx)
 {
    return {"", ROOT::Internal::RColumnElementBase::GetColumnTypeName(colInsp.GetType()), colInsp.GetCompressedSize(),
            childrenIdx, 0};
 }
 
-std::unique_ptr<RTreeMapPainter> RTreeMapPainter::ImportRNTuple(const ROOT::Experimental::RNTupleInspector &insp)
+std::unique_ptr<ROOT::Experimental::RTreeMapPainter>
+ROOT::Experimental::CreateTreeMapFromRNTuple(const ROOT::Experimental::RNTupleInspector &insp)
 {
-   auto treemap = std::make_unique<RTreeMapPainter>();
+   auto treemap = std::make_unique<ROOT::Experimental::RTreeMapPainter>();
    const auto &descriptor = insp.GetDescriptor();
    const auto rootId = descriptor.GetFieldZero().GetId();
    size_t rootSize = 0;
@@ -83,8 +82,9 @@ std::unique_ptr<RTreeMapPainter> RTreeMapPainter::ImportRNTuple(const ROOT::Expe
    return treemap;
 }
 
-std::unique_ptr<RTreeMapPainter> RTreeMapPainter::ImportRNTuple(std::string_view sourceFileName, std::string_view tupleName)
+std::unique_ptr<ROOT::Experimental::RTreeMapPainter>
+ROOT::Experimental::CreateTreeMapFromRNTuple(std::string_view sourceFileName, std::string_view tupleName)
 {
-   auto insp = RNTupleInspector::Create(tupleName, sourceFileName);
-   return RTreeMapPainter::ImportRNTuple(*insp);
-}
+   auto insp = ROOT::Experimental::RNTupleInspector::Create(tupleName, sourceFileName);
+   return CreateTreeMapFromRNTuple(*insp);
+}