DetailedOutputAggregator.cxx

Go to the documentation of this file.

// @(#)root/roostats:$Id$
// Author: Sven Kreiss, Kyle Cranmer, Lorenzo Moneta  Nov 2010
/*************************************************************************
 * Copyright (C) 1995-2008, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
/** \class RooStats::DetailedOutputAggregator
   \ingroup Roostats
 
This class is designed to aid in the construction of RooDataSets and RooArgSets,
particularly those naturally arising in fitting operations. Typically, the usage
of this class is as follows:
 
1.  create DetailedOutputAggregator instance
2.  use AppendArgSet to add value sets to be stored as one row of the dataset
3.  call CommitSet when an entire row's worth of values has been added
4.  repeat steps 2 and 3 until all rows have been added
5.  call GetAsDataSet to extract result RooDataSet
 
*/
 
#include <limits>
 
 
#include "RooFitResult.h"
#include "RooPullVar.h"
#include "RooRealVar.h"
#include "RooDataSet.h"
 
#include "RooStats/DetailedOutputAggregator.h"
 
namespace RooStats {
 
   DetailedOutputAggregator::~DetailedOutputAggregator() {
      // destructor
      if (fResult != nullptr) delete fResult;
      if (fBuiltSet != nullptr) delete fBuiltSet;
   }
 
////////////////////////////////////////////////////////////////////////////////
/// static function to translate the given fit result to a RooArgSet in a generic way.
/// Prefix is prepended to all variable names.
/// LM: caller is responsible to delete the returned list and eventually also the content of the list
///    Note that the returned list is not owning the returned content
 
   RooArgSet * DetailedOutputAggregator::GetAsArgSet(RooFitResult *result, TString prefix, bool withErrorsAndPulls) {
 
      RooArgSet *detailedOutput = new RooArgSet;
      const RooArgList &detOut = result->floatParsFinal();
      const RooArgList &truthSet = result->floatParsInit();
 
      for (RooAbsArg* v : detOut) {
         RooAbsArg* clone = v->cloneTree(TString().Append(prefix).Append(v->GetName()));
         clone->SetTitle( TString().Append(prefix).Append(v->GetTitle()) );
         RooRealVar* var = dynamic_cast<RooRealVar*>(v);
         if (var) clone->setAttribute("StoreError");
         detailedOutput->add(*clone);
 
         if( withErrorsAndPulls && var ) {
            clone->setAttribute("StoreAsymError");
 
            TString pullname = TString().Append(prefix).Append(TString::Format("%s_pull", var->GetName()));
            //             TString pulldesc = TString::Format("%s pull for fit %u", var->GetTitle(), fitNumber);
            RooRealVar* truth = dynamic_cast<RooRealVar*>(truthSet.find(var->GetName()));
            RooPullVar pulltemp("temppull", "temppull", *var, *truth);
            RooRealVar* pull = new RooRealVar(pullname, pullname, pulltemp.getVal());
            detailedOutput->add(*pull);
         }
      }
 
      // monitor a few more variables
      detailedOutput->add( *new RooRealVar(TString().Append(prefix).Append("minNLL"), TString().Append(prefix).Append("minNLL"), result->minNll() ) );
      detailedOutput->add( *new RooRealVar(TString().Append(prefix).Append("fitStatus"), TString().Append(prefix).Append("fitStatus"), result->status() ) );
      detailedOutput->add( *new RooRealVar(TString().Append(prefix).Append("covQual"), TString().Append(prefix).Append("covQual"), result->covQual() ) );
      detailedOutput->add( *new RooRealVar(TString().Append(prefix).Append("numInvalidNLLEval"), TString().Append(prefix).Append("numInvalidNLLEval"), result->numInvalidNLL() ) );
      return detailedOutput;
   }
 
////////////////////////////////////////////////////////////////////////////////
/// For each variable in aset, prepend prefix to its name and add
/// to the internal store. Note this will not appear in the produced
/// dataset unless CommitSet is called.
 
   void DetailedOutputAggregator::AppendArgSet(const RooAbsCollection *aset, TString prefix) {
 
      if (aset == nullptr) {
         // silently ignore
         //std::cout << "Attempted to append nullptr" << std::endl;
         return;
      }
      if (fBuiltSet == nullptr) {
         fBuiltSet = new RooArgList();
      }
      for (const RooAbsArg* v : *aset) {
         TString renamed(TString::Format("%s%s", prefix.Data(), v->GetName()));
         if (fResult == nullptr) {
            // we never committed, so by default all columns are expected to not exist
            std::unique_ptr<RooAbsArg> var{v->createFundamental()};
            assert(var != nullptr);
            RooArgSet(*var).assign(RooArgSet(*v));
            var->SetName(renamed);
            if (RooRealVar* rvar= dynamic_cast<RooRealVar*>(var.get())) {
               if (v->getAttribute("StoreError"))     var->setAttribute("StoreError");
               else rvar->removeError();
               if (v->getAttribute("StoreAsymError")) var->setAttribute("StoreAsymError");
               else rvar->removeAsymError();
            }
            if (fBuiltSet->addOwned(std::move(var))) continue;  // OK - can skip past setting value
         }
         if (RooAbsArg* var = fBuiltSet->find(renamed)) {
            // we already committed an argset once, so we expect all columns to already be in the set
            var->SetName(v->GetName());
            RooArgSet(*var).assign(RooArgSet(*v)); // copy values and errors
            var->SetName(renamed);
         }
      }
 
   }
 
////////////////////////////////////////////////////////////////////////////////
/// Commit to the result RooDataSet.
 
   void DetailedOutputAggregator::CommitSet(double weight) {
      if (fResult == nullptr) {
         // Store dataset as a tree - problem with VectorStore and StoreError (bug #94908)
         fResult = new RooDataSet("", "", *fBuiltSet, RooFit::WeightVar());
      }
      fResult->add(RooArgSet(*fBuiltSet), weight);
 
      for (RooAbsArg* v : *fBuiltSet) {
         if (RooRealVar* var= dynamic_cast<RooRealVar*>(v)) {
            // Invalidate values in case we don't set some of them next time round (eg. if fit not done)
            var->setVal(std::numeric_limits<double>::quiet_NaN());
            var->removeError();
            var->removeAsymError();
         }
      }
   }
 
////////////////////////////////////////////////////////////////////////////////
/// Returns all detailed output as a dataset.
/// Ownership of the dataset is transferred to the caller.
 
   RooDataSet * DetailedOutputAggregator::GetAsDataSet(TString name, TString title) {
      RooDataSet* temp = nullptr;
      if( fResult ) {
         temp = fResult;
         fResult = nullptr;   // we no longer own the dataset
         temp->SetNameTitle( name.Data(), title.Data() );
      }else{
         temp = new RooDataSet(name.Data(), title.Data(), {}, RooFit::WeightVar());
      }
      delete fBuiltSet;
      fBuiltSet = nullptr;
 
      return temp;
   }
 
 
}  // end namespace RooStats