Merge branch 'master' of gitlab.engr.illinois.edu:rlongo/JZCaPA

Made significant modifications to doxygen comments

Analysis/include/Visualizer.h

+/** @file Visualizer.h
+ *  @brief Class to have a simple visualization of plots through JZCaPA. If you want to plot something, just define here a child method and use it recursively, w/o filling the code with canvases et al. 
+ *
+ *  @author Riccardo Longo
+ *  @bug No known bugs.
+ */
+
+#ifndef VISUALIZER_H
+#define VISUALIZER_H
+
+#include "TH1.h"
+#include "TStyle.h"
+
+#include <iostream>
+#include <vector>
+
+class Visualizer {
+
+    public :
+    Visualizer();
+    Visualizer( std::string _style );
+
+    //Styles (so fa only ATLAS)
+    TStyle* AtlasStyle();
+    //Methods to set a given style
+    void SetAtlasStyle();
+
+    /** @brief allow the user to define the extension of the plots once they're printed. ".pdf" by default */
+    void SetPlotExtension( std::string _extension ) { m_extension = _extension; }
+
+    /** @brief make the argument true to activate the debug mode. False to deactivate it*/
+    void   SetDebugMode   ( bool _isDebugon ) { m_debug = _isDebugon; }
+
+    //Special plot treatments
+    void   OverlayHistos  ( TH1 *h1, TH1 *h2 , TVirtualPad* pad);
+
+    //Main visualization methods
+    void   ManyPadsPlot   ( std::vector< TH1* > _first_form, std::vector< TH1* > _second_form, int _ncol, int _nrow, std::string _out_name, std::string _treatment );
+
+
+    private :
+    /** String identifying the style to be applied */
+    std::string m_style;
+    /** Debug flag */
+    bool m_debug = false;
+    /** String defining the extension used to print the plots */
+    std::string m_extension = ".pdf";
+};
+
+#endif

Analysis/src/DataReader.cpp

@@ -23,6 +23,7 @@
 #include "Containers.h"
 #include "RPD.h"
 #include "ZDC.h"
+#include "Visualizer.h"
 
 /** @brief Default Constructor for DataReader.
  */
@@ -306,6 +307,12 @@ void DataReader::ProcessEvents(){
   TPad *pad = new TPad("pad", "pad",0.15,0.11,0.85,0.79);
   canvas->Divide(4,2);
   
+  std::string style = "ATLAS";
+  //Visualizer vis;
+  std::vector< TH1* > raw;
+  std::vector< TH1* > diff;
+  
+  
   // Processed Raw data to read in as vector of vectors size NxM
   // Where N = nCh and M = nSamples per channel.
   std::vector< std::vector< float >  >  vWF;
@@ -381,6 +388,11 @@ void DataReader::ProcessEvents(){
         //ana->AnalyzeEvent( zdc1->GetChannelsVector(), canvas->cd() );
         //ana->AnalyzeEvent( zdc2->GetChannelsVector(), canvas->cd() );
         ana->AnalyzeEvent( rpd->GetChannelsVector() , canvas->cd() );
+        for(int test = 0; test<16; test ++){
+          raw.push_back( rpd->GetChannelsVector().at(test)->WF_histo);
+          diff.push_back( rpd->GetChannelsVector().at(test)->FirstDerivative);
+        }
+        //vis.ManyPadsPlot(raw,diff,4,4,Form("Event %d" ,ev),"Overlay");
       }else{
       ana->AnalyzeEvent( zdc1->GetChannelsVector() );
       ana->AnalyzeEvent( zdc2->GetChannelsVector() );

Analysis/src/Visualizer.cpp

+/** @file Visualizer.cpp
+ *  @brief Implementation of Visualizer class.
+ *
+ *
+ *  @author Riccardo Longo
+ *  @bug No known bugs.
+ */
+
+#include <TH1.h>
+#include <TH2.h>
+#include <TROOT.h>
+#include <TAxis.h>
+#include <TGaxis.h>
+#include <TPad.h>
+#include <TCanvas.h>
+
+#include <iostream>
+
+#include "Visualizer.h"
+
+/** @brief Visualizer Constructor for Visualizer.
+ */
+Visualizer::Visualizer( ){
+
+}
+
+Visualizer::Visualizer( std::string _style ){
+    m_style = _style;
+    if(m_style == "ATLAS" || m_style == "atlas") Visualizer::SetAtlasStyle();
+}
+
+/**
+ * @brief Function inherited from rcdaq. Creates the ATLAS TStyle object
+ * @return
+ */
+TStyle* Visualizer::AtlasStyle(){
+    TStyle *atlasStyle = new TStyle("ATLAS","Atlas style");
+
+      // use plain black on white colors
+      Int_t icol=0; // WHITE
+      atlasStyle->SetFrameBorderMode(icol);
+      atlasStyle->SetFrameFillColor(icol);
+      atlasStyle->SetCanvasBorderMode(icol);
+      atlasStyle->SetCanvasColor(icol);
+      atlasStyle->SetPadBorderMode(icol);
+      atlasStyle->SetPadColor(icol);
+      atlasStyle->SetStatColor(icol);
+      //atlasStyle->SetFillColor(icol); // don't use: white fill color for *all* objects
+
+      // set the paper & margin sizes
+      atlasStyle->SetPaperSize(20,26);
+
+      // set margin sizes
+      atlasStyle->SetPadTopMargin(0.05);
+      atlasStyle->SetPadRightMargin(0.05);
+      atlasStyle->SetPadBottomMargin(0.16);
+      atlasStyle->SetPadLeftMargin(0.16);
+
+      // set title offsets (for axis label)
+      atlasStyle->SetTitleXOffset(1.4);
+      atlasStyle->SetTitleYOffset(1.4);
+
+      // use large fonts
+      //Int_t font=72; // Helvetica italics
+      Int_t font=42; // Helvetica
+      Double_t tsize=0.05;
+      atlasStyle->SetTextFont(font);
+
+      atlasStyle->SetTextSize(tsize);
+      atlasStyle->SetLabelFont(font,"x");
+      atlasStyle->SetTitleFont(font,"x");
+      atlasStyle->SetLabelFont(font,"y");
+      atlasStyle->SetTitleFont(font,"y");
+      atlasStyle->SetLabelFont(font,"z");
+      atlasStyle->SetTitleFont(font,"z");
+
+      atlasStyle->SetLabelSize(tsize,"x");
+      atlasStyle->SetTitleSize(tsize,"x");
+      atlasStyle->SetLabelSize(tsize,"y");
+      atlasStyle->SetTitleSize(tsize,"y");
+      atlasStyle->SetLabelSize(tsize,"z");
+      atlasStyle->SetTitleSize(tsize,"z");
+
+      // use bold lines and markers
+      atlasStyle->SetMarkerStyle(20);
+      atlasStyle->SetMarkerSize(1.2);
+      atlasStyle->SetHistLineWidth(2.);
+      atlasStyle->SetLineStyleString(2,"[12 12]"); // postscript dashes
+
+      // get rid of X error bars
+      //atlasStyle->SetErrorX(0.001);
+      // get rid of error bar caps
+      atlasStyle->SetEndErrorSize(0.);
+
+      // do not display any of the standard histogram decorations
+      atlasStyle->SetOptTitle(0);
+      //atlasStyle->SetOptStat(1111);
+      atlasStyle->SetOptStat(0);
+      //atlasStyle->SetOptFit(1111);
+      atlasStyle->SetOptFit(0);
+
+      // put tick marks on top and RHS of plots
+      atlasStyle->SetPadTickX(1);
+      atlasStyle->SetPadTickY(1);
+
+      return atlasStyle;
+
+}
+
+/**
+ * @brief Function inherited from rcdaq. Set the ATLAS style.
+ */
+void Visualizer::SetAtlasStyle(){
+
+    static TStyle* atlasStyle = 0;
+    std::cout << "\nApplying ATLAS style settings...\n" << std::endl ;
+    if ( atlasStyle==0 ) atlasStyle = AtlasStyle();
+    gROOT->SetStyle("ATLAS");
+    gROOT->ForceStyle();
+
+}
+
+
+/** @brief OverlayHistos method for Visualizer
+ *
+ *  Plots two input histograms on the same, specified pad with
+ *  separate axis. Saves the plots as PDFs with the name of the
+ *  base histogram if given the option.
+ *
+ *  @param1 Base histogram (left y-axis)
+ *  @param2 Overlayed histogram (right y-axis)
+ *  @param3 Address of a pad (TPad or TCanvas) to be drawn on
+ *  @param4 Save option. If true, save a .pdf
+ */
+void Visualizer::OverlayHistos( TH1 *h1, TH1 *h2 , TVirtualPad* pad){
+
+    // If there is no pad or no data in the histograms, return
+    if( pad == nullptr ) {std::cerr<< "WARNING: No pad to overlay histos onto" << std::endl; return;}
+    if( !h1->GetMinimum() && !h1->GetMaximum()) {std::cerr << "WARNING: "<< h1->GetTitle() << " is empty. Can't overlay" << std::endl; return;}
+
+    //Remove Stat box and double the y-axis range to include negative values
+    gStyle->SetOptStat( kFALSE );
+    h1->Draw();
+    h1->SetAxisRange( -h1->GetMaximum()*1.1, h1->GetMaximum()*1.1, "Y");
+    pad->Update();
+
+   //scale h2 to the pad coordinates
+   float rightmax = 1.1*h2->GetMaximum();
+   float scale = gPad->GetUymax()/rightmax;
+   h2->SetLineColor( kRed );
+   h2->Scale( scale );
+   h2->DrawCopy( "same" );
+
+   //draw an axis on the right side
+   TGaxis axis( gPad->GetUxmax(), gPad->GetUymin(), gPad->GetUxmax(), gPad->GetUymax(), -rightmax, rightmax, 510, "+L");
+   axis.SetLineColor( kRed );
+   axis.SetLabelColor( kRed );
+   axis.DrawClone();
+
+   //Rescale h2 back to the original size
+   h2->Scale( 1/scale );
+   if( m_debug ) pad->Print( Form( "%s_Overlay.pdf", h1->GetTitle() ) ) ;
+}
+
+/**
+ * @brief Implementation of Visualizer::ManyPadsPlot. This method takes two vector of histograms that needs to be treated in a peculiar way and
+ * takes care of plot those together in a canvas with a given number of columns and rows.
+ * @param _first_form - vector of the first type of histograms to be plotted
+ * @param _second_form - vector of the second type of histograms to be plotted s
+ * @param _ncol - number of columns of the canvas
+ * @param _nrow - number of rows of the canvas
+ * @param _out_name - name of the plot (w/o extension, that's defined by a data member [ .pdf by default ]
+ * @param _treatment - treatment of the plots (at the moment only one available, overlay)
+ */
+void Visualizer::ManyPadsPlot( std::vector< TH1* > _first_form, std::vector< TH1* > _second_form, int _ncol, int _nrow, std::string _out_name, std::string _treatment){
+
+    if(_treatment != "overlay" && _treatment != "OVERLAY" && _treatment != "Overlay"){
+        std::cerr << "WARNING!!! You're looking for a treatment that has not been implemented yet! Please check it carefully" << std::endl;
+        std::cerr << "Exiting w/o doing anything .." << std::endl;
+        return;
+    }
+
+    if(_first_form.size() != _second_form.size())
+        std::cerr << "WARNING!!! The two vectors of histograms "
+                     "have different size. May result in a crash..." << std::endl;
+
+    if( _first_form.size() < _ncol*_nrow ||  _second_form.size() < _ncol*_nrow )
+        std::cerr << "WARNING!!! You have selected a vector of histrograms that will not fill all your pads"
+                     "This may result in a crash..." << std::endl;
+
+    if( _first_form.size() > _ncol*_nrow ||  _second_form.size() > _ncol*_nrow )
+        std::cerr << "WARNING!!! You have selected a vector of histrograms that is bigger than the number of requested pads"
+                     "This may result in histograms lost w/o plotting..." << std::endl;
+
+    //This for the moment is hardcoded. Maybe can be moved to data member to have more general usage also for single plots.
+    int squared_pad_size = 300;
+    TCanvas* canv = new TCanvas( _out_name.c_str(),_out_name.c_str(),
+                                 squared_pad_size*_ncol, squared_pad_size*_nrow);
+    canv->Divide(_ncol,_nrow);
+    for( int idraw = 0; idraw < _first_form.size(); idraw++){
+        canv->cd(idraw+1);
+        if( _treatment == "overlay" || _treatment != "OVERLAY" || _treatment != "Overlay" ){
+            OverlayHistos( _first_form.at(idraw), _second_form.at(idraw), gPad);
+        }
+    }
+    canv->Print(( _out_name + m_extension ).c_str());
+
+}
+