Improve heatmap visualization

Author: nathanwbrei

src/examples/tutorial_with_lightweight_datamodel/04_ascii_heatmap_writer/AsciiHeatmap_writer.cc

@@ -4,6 +4,7 @@
 
 #include "AsciiHeatmap_writer.h"
 #include "CalorimeterHit.h"
+#include <string>
 
 AsciiHeatmap_writer::AsciiHeatmap_writer() {
     SetTypeName(NAME_OF_THIS); // Provide JANA with this class's name
@@ -15,33 +16,49 @@ AsciiHeatmap_writer::AsciiHeatmap_writer() {
 
 void AsciiHeatmap_writer::Init() {
     LOG_INFO(GetLogger()) << "AsciiHeatmap_writer::Init: Initializing heatmap";
+    m_heatmap.resize(m_cell_cols() * m_cell_rows());
+
+    if (*m_use_unicode) {
+        m_ramp = {" ", "░", "▒", "▓", "█"};
+        m_box_topleft = "┌";
+        m_box_topright = "┐";
+        m_box_bottomleft = "└";
+        m_box_bottomright = "┘";
+        m_box_vertical = "│";
+        m_box_horizontal = "─";
+    }
+    else {
+        m_ramp = {" ", ".", ":", "%", "#"};
+        m_box_topleft = "+";
+        m_box_topright = "+";
+        m_box_bottomleft = "+";
+        m_box_bottomright = "+";
+        m_box_vertical = "|";
+        m_box_horizontal = "-";
+    }
+}
 
-    m_heatmap = std::make_unique<double[]>(m_cell_cols() * m_cell_rows());
+void AsciiHeatmap_writer::ProcessSequential(const JEvent& event) {
+    LOG_INFO(GetLogger()) << "AsciiHeatmap_writer::Process, Event #" << event.GetEventNumber();
 
+    // Clear heatmap
     for (size_t i=0; i < m_cell_rows(); ++i) {
         for (size_t j=0; j < m_cell_cols(); ++j) {
             m_heatmap[i* m_cell_cols() + j] = 0;
         }
     }
-}
-
-void AsciiHeatmap_writer::ProcessSequential(const JEvent& event) {
-    LOG_INFO(GetLogger()) << "AsciiHeatmap_writer::Process, Event #" << event.GetEventNumber();
 
+    // Populate heatmap with sum of hit values
     for (const CalorimeterHit* hit : m_hits_in()) {
         if (hit->row < (int) m_cell_rows() && hit->col < (int) m_cell_cols()) {
-            m_heatmap[hit->row* m_cell_cols() + hit->col] = hit->energy;
+            m_heatmap[hit->row* m_cell_cols() + hit->col] += hit->energy;
         }
         else {
             LOG_WARN(GetLogger()) << "Hit at row=" << hit->row << ", col=" << hit->col << " does not fit on heatmap";
         }
     }
-}
-
-void AsciiHeatmap_writer::Finish() {
-    // Close any resources
-    LOG_INFO(GetLogger()) << "AsciiHeatmap_writer::Finish: Displaying heatmap";
 
+    // Find min and max values
     double min_value = m_heatmap[0];
     double max_value = m_heatmap[0];
 
@@ -53,27 +70,35 @@ void AsciiHeatmap_writer::Finish() {
         }
     }
 
-    std::cout << "  +";
+    // Show heatmap
+    std::cout << "Event: " << event.GetEventNumber() << std::endl;
+    std::cout << "  " << m_box_topleft;
     for (size_t j=0; j<m_cell_cols(); ++j) {
-        std::cout << "-";
+        std::cout << m_box_horizontal << m_box_horizontal;
     }
-    std::cout << "+" << std::endl;
+    std::cout << m_box_topright << std::endl;
+
 
-    char ramp[] = " .:#";
     for (size_t i=0; i<m_cell_rows(); ++i) {
-        std::cout << "  |";
+        std::cout << "  " << m_box_vertical;
         for (size_t j=0; j<m_cell_cols(); ++j) {
             double value = m_heatmap[i*m_cell_cols() + j];
-            int shade = (max_value == min_value) ? 0 : int((value - min_value)/(max_value - min_value) * 3);
-            std::cout << ramp[shade];
+            int shade = (max_value == min_value) ? 0 : int((value - min_value)/(max_value - min_value) * 4);
+            std::cout << m_ramp[shade] << m_ramp[shade]; // Double up so that cells look square
         }
-        std::cout << "|" << std::endl;
+        std::cout << m_box_vertical << std::endl;
     }
 
-    std::cout << "  +";
+    std::cout << "  " << m_box_bottomleft;
     for (size_t j=0; j<m_cell_cols(); ++j) {
-        std::cout << "-";
+        std::cout << m_box_horizontal << m_box_horizontal;
     }
-    std::cout << "+" << std::endl;
+    std::cout << m_box_bottomright << std::endl;
+
+}
+
+void AsciiHeatmap_writer::Finish() {
+    // Close any resources, write any files
+    LOG_INFO(GetLogger()) << "AsciiHeatmap_writer::Finish";
 }
 

src/examples/tutorial_with_lightweight_datamodel/04_ascii_heatmap_writer/AsciiHeatmap_writer.h

@@ -15,9 +15,19 @@ class AsciiHeatmap_writer : public JEventProcessor {
     // In a more realistic example, these would be obtained from the geometry interface
     Parameter<size_t> m_cell_cols {this, "cell_cols", 20, "Number of columns in the detector"};
     Parameter<size_t> m_cell_rows {this, "cell_rows", 10, "Number of rows in the detector"};
+    Parameter<bool> m_use_unicode {this, "use_unicode", true, "Use Unicode visualization vs plain ASCII"};
 
     // Declare the resource (or a handle to the resource) that is protected by this JEventProcessor
-    std::unique_ptr<double[]> m_heatmap;
+    std::vector<double> m_heatmap;
+
+    // Characters to print
+    std::vector<std::string> m_ramp;
+    std::string m_box_topleft;
+    std::string m_box_topright;
+    std::string m_box_bottomleft;
+    std::string m_box_bottomright;
+    std::string m_box_horizontal;
+    std::string m_box_vertical;
 
 public:
 

src/examples/tutorial_with_lightweight_datamodel/04_ascii_heatmap_writer/AsciiHeatmap_writer_legacy.cc

@@ -16,12 +16,25 @@ AsciiHeatmap_writer_legacy::AsciiHeatmap_writer_legacy() {
 void AsciiHeatmap_writer_legacy::Init() {
     LOG_INFO(GetLogger()) << "AsciiHeatmap_writer_legacy::Init: Initializing heatmap";
 
-    m_heatmap = std::make_unique<double[]>(m_cell_cols() * m_cell_rows());
-
-    for (size_t i=0; i < m_cell_rows(); ++i) {
-        for (size_t j=0; j < m_cell_cols(); ++j) {
-            m_heatmap[i* m_cell_cols() + j] = 0;
-        }
+    m_heatmap.resize(m_cell_cols() * m_cell_rows());
+
+    if (*m_use_unicode) {
+        m_ramp = {" ", "░", "▒", "▓", "█"};
+        m_box_topleft = "┌";
+        m_box_topright = "┐";
+        m_box_bottomleft = "└";
+        m_box_bottomright = "┘";
+        m_box_vertical = "│";
+        m_box_horizontal = "─";
+    }
+    else {
+        m_ramp = {" ", ".", ":", "%", "#"};
+        m_box_topleft = "+";
+        m_box_topright = "+";
+        m_box_bottomleft = "+";
+        m_box_bottomright = "+";
+        m_box_vertical = "|";
+        m_box_horizontal = "-";
     }
 }
 
@@ -37,20 +50,25 @@ void AsciiHeatmap_writer_legacy::Process(const std::shared_ptr<const JEvent>& ev
 
     /// Do the rest sequentially
     /// Now we are free to access shared state such as m_heatmap
+
+    // First we clear the heatmap buffer
+    for (size_t i=0; i < m_cell_rows(); ++i) {
+        for (size_t j=0; j < m_cell_cols(); ++j) {
+            m_heatmap[i* m_cell_cols() + j] = 0;
+        }
+    }
+
+    // Populate heatmap with sum of hit values
     for (const CalorimeterHit* hit : hits) {
         if (hit->row < (int) m_cell_rows() && hit->col < (int) m_cell_cols()) {
-            m_heatmap[hit->row* m_cell_cols() + hit->col] = hit->energy;
+            m_heatmap[hit->row* m_cell_cols() + hit->col] += hit->energy;
         }
         else {
             LOG_WARN(GetLogger()) << "Hit at row=" << hit->row << ", col=" << hit->col << " does not fit on heatmap";
         }
     }
-}
-
-void AsciiHeatmap_writer_legacy::Finish() {
-    // Close any resources
-    LOG_INFO(GetLogger()) << "AsciiHeatmap_writer_legacy::Finish: Displaying heatmap";
 
+    // Find min and max values
     double min_value = m_heatmap[0];
     double max_value = m_heatmap[0];
 
@@ -62,27 +80,35 @@ void AsciiHeatmap_writer_legacy::Finish() {
         }
     }
 
-    std::cout << "  +";
+    // Show heatmap
+    std::cout << "Event: " << event->GetEventNumber() << std::endl;
+    std::cout << "  " << m_box_topleft;
     for (size_t j=0; j<m_cell_cols(); ++j) {
-        std::cout << "-";
+        std::cout << m_box_horizontal << m_box_horizontal;
     }
-    std::cout << "+" << std::endl;
+    std::cout << m_box_topright << std::endl;
+
 
-    char ramp[] = " .:#";
     for (size_t i=0; i<m_cell_rows(); ++i) {
-        std::cout << "  |";
+        std::cout << "  " << m_box_vertical;
         for (size_t j=0; j<m_cell_cols(); ++j) {
             double value = m_heatmap[i*m_cell_cols() + j];
-            int shade = (max_value == min_value) ? 0 : int((value - min_value)/(max_value - min_value) * 3);
-            std::cout << ramp[shade];
+            int shade = (max_value == min_value) ? 0 : int((value - min_value)/(max_value - min_value) * 4);
+            std::cout << m_ramp[shade] << m_ramp[shade]; // Double up so that cells look square
         }
-        std::cout << "|" << std::endl;
+        std::cout << m_box_vertical << std::endl;
     }
 
-    std::cout << "  +";
+    std::cout << "  " << m_box_bottomleft;
     for (size_t j=0; j<m_cell_cols(); ++j) {
-        std::cout << "-";
+        std::cout << m_box_horizontal << m_box_horizontal;
     }
-    std::cout << "+" << std::endl;
+    std::cout << m_box_bottomright << std::endl;
+}
+
+void AsciiHeatmap_writer_legacy::Finish() {
+    // Close any resources
+    LOG_INFO(GetLogger()) << "AsciiHeatmap_writer_legacy::Finish: Displaying heatmap";
+
 }
 

src/examples/tutorial_with_lightweight_datamodel/04_ascii_heatmap_writer/AsciiHeatmap_writer_legacy.h

@@ -11,8 +11,17 @@ class AsciiHeatmap_writer_legacy : public JEventProcessor {
 
     Parameter<size_t> m_cell_cols {this, "cell_cols", 20, "Number of columns in the detector"};
     Parameter<size_t> m_cell_rows {this, "cell_rows", 10, "Number of rows in the detector"};
+    Parameter<bool> m_use_unicode {this, "use_unicode", true, "Use Unicode visualization vs plain ASCII"};
 
-    std::unique_ptr<double[]> m_heatmap;
+    std::vector<double> m_heatmap;
+
+    std::vector<std::string> m_ramp;
+    std::string m_box_topleft;
+    std::string m_box_topright;
+    std::string m_box_bottomleft;
+    std::string m_box_bottomright;
+    std::string m_box_horizontal;
+    std::string m_box_vertical;
 
 public: