dqm_algorithms::LastBinThresholdAction< Exceed, Action > Class Template Reference

#include <LastBinThresholdAction.h>

Inheritance diagram for dqm_algorithms::LastBinThresholdAction< Exceed, Action >:

Collaboration diagram for dqm_algorithms::LastBinThresholdAction< Exceed, Action >:

Public Member Functions
	LastBinThresholdAction (const std::string &name)
virtual LastBinThresholdAction *	clone () override
virtual dqm_core::Result *	execute (const std::string &, const TObject &, const dqm_core::AlgorithmConfig &) override
virtual void	printDescription (std::ostream &out) const

Private Attributes
std::string	m_name
Exceed	m_exceeds
Action	m_doAction

Detailed Description

template<class Exceed, class Action>
class dqm_algorithms::LastBinThresholdAction< Exceed, Action >

Definition at line 47 of file LastBinThresholdAction.h.

Constructor & Destructor Documentation

LastBinThresholdAction()

template<class Exceed, class Action>

dqm_algorithms::LastBinThresholdAction< Exceed, Action >::LastBinThresholdAction

(

const std::string &

name

)

Definition at line 64 of file LastBinThresholdAction.cxx.

  : m_name( name )
{
  dqm_core::AlgorithmManager::instance().registerAlgorithm(name, this);
}

Member Function Documentation

clone()

template<class Exceed, class Action>

dqm_algorithms::LastBinThresholdAction< Exceed, Action > * dqm_algorithms::LastBinThresholdAction< Exceed, Action >::clone ( )

overridevirtual

Definition at line 72 of file LastBinThresholdAction.cxx.

                                                            {
  return new LastBinThresholdAction(m_name);
}

execute()

template<class Exceed, class Action>

dqm_core::Result * dqm_algorithms::LastBinThresholdAction< Exceed, Action >::execute ( const std::string & name, const TObject & object, const dqm_core::AlgorithmConfig & config )

overridevirtual

Definition at line 78 of file LastBinThresholdAction.cxx.

{
  const TProfile* histogram;
 
  if( object.IsA()->InheritsFrom( "TProfile" ) ) {
    histogram = static_cast<const TProfile*>(&object);
    if (histogram->GetDimension() > 1){
      throw dqm_core::BadConfig( ERS_HERE, name, "dimension > 2 " );
    }
  } else {
    throw dqm_core::BadConfig( ERS_HERE, name, "does not inherit from TProfile" );
  }
 
  const double minStat = dqm_algorithms::tools::GetFirstFromMap( "MinStat", config.getParameters(), -1);
  const double fixedError = dqm_algorithms::tools::GetFirstFromMap( "FixedError", config.getParameters(), -1);
  const bool ignoreEmpty = static_cast<bool>( dqm_algorithms::tools::GetFirstFromMap( "IgnoreEmpty", config.getParameters(), 1) );
  const bool publish = static_cast<bool>( dqm_algorithms::tools::GetFirstFromMap( "PublishBins", config.getParameters(), 0) );
  const int maxPublish = static_cast<int>( dqm_algorithms::tools::GetFirstFromMap( "MaxPublish", config.getParameters(), 20) );
  const int nBinsToWatch = static_cast<int>( dqm_algorithms::tools::GetFirstFromMap( "NBinsToWatch", config.getParameters(), -1) );
  const int nBinsForAction = static_cast<int>( dqm_algorithms::tools::GetFirstFromMap( "NBinsForAction", config.getParameters(), 99999) );
 
  std::string action("");
  std::map<std::string, std::string>::const_iterator itAction = config.getGenericParameters().find("Action");
  if (itAction != config.getGenericParameters().end()) {
    action = itAction->second;
  }
 
  if (histogram->GetEntries() < minStat ) {
    dqm_core::Result *result = new dqm_core::Result(dqm_core::Result::Undefined);
    result->tags_["InsufficientEntries"] = histogram->GetEntries();
    return result;
  }
 
  double binThreshold;
  double greenThreshold;
  double redThreshold;
  try {
    binThreshold = dqm_algorithms::tools::GetFirstFromMap( "BinThreshold", config.getParameters() );
    redThreshold = dqm_algorithms::tools::GetFromMap( "NBins", config.getRedThresholds() );
    greenThreshold = dqm_algorithms::tools::GetFromMap( "NBins", config.getGreenThresholds() );
  } catch ( dqm_core::Exception & ex ) {
    throw dqm_core::BadConfig( ERS_HERE, name, ex.what(), ex );
  }
 
  dqm_core::Result* result = new dqm_core::Result();
 
  int nBinsOverThreshold = 0;
 
  int firstBin = 1;
  int lastBin = histogram->GetNbinsX();
 
  if (nBinsToWatch > 0) {
    while ((histogram->GetBinEntries(lastBin) == 0) && (lastBin > 1)) --lastBin;
    firstBin = (lastBin > nBinsToWatch) ? (lastBin - nBinsToWatch + 1) : 1;
 
    result->tags_["LastBinNumber"] = lastBin; // report where we began the checks (mostly for debugging)
    result->tags_["LastBinCenter"] = histogram->GetBinCenter(lastBin); // report where that is on the x-axis
  }
 
  double lastBinOverThresholdContent(0.0);
  double binsOverThresholdContent(0.0);
 
  for (int bin = firstBin; bin <= lastBin; ++bin) {
    if (ignoreEmpty && (histogram->GetBinEntries(bin) == 0)) {
      continue;
    }
    double content = histogram->GetBinContent(bin);
    if (m_exceeds(content, binThreshold, fixedError)) {
      ++nBinsOverThreshold;
      lastBinOverThresholdContent = content;
      binsOverThresholdContent += content;
      if (publish && nBinsOverThreshold < maxPublish){
        dqm_algorithms::tools::PublishBin(histogram, bin, 1, content, result);
      }
    }
  }
 
  ERS_DEBUG(1,"Number of bins exceeded threshold of " << binThreshold << " is " << nBinsOverThreshold );
  ERS_DEBUG(1,"Green threshold: "<< greenThreshold << " bin(s);   Red threshold : " << redThreshold << " bin(s) ");
 
  result->tags_["NBins"] = nBinsOverThreshold;
  if (greenThreshold > redThreshold) {
    if (nBinsOverThreshold >= greenThreshold) {
      result->status_ = dqm_core::Result::Green;
    } else if (nBinsOverThreshold > redThreshold) {
      result->status_ = dqm_core::Result::Yellow;
    } else {
      result->status_ = dqm_core::Result::Red;
    }
  } else {
    if (nBinsOverThreshold <= greenThreshold) {
      result->status_ = dqm_core::Result::Green;
    } else if (nBinsOverThreshold < redThreshold) {
      result->status_ = dqm_core::Result::Yellow;
    } else {
      result->status_ = dqm_core::Result::Red;
    }
  }
 
  if (!action.empty() && nBinsOverThreshold >= nBinsForAction && nBinsOverThreshold!=0) {
    double averageBinContent = binsOverThresholdContent / nBinsOverThreshold;
    //coverity[copy_constructor_call]
    m_doAction(histogram->GetName(), action, lastBinOverThresholdContent, averageBinContent);
  }
 
  return result;
 
}

printDescription()

template<class Exceed, class Action>

void dqm_algorithms::LastBinThresholdAction< Exceed, Action >::printDescription ( std::ostream & out ) const

virtual

Definition at line 190 of file LastBinThresholdAction.cxx.

                                                                                                 {
 
  out << m_name + ": Checks for number of bins exceded threshold value" << std::endl;
  out << "Mandatory Parameter: BinThreshold: Look for bins exceeded BinTreshold; Count number of bins satifying requirement" << std::endl;
  out << "Mandatory Green/Red Threshold: NBins: Number of bins satifying BinThreshold constraint to give Green/Red result" << std::endl;
 
  out << "Optional Parameter: FixedError: override the histogram errors with this value" << std::endl;
  out << "Optional Parameter: IgnoreEmpty: Ignore bins which have zero entries in histogram" << std::endl;
  out << "Optional Parameter: PublishBins: Save bins which are different from average in Result (set to 1)" << std::endl;
  out << "Optional Parameter: MaxPublish: Max number of bins to save (default 20)" << std::endl;
  out << "Optional Parameter: MinStat: Minimum histogram statistics needed to perform Algorithm" << std::endl;
  out << "Optional parameter: NBinsToWatch - number of final bins that will be checked. (NBinsToWatch >= 1, default = -1)" << std::endl;
}

Member Data Documentation

m_doAction

template<class Exceed, class Action>

Action dqm_algorithms::LastBinThresholdAction< Exceed, Action >::m_doAction

private

Definition at line 60 of file LastBinThresholdAction.h.

m_exceeds

template<class Exceed, class Action>

Exceed dqm_algorithms::LastBinThresholdAction< Exceed, Action >::m_exceeds

private

Definition at line 59 of file LastBinThresholdAction.h.

m_name

template<class Exceed, class Action>

std::string dqm_algorithms::LastBinThresholdAction< Exceed, Action >::m_name

private

Definition at line 58 of file LastBinThresholdAction.h.

---

The documentation for this class was generated from the following files:

• LastBinThresholdAction.h
• LastBinThresholdAction.cxx