TGo4PolyCond.cxx

Go to the documentation of this file.

// $Id$
//-----------------------------------------------------------------------
//       The GSI Online Offline Object Oriented (Go4) Project
//         Experiment Data Processing at EE department, GSI
//-----------------------------------------------------------------------
// Copyright (C) 2000- GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
//                     Planckstr. 1, 64291 Darmstadt, Germany
// Contact:            http://go4.gsi.de
//-----------------------------------------------------------------------
// This software can be used under the license agreements as stated
// in Go4License.txt file which is part of the distribution.
//-----------------------------------------------------------------------

#include "TGo4PolyCond.h"

#include "TMath.h"
#include "TROOT.h"
#include "TH2.h"
#include "TList.h"
#include "TCutG.h"

#include "TGo4PolyCondPainter.h"
#include "TGo4Log.h"

//#define POLYCOND_UPDATE_WITHCLONE 1


TString TGo4PolyCond::fgxURL_NPOINTS="npolygon";
TString TGo4PolyCond::fgxURL_XPRE="x";
TString TGo4PolyCond::fgxURL_YPRE="y";

TString TGo4PolyCond::NextAvailableName()
{
   TString res;
   Int_t cnt = 0;
   do {
      res.Form("CutG_%d",cnt++);
   } while (gROOT->GetListOfSpecials()->FindObject(res));
   return res;
}

// ----------------------------------------------------------
TGo4PolyCond::TGo4PolyCond() :
   TGo4Condition(),
   fxCut(nullptr),
   fxCutHis(nullptr)
{
   SetDimension(2);
   //SetBit(kCanDelete, kFALSE);
}
// ----------------------------------------------------------
TGo4PolyCond::TGo4PolyCond(const char *name, const char *title) :
   TGo4Condition(name,title),
   fxCut(nullptr),
   fxCutHis(nullptr)
{
   SetDimension(2);
   //SetBit(kCanDelete, kFALSE);
}
// ----------------------------------------------------------
TGo4PolyCond::~TGo4PolyCond()
{
   // UnDraw(); // JAM 2016 - do it before cut has vanished!

   ClearCutHis();

   if (fxCut) {
      delete fxCut;
      fxCut = nullptr; // JAM2016: reset for Unpaint in PolyCondView?
   }
}

// ----------------------------------------------------------
void TGo4PolyCond::SetWorkHistogram(TH1 *histo)
{
   TGo4Condition::SetWorkHistogram(histo);
   ClearCutHis(); // discard internal cut histogram
}

// ----------------------------------------------------------
void TGo4PolyCond::ClearCutHis()
{
   if (fxCutHis) {
      delete fxCutHis;
      fxCutHis = nullptr;
   }
}

// ----------------------------------------------------------
Double_t TGo4PolyCond::GetXLow() const
{
   if(!fxCut) return 0.;
   Int_t n = fxCut->GetN();
   auto xarr = fxCut->GetX();
   fxCut->SetBit(kMustCleanup,0);
   Int_t nxmin = TMath::LocMin(n,xarr);
   return xarr[nxmin];
}

Double_t TGo4PolyCond::GetXUp() const
{
   if(!fxCut) return 0.;
   Int_t n=fxCut->GetN();
   auto xarr=fxCut->GetX();
   Int_t nxmax=TMath::LocMax(n,xarr);
   return xarr[nxmax];
}

Double_t TGo4PolyCond::GetYLow() const
{
   if(!fxCut) return 0;
   Int_t n=fxCut->GetN();
   auto yarr=fxCut->GetY();
   Int_t nymin=TMath::LocMin(n,yarr);
   return yarr[nymin];
}

Double_t TGo4PolyCond::GetYUp() const
{
   if(!fxCut) return 0.;
   Int_t n = fxCut->GetN();
   auto yarr = fxCut->GetY();
   Int_t nymax = TMath::LocMax(n,yarr);
   return yarr[nymax];
}

Bool_t TGo4PolyCond::IsPolygonType() const
{
   return kTRUE;
}

// ----------------------------------------------------------
TCutG *TGo4PolyCond::GetCut(Bool_t changeowner)
{
   TCutG *tempcut = fxCut;

   if(changeowner) {
      fxCut = nullptr;
      ClearCutHis(); // discard internal histogram
   }
   return tempcut;
}

// ----------------------------------------------------------
TCutG *TGo4PolyCond::CloneCut(TGo4PolyCond *source)
{
  TCutG *tempcut = source->GetCut(false); // get fxCut pointer
  if(tempcut) {
    CleanupSpecials(); // JAM2016: Clone might delete cut of same name from list of specials, remove it first
    TCutG *ret= (TCutG *)tempcut->Clone(GetName());
    CleanupSpecials();
    return ret;
  }

  return nullptr;
}
// ----------------------------------------------------------
void TGo4PolyCond::SetValues(TCutG *newcut)
{
   if(!newcut) return;
#ifdef POLYCOND_UPDATE_WITHCLONE
   if(fxCut) delete fxCut;
   CleanupSpecials(); // JAM2016: Clone might delete cut of same name from list of specials, remove it first
   //fxCut = (TCutG*) newcut->Clone(NextAvailableName());
   fxCut = (TCutG*) newcut->Clone(GetName());
   fxCut->SetBit(kCanDelete,kFALSE);
   CleanupSpecials();
#else
   Int_t pn = newcut->GetN();
   if(!fxCut) {
     fxCut = new TCutG(GetName(),pn);
     fxCut->SetBit(kMustCleanup);
     TGo4PolyCond::CleanupSpecials(); // JAM2016
   }
   else
   {
     fxCut->Set(pn);
   }
   Double_t xp = 0, yp = 0;
   for (Int_t i = 0; i < pn; ++i) {
      newcut->GetPoint(i, xp, yp);
      fxCut->SetPoint(i, xp, yp);
   }


#endif
   // when updated from view, we store graphical attributes:
   SetLineColor(newcut->GetLineColor());
   SetLineWidth(newcut->GetLineWidth());
   SetLineStyle(newcut->GetLineStyle());
   SetFillColor(newcut->GetFillColor());
   SetFillStyle(newcut->GetFillStyle());

   ClearCutHis(); // fxCut changed, so discard previous fxCut histogram
}
 // ----------------------------------------------------------
void TGo4PolyCond::SetValuesDirect(TCutG * newcut)
{
   if(!newcut) return;
   if(fxCut && fxCut!=newcut) delete fxCut;

   fxCut = newcut;
   //fxCut->SetName(NextAvailableName()); // JAM2016
   fxCut->SetName(GetName());

   // when updated from view, we store graphical attributes:
   SetLineColor(newcut->GetLineColor());
   SetLineWidth(newcut->GetLineWidth());
   SetLineStyle(newcut->GetLineStyle());
   SetFillColor(newcut->GetFillColor());
   SetFillStyle(newcut->GetFillStyle());

   ClearCutHis(); // fxCut changed, so discard previous fxCut histogram
}

// ----------------------------------------------------------
void TGo4PolyCond::SetValues(Double_t * x, Double_t * y, Int_t len)
{
   if(fxCut) delete fxCut;
   TGo4PolyCond::CleanupSpecials(); // JAM2016
   //fxCut = new TCutG(NextAvailableName(), len, x, y);
   fxCut = new TCutG(GetName(), len, x, y);
   fxCut->SetBit(kMustCleanup);
   //fxCut->SetBit(kCanDelete,kFALSE);
   TGo4PolyCond::CleanupSpecials(); // JAM2016

   ClearCutHis(); // discard previous fxCut histogram
}

// ----------------------------------------------------------
Bool_t TGo4PolyCond::Test(Double_t x, Double_t y)
{
   IncCounts();
   if(!IsEnabled() || !fxCut){
      if(FixedResult()) IncTrueCounts();
      return FixedResult();
   }
   Bool_t outside = (fxCut->IsInside(x,y) == 0);
   if(outside) return IsFalse();
   IncTrueCounts();
   return IsTrue();
}

// ----------------------------------------------------------
void TGo4PolyCond::PrintCondition(Bool_t points)
{
   TGo4Condition::PrintCondition();
   if(points) {
      if(!fxCut)
         std::cout << "No polygon specified!" << std::endl;
      else
         fxCut->Print(nullptr);
   }
}

// -----------------------------------------------
// PrintBar switch is handled in condition baseclass now.
//void TGo4PolyCond::Print(Option_t *opt) const{
//   TGo4PolyCond *const localthis= const_cast<TGo4PolyCond *const>(this);
//   localthis->PrintBar();
//}
// ----------------------------------------------------------
Bool_t TGo4PolyCond::UpdateFrom(TGo4Condition *cond, Bool_t counts)
{
  if(!TGo4Condition::UpdateFrom(cond,counts)) return kFALSE;
  if(cond->InheritsFrom(TGo4PolyCond::Class())) {

#ifdef POLYCOND_UPDATE_WITHCLONE
       TCutG * temp = CloneCut((TGo4PolyCond*)cond);  // get clone from source, still valid there!
       CleanupSpecials(); // remove all references to cloned TCutG from list of specials
       if(temp)
          {
             TCutG *old = fxCut; // JAM2016 change cut before deleting the old one!
             fxCut = temp;
             if(old) delete old;
             ClearCutHis();
             return kTRUE;
          }
       else
          {
             return kFALSE;
          }
#else
       /* JAM2016: try to avoid streaming the cut multiple times when updating condition:*/
       TGo4PolyCond *source=(TGo4PolyCond*)cond;
       TCutG * srccut = source->GetCut(false);

       if(!srccut) return kFALSE;
       CleanupSpecials(); // redundant? do it to get rid of entries from streamer!?
       Int_t pn = srccut->GetN();
       fxCut->Set(pn);
       Double_t xp = 0, yp = 0;
       for (Int_t i = 0; i < pn; ++i) {
          srccut->GetPoint(i, xp, yp);
          fxCut->SetPoint(i, xp, yp);
       }

       // still need this to reassign the bins of statistics histogram:
       ClearCutHis();

      return kTRUE;
#endif

    }
 else
   {
      std::cout << "Cannot update " << GetName() << " from " << cond->ClassName() << std::endl;
      return kFALSE;
   }
}


Bool_t TGo4PolyCond::UpdateFromUrl(const char *rest_url_opt)
{
   if (!TGo4Condition::UpdateFromUrl(rest_url_opt))
      return kFALSE;
   TString message;
   message.Form("TGo4PolyCond::UpdateFromUrl - condition %s: with url:%s", GetName(), rest_url_opt);
   TGo4Log::Message(1, "%s", message.Data());

   // evaluate options that change array of points
   if (UrlOptionHasKey(TGo4PolyCond::fgxURL_NPOINTS)) {
      message = "";
      Int_t npoints = GetUrlOptionAsInt(TGo4PolyCond::fgxURL_NPOINTS, -1);
      if (npoints >= 0) {
         TString xname, yname;
         Double_t *X = new Double_t[npoints];
         Double_t *Y = new Double_t[npoints];
         for (Int_t i = 0; i < npoints; ++i) {
            xname.Form("%s%d", TGo4PolyCond::fgxURL_XPRE.Data(), i);
            yname.Form("%s%d", TGo4PolyCond::fgxURL_YPRE.Data(), i);
            X[i] = GetUrlOptionAsDouble(xname.Data(), 0.);
            Y[i] = GetUrlOptionAsDouble(yname.Data(), 0.);
            message.Append(TString::Format(" X[%i]=%f, Y[%i]=%f\n", i, X[i], i, Y[i]));
         }
         SetValues(X, Y, npoints);
         delete[] X;
         delete[] Y;
      }
      message.Append(" - setting Polygon condition to new values!");
      TGo4Log::Message(1, "%s", message.Data());
   }
   return kTRUE;
}

Double_t TGo4PolyCond::GetIntegral(TH1 *histo, Option_t *opt)
{
   return fxCut ? fxCut->IntegralHist(dynamic_cast<TH2 *>(histo),opt) : 0.;
}

Double_t TGo4PolyCond::GetMean(TH1 *histo, Int_t axis)
{
   if (IsCutHis(histo))
      return fxCutHis->GetMean(axis);

   return -1;
}

Double_t TGo4PolyCond::GetRMS(TH1 *histo, Int_t axis)
{
   if (IsCutHis(histo))
      return fxCutHis->GetRMS(axis);

   return -1;
}

Double_t TGo4PolyCond::GetSkewness(TH1 *histo, Int_t axis)
{
   if (IsCutHis(histo))
      return fxCutHis->GetSkewness(axis);

   return -1;
}

Double_t TGo4PolyCond::GetCurtosis(TH1 *histo, Int_t axis)
{
   if (IsCutHis(histo))
      return fxCutHis->GetKurtosis(axis);

   return -1;
}

Double_t TGo4PolyCond::GetXMax(TH1 *histo)
{
   if (IsCutHis(histo)) {
      TAxis *xax = fxCutHis->GetXaxis();
      Int_t maxbin = fxCutHis->GetMaximumBin();
      Int_t xmaxbin = maxbin % (fxCutHis->GetNbinsX() + 2);
      return xax->GetBinCenter(xmaxbin);
   }
   return -1;
}

Double_t TGo4PolyCond::GetYMax(TH1 *histo)
{
   if (IsCutHis(histo)) {
      TAxis *yax = fxCutHis->GetYaxis();
      Int_t maxbin = fxCutHis->GetMaximumBin();
      Int_t maxybin = maxbin / (fxCutHis->GetNbinsX() + 2);
      return yax->GetBinCenter(maxybin);
   }

   return -1;
}

Double_t TGo4PolyCond::GetCMax(TH1 *histo)
{
   if (IsCutHis(histo))
      return fxCutHis->GetMaximum();

   return -1;
}

void TGo4PolyCond::SetPainter(TGo4ConditionPainter *painter)
{
   if (!painter)
      return;
   if (painter->InheritsFrom(TGo4PolyCondPainter::Class())) {
      if (fxPainter)
         delete fxPainter;
      fxPainter = painter;
      fxPainter->SetCondition(this);
   } else {
      TGo4Log::Warn("Could not set painter of class %s for TGo4PolyCond %s", painter->ClassName(), GetName());
   }
}


TGo4ConditionPainter *TGo4PolyCond::CreatePainter()
{
   TGo4ConditionPainter *painter=new TGo4PolyCondPainter(GetName());
   painter->SetCondition(this);
   return painter;
}


Bool_t TGo4PolyCond::IsCutHis(TH1 *source)
{
   if (fxCutHis)
      return kTRUE;

   TH2 *his = dynamic_cast<TH2 *>(source);
   if (!his)
      return kFALSE;

   fxCutHis = (TH2 *) his->Clone();
   Int_t nx = fxCutHis->GetNbinsX();
   Int_t ny = fxCutHis->GetNbinsY();
   TAxis *xaxis = fxCutHis->GetXaxis();
   TAxis *yaxis = fxCutHis->GetYaxis();
   xaxis->SetRange(0, 0); // expand work histogram to full range
   yaxis->SetRange(0, 0);
   // set all bins outside fxCut to zero:
   for (Int_t i = 0; i < nx; ++i) {
      Double_t x = xaxis->GetBinCenter(i);
      for (Int_t j = 0; j < ny; ++j) {
         Double_t y = yaxis->GetBinCenter(j);
         if (fxCut && !(fxCut->IsInside(x, y)))
            fxCutHis->SetBinContent(i, j, 0);
      }
   }
   // prepare statistics:
   Stat_t s[11] = {0};    // dimension is kNstat of TH1.cxx
   fxCutHis->PutStats(s);     // reset previous stats
   fxCutHis->GetStats(s);     // recalculate
   fxCutHis->PutStats(s);     // put back
   fxCutHis->SetDirectory(nullptr); // important for first draw from marker setup file!

   return kTRUE;
}


// ----------------------------------------------------------
void TGo4PolyCond::CleanupSpecials()
{
   TSeqCollection *specials = gROOT->GetListOfSpecials();
   TIter iter(specials);
   while(auto ob = iter()) {
     if(ob->InheritsFrom(TCutG::Class()))
        specials->Remove(ob);
   }
}

Int_t TGo4PolyCond::GetMemorySize() const
{
   Int_t size = sizeof(*this);
   if (GetName()) size += strlen(GetName());
   if (GetTitle()) size += strlen(GetTitle());
   if (fxCut) {
      size += sizeof(*fxCut);
      size += fxCut->GetMaxSize()*2*sizeof(Double_t);
   }
   return size;
}

void TGo4PolyCond::SavePrimitive(std::ostream &out, Option_t *opt)
{
   static int cnt = 0;
   TString line, varname = MakeScript(out, TString::Format("polycond%d", cnt++).Data(), opt);

   if (!fxCut || (fxCut->GetN() == 0)) {
      line.Form("   %s->SetValues(0, 0, 0);", varname.Data());
   } else {
      TString xname = varname;
      xname.ReplaceAll("->At(","_sub");
      xname.ReplaceAll(")","");
      TString yname = xname + "_y";
      xname = xname + "_x";
      line.Form("   Double_t %s[%d], %s[%d];", xname.Data(), fxCut->GetN(), yname.Data(), fxCut->GetN());
      out << line << std::endl;
      for (Int_t n = 0; n < fxCut->GetN(); n++) {
         Double_t x, y;
         fxCut->GetPoint(n, x, y);
         line.Form("   %s[%d] = %f; %s[%d] = %f;", xname.Data(), n, x, yname.Data(), n, y);
         out << line << std::endl;
      }
      line.Form("   %s->SetValues(%s, %s, %d);", varname.Data(), xname.Data(), yname.Data(), fxCut->GetN());
   }

   out << line << std::endl;
}