dqm_algorithms::KurtosisTest Struct Reference

#include <KurtosisTest.h>

Inheritance diagram for dqm_algorithms::KurtosisTest:

Collaboration diagram for dqm_algorithms::KurtosisTest:

Public Member Functions
	KurtosisTest (const std::string &name)
KurtosisTest *	clone ()
dqm_core::Result *	execute (const std::string &, const TObject &, const dqm_core::AlgorithmConfig &)
void	printDescription (std::ostream &out)
bool	CompareKurtosisTest (const std::string &type, double value, double threshold)

Private Attributes
std::string	m_name

Detailed Description

Definition at line 18 of file KurtosisTest.h.

Constructor & Destructor Documentation

KurtosisTest()

dqm_algorithms::KurtosisTest::KurtosisTest

(

const std::string &

name

)

Definition at line 29 of file KurtosisTest.cxx.

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

Member Function Documentation

clone()

dqm_algorithms::KurtosisTest * dqm_algorithms::KurtosisTest::clone

(

)

Definition at line 36 of file KurtosisTest.cxx.

{
    return new KurtosisTest( m_name );
}

CompareKurtosisTest()

bool dqm_algorithms::KurtosisTest::CompareKurtosisTest	(	const std::string &	type,
		double	value,
		double	threshold
	)

Definition at line 98 of file KurtosisTest.cxx.

                                                                                                      {
  
  if (type == "GreaterThan") return (value > threshold);
  if (type == "LessThan") return (value < threshold);
  if (type == "GreaterThanAbs") return ( std::abs(value) > threshold );
  if (type == "LessThanAbs") return ( std::abs(value) < threshold);
  return 0;
}

execute()

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

Definition at line 43 of file KurtosisTest.cxx.

{  
  const TH1 * histogram;
  
  if( object.IsA()->InheritsFrom( "TH1" ) ) {
    histogram = static_cast<const TH1*>(&object);
  } else {
    throw dqm_core::BadConfig( ERS_HERE, name, "does not inherit from TH1" );
  }
  
  const double minstat = dqm_algorithms::tools::GetFirstFromMap( "MinStat", config.getParameters(), -1);
  
  if (histogram->GetEffectiveEntries() < minstat ) {
    dqm_core::Result *result = new dqm_core::Result(dqm_core::Result::Undefined);
    result->tags_["InsufficientEffectiveEntries"] = histogram->GetEffectiveEntries();
    return result;
  }
  
  double gthreshold;
  double rthreshold;
  
  int axis = (int) dqm_algorithms::tools::GetFirstFromMap( "Axis", config.getParameters(), 1);
 
  try {
    rthreshold = dqm_algorithms::tools::GetFromMap( "K", config.getRedThresholds() );
    gthreshold = dqm_algorithms::tools::GetFromMap( "K", config.getGreenThresholds() );
  }
  catch ( dqm_core::Exception & ex ) {
    throw dqm_core::BadConfig( ERS_HERE, name, ex.what(), ex );
  }
  ERS_DEBUG(1,"Axis for kurtosis calculation:"<<axis);
  
  Double_t kurtosis = histogram->GetKurtosis( axis );
  Double_t kurtosis_e = histogram->GetKurtosis( axis + 10 );
 
  dqm_core::Result* result = new dqm_core::Result();
  ERS_DEBUG(1,"Kurtosis = "<<kurtosis<<" +- "<<kurtosis_e);
  result->tags_["Kurtosis"] = kurtosis;
  result->tags_["ApproxStandardError"]=kurtosis_e;
  
  if ( CompareKurtosisTest( m_name , kurtosis ,gthreshold)  ) {
    result->status_ = dqm_core::Result::Green;
  } else if ( CompareKurtosisTest( m_name, kurtosis, rthreshold) ) {
    result->status_ = dqm_core::Result::Yellow;
  } else {
    result->status_ = dqm_core::Result::Red;
  }
  
  return result;
  
}

printDescription()

void dqm_algorithms::KurtosisTest::printDescription

(

std::ostream &

out

)

Definition at line 109 of file KurtosisTest.cxx.

{
  out<<"KurtosisTest_"+m_name+" : Checks if the Excess Kurtosis of the distribution is "+m_name+" threshold value\n"<<std::endl;
  
  out<<"Mandatory Green/Red Threshold: K: Value of Kurtosis"<<std::endl;
  
  out<<"Optional Parameter: MinStat: Minimum histogram statistics needed to perform Algorithm"<<std::endl;
  out<<"Optional Parameter: Axis: Axis along which compute Kurtosis: 1=X, 2=Y, 3=Z"<<std::endl;
  
}

Member Data Documentation

m_name

std::string dqm_algorithms::KurtosisTest::m_name

private

Definition at line 29 of file KurtosisTest.h.

---

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

• KurtosisTest.h
• KurtosisTest.cxx