DDTModularPlotFunctions.h

Go to the documentation of this file.

#ifndef DDTMODULARPLOTFUNCTIONS_H
#define DDTMODULARPLOTFUNCTIONS_H

// Set the number of triggers here.
// One day, this will be read in from elsewhere.  Today is not that day.
#ifndef NTRIGS
#define NTRIGS 30
#endif /* NTRIGS */

/*
      These functions perform useful things for each modular metric.

      They'll be heavily used by the forthcoming metric creation wizard.
*/

////////////////////////////////////////////////////////////////////////////////////
//                              FORMATTING PLOTS
////////////////////////////////////////////////////////////////////////////////////

// Configures the color of points, style of points, and title of a graph.
void configure_tgraph(TGraph *g, const Color_t color, const Style_t style, const char *title) {
    g->SetMarkerColor(color);
    g->SetMarkerStyle(style);
    g->SetTitle(title);
};

// Configures an axis to display the specified time range.
void configure_time_axis(TAxis *a, const int time_earlier, const int time_later, const char *time_format) {
    a->SetTimeDisplay(1);
    a->SetLabelSize(0.03);
    a->SetTimeFormat(time_format);
    a->SetLimits(time_earlier,time_later);
    a->SetTitle("(central time)");
};

// Configures a pad to use a transparent fill.
void transparent_pad(TPad *p) {
    p->SetFillStyle(4000);
    p->SetFillColor(0);
    p->SetFrameFillStyle(4000);
}

////////////////////////////////////////////////////////////////////////////////////
//                              MANIPULATING PLOTS
////////////////////////////////////////////////////////////////////////////////////

// Print the entire canvas to a png and delete the canvas.
void print_plot(TCanvas *c, const char *filename) {
     c->cd();
     c->Print(filename);
     delete c;
};



////////////////////////////////////////////////////////////////////////////////////
//                              MAKING PLOTS EXTRA FANCY
////////////////////////////////////////////////////////////////////////////////////

// Create good values text.
// Add a text box containing the good values range.
TPaveText *GoodValuesText(const double gv_low, const double gv_high) {
      TPaveText *GoodValues = new TPaveText(0.10,0.90,0.40,0.93,"NDC");
      GoodValues->SetLineColor(1);
      GoodValues->SetFillColor(0);
      GoodValues->SetBorderSize(1);
// Add the good values text.
      char gvtext[128];
      sprintf(gvtext,"Good Values: [%f, %f]", gv_low, gv_high);
      GoodValues->Clear();
      GoodValues->AddText(gvtext);
      return GoodValues;
};

////////////////////////////////

// Create last point and average text.
// Takes as arguments the graph containing the good values,
// the graph containing the outliers, and the trigger bit.
// 
// Note that, for now, this only works for 2D graphs.  I'll
// need to add in 3D functionality later.
// 
// There's an implicit assumption that the y-axis is the
// axis containing the more important part of the metric
// at hand.
TPaveText *LastPointText(const TGraph *g1, const TGraph *g2) {
      TPaveText *LastPoint = new TPaveText(0.50,0.90,0.90,0.93,"NDC");
      LastPoint->SetLineColor(1);
      LastPoint->SetFillColor(0);
      LastPoint->SetBorderSize(1);

// Check whether or not there are points in each graph.
      bool no_g1 = true;
      bool no_g2 = true;
      if (g1->GetN() > 0) { no_g1 = false; }
      if (g2->GetN() > 0) { no_g2 = false; }

// Get the last point, taking into consideration both graphs.
      double latest_Y;
      // If there are points in both graphs, compare their last x values.
      // Take the graph with the higher last x value and use the corresponding
      // y value as the latest point.
      if ( ! no_g1 && ! no_g2 ) {
            if (g1->GetX()[g1->GetN()-1] >= g2->GetX()[g2->GetN()-1]) {
                  latest_Y = g1->GetY()[g1->GetN()-1]; }
            else {
                  latest_Y = g2->GetY()[g2->GetN()-1]; } }
      // If there are only points in g1, take its last
      // y value as the latest point.
      else if ( ! no_g1 ) {
            latest_Y = g1->GetY()[g1->GetN()-1]; }
      // If there are only points in g2, take its last
      // y value as the latest point.
      else if ( ! no_g2 ) {
            latest_Y = g2->GetY()[g2->GetN()-1]; }
      // If there are somehow no points in either graph,
      // report the last point as 0.
      else {
            latest_Y = 0; }

      char lptext[128];
      sprintf(lptext,"Last Point = %f  /  Average (Good Values) = %f", latest_Y, g1->GetMean(2));
      LastPoint->Clear();
      LastPoint->AddText(lptext);
      return LastPoint;
};

////////////////////////////////

// Create update text.
// This tells the user when this plot was updated
// by both time and run/subrun.
TPaveText *UpdatedText(const int GMToffset, const unsigned int LastRun, const unsigned int LastSR) {
      TPaveText *Updated = new TPaveText(0.1, 0.0, 0.5, 0.05, "NDC");
      TDatime *Ttemp = new TDatime;  // finish time
      int Xfin = Ttemp->Convert() - GMToffset;
      TDatime *Tfinish = new TDatime(Xfin);  // finish time
      Updated->SetLineColor(0);
      Updated->SetFillColor(0);
      Updated->SetBorderSize(1);
      Updated->SetMargin(0.0);
      Updated->SetTextAlign(11);
      char buff1[256];
      sprintf(buff1, "Last updated on:    %s (central time)", Tfinish->AsString());
      Updated->AddText(buff1);
      char buff2[256];
      sprintf(buff2, "Last run / subrun:   %d / %d", LastRun, LastSR);
      Updated->AddText(buff2);
      return Updated;
};




#endif /* DDTMODULARPLOTFUNCTIONS_H */