dqm_algorithms::CheckMean Class Reference

#include <CheckMean.h>

Inheritance diagram for dqm_algorithms::CheckMean:

Collaboration diagram for dqm_algorithms::CheckMean:

Public Member Functions
	CheckMean ()
virtual	~CheckMean ()
virtual dqm_core::Algorithm *	clone ()
virtual dqm_core::Result *	execute (const std::string &name, const TObject &data, const dqm_core::AlgorithmConfig &config)
virtual void	printDescription (std::ostream &out)

Protected Member Functions
virtual double	getWarningLimit (const dqm_core::AlgorithmConfig &config, std::string limitName)
virtual double	getErrorLimit (const dqm_core::AlgorithmConfig &config, std::string limitName)

Protected Attributes
std::string	m_name
std::string	m_limitName

Detailed Description

Definition at line 16 of file CheckMean.h.

Constructor & Destructor Documentation

CheckMean()

dqm_algorithms::CheckMean::CheckMean

(

)

Definition at line 30 of file CheckMean.cxx.

  : m_name("AlgCheckMean")
  , m_limitName("chi2")
{
  dqm_core::AlgorithmManager::instance().registerAlgorithm( m_name, this );
}

~CheckMean()

dqm_algorithms::CheckMean::~CheckMean ( )

virtual

Definition at line 39 of file CheckMean.cxx.

{
}

Member Function Documentation

clone()

dqm_core::Algorithm * dqm_algorithms::CheckMean::clone ( )

virtual

Definition at line 46 of file CheckMean.cxx.

{
  return new CheckMean(*this);
}

execute()

dqm_core::Result * dqm_algorithms::CheckMean::execute ( const std::string & name, const TObject & data, const dqm_core::AlgorithmConfig & config )

virtual

Definition at line 54 of file CheckMean.cxx.

{
  dqm_core::Result::Status status(dqm_core::Result::Undefined);
  
  // Cast to the type of TObject to assess
  const TH1* h = dynamic_cast<const TH1*>( &data );
  if( h == 0 ) {
    throw dqm_core::BadConfig( ERS_HERE, name, "Cannot cast data to type TH1" );
  }
  
  const TH1* ref = dynamic_cast<const TH1*>( config.getReference() );
  if( ref == 0 ) {
    throw dqm_core::BadConfig( ERS_HERE, name, "Cannot obtain reference of type TH1" );
  }
  
  // Perform the check
  const double mean_data = h->GetMean();
  const double mean_ref  = ref->GetMean();
  
  const double mean_data_err = h->GetMeanError();
  const double mean_ref_err  = ref->GetMeanError();
  
  const double chi2_warn = getWarningLimit( config, m_limitName );
  const double chi2_err = getErrorLimit( config, m_limitName );
  
  const double s  = ( mean_data - mean_ref );
  const double s2 = s*s;
  const double e2 =  mean_data_err*mean_data_err + mean_ref_err*mean_ref_err;
  
  const double chi2 = s2/e2;
  
  //out << "mean_data = " << mean_data << "\n";
  //out << "mean_ref = " << mean_ref << "\n";
  //out << "mean_data_err = " << mean_data_err << "\n";
  //out << "mean_ref_err = " << mean_ref_err << "\n";
  //out << "chi2 = " << chi2 << "\n";
  
  if( chi2 < chi2_warn ) {
    status = dqm_core::Result::Green;
  }
  else if( chi2 < chi2_err ) {
    status = dqm_core::Result::Yellow;
  }
  else {
    status = dqm_core::Result::Red;
  }
  
  // Return the result
  return new dqm_core::Result( status );
}

getErrorLimit()

double dqm_algorithms::CheckMean::getErrorLimit ( const dqm_core::AlgorithmConfig & config, std::string limitName )

protectedvirtual

Definition at line 145 of file CheckMean.cxx.

{
  std::map<std::string,double> rdmap = config.getRedThresholds();
  std::map<std::string,double>::const_iterator i = rdmap.find( limitName );
  if( i == rdmap.end() ) {
    throw dqm_core::BadConfig( ERS_HERE, std::move(limitName), "Cannot find red threshold" );
  }
  
  return i->second;
}

getWarningLimit()

double dqm_algorithms::CheckMean::getWarningLimit ( const dqm_core::AlgorithmConfig & config, std::string limitName )

protectedvirtual

Definition at line 131 of file CheckMean.cxx.

{
  std::map<std::string,double> grmap = config.getGreenThresholds();
  std::map<std::string,double>::const_iterator i = grmap.find( limitName );
  if( i == grmap.end() ) {
    throw dqm_core::BadConfig( ERS_HERE, std::move(limitName), "Cannot find green threshold" );
  }
  
  return i->second;
}

printDescription()

void dqm_algorithms::CheckMean::printDescription ( std::ostream & out )

virtual

Definition at line 108 of file CheckMean.cxx.

{
  std::string message;
  message += "\n";
  message += "Algorithm: \"" + m_name + "\"\n";
  message += "Description: Checks the mean of a TH1 against the mean of a reference TH1\n";
  message += "             by assessing a chi2 defined by the two means and their errors\n";
  message += "Parameters: none\n";
  message += "Limits:\n";
  message += " \"" + m_limitName + "\" : generate warnings on the chi2 value\n";
  message += "\n";
  
  out << message;
}

Member Data Documentation

m_limitName

std::string dqm_algorithms::CheckMean::m_limitName

protected

Definition at line 34 of file CheckMean.h.

m_name

std::string dqm_algorithms::CheckMean::m_name

protected

Definition at line 33 of file CheckMean.h.

---

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

• CheckMean.h
• CheckMean.cxx