dqm_algorithms::AddReference Struct Reference

#include <AddReference.h>

Inherits dqm_core::Algorithm.

Inherited by dqm_algorithms::AddReference_All_Bins_Filled, dqm_algorithms::AddReference_BinContentComp, dqm_algorithms::AddReference_Bins_Diff_FromAvg, dqm_algorithms::AddReference_Bins_Equal_Threshold, dqm_algorithms::AddReference_Bins_GreaterThanEqual_Threshold, dqm_algorithms::AddReference_Bins_GreaterThan_Threshold, dqm_algorithms::AddReference_Bins_LessThanEqual_Threshold, dqm_algorithms::AddReference_Bins_LessThan_Threshold, and dqm_algorithms::AddReference_Bins_NotEqual_Threshold.

Collaboration diagram for dqm_algorithms::AddReference:

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

Private Attributes
std::string	m_name

Detailed Description

Definition at line 18 of file AddReference.h.

Constructor & Destructor Documentation

AddReference()

dqm_algorithms::AddReference::AddReference

(

const std::string &

name

)

Definition at line 28 of file AddReference.cxx.

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

Member Function Documentation

clone()

dqm_algorithms::AddReference * dqm_algorithms::AddReference::clone

(

)

Definition at line 34 of file AddReference.cxx.

{
  return new AddReference(m_name);
}

execute()

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

Definition at line 40 of file AddReference.cxx.

{
  TH1 * histogram;
 
  if( object.IsA()->InheritsFrom( "TH1" ) ) {
    histogram = (TH1*)(object.Clone());
  } 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();
    delete histogram;
    return result;
  }
  
  double coeff = dqm_algorithms::tools::GetFirstFromMap("Coeff",config.getParameters(), 1);
  
  TObject* ro = config.getReference();
  const TObject* firstReference = 0;
  TObject* secondReference= 0;
  try {
    dqm_algorithms::tools::handleReference( *ro , firstReference , secondReference );
  }
  catch ( dqm_core::Exception& ex ) {
    throw dqm_core::BadRefHist(ERS_HERE,name," Could not retreive reference");
  }
 
  const TH1* refhist = dynamic_cast<const TH1*>(firstReference);
  if ( refhist == 0 )
    {
      throw dqm_core::BadRefHist(ERS_HERE,name," Could not retreive reference");
    }
 
if ((histogram->GetDimension() != refhist->GetDimension()) ||
    (histogram->GetNbinsX() != refhist->GetNbinsX()) || 
    (histogram->GetNbinsY() != refhist->GetNbinsY()) || 
    refhist->GetNbinsZ() != histogram->GetNbinsZ() ) {
    throw dqm_core::BadRefHist( ERS_HERE, "number of bins", name );
  }
  ERS_DEBUG(2,"Doing: histogram + ("<<coeff<<")*reference");
  histogram->Add( refhist , coeff );
  
  //Now prepare to run the real algorithm...
  ERS_DEBUG(2,"Running algorithm: "<<m_name);
  dqm_core::Algorithm* subalgorithm;
  try {
    subalgorithm = dqm_core::AlgorithmManager::instance().getAlgorithm( m_name );
  }
  catch ( dqm_core::AlgorithmNotFound& ex )
    {
      ERS_DEBUG(2,"Cannot find algorithm:"+m_name);
      throw dqm_core::BadConfig(ERS_HERE,name,"Cannot Find sub-algorithm:"+m_name);
    }
  dqm_core::Result* result = subalgorithm->execute( name , *histogram ,  config);
  ERS_DEBUG(2,"Sub algorithm returns:"<<*result);
  //Add modified histogram to result
  TObject* robject = result->getObject();
  if ( !robject ) //No object defined, add this
    {
      ERS_DEBUG(2,"Adding modified histogram in result");
      result->object_.reset(histogram);
    }
  else //Transform the object_ in TObjArray (if needed) and add this result
    {
      ERS_DEBUG(2,"Result already have an associated TObject, appending modified histogram");
      if ( robject->IsA()->InheritsFrom("TObjArray") ) //It is already an array add it...
    {     
      static_cast<TObjArray*>(robject)->Add( histogram );
      //Check in again
      result->object_.reset( robject );
    }
      else
    {
      TObjArray* array = new TObjArray( 2 );
      array->AddAt( robject , 0 );
      array->AddAt( histogram , 1 );
      //Check in again
      result->object_.reset( array );
    }
      ERS_DEBUG(2,"Result now have a TObjArray of size:"<<static_cast<TObjArray*>(result->getObject())->GetEntries());
    }
  return result;
}

printDescription()

void dqm_algorithms::AddReference::printDescription

(

std::ostream &

out

)

Definition at line 129 of file AddReference.cxx.

                                                                 {
  out<<"AddReference_"+m_name+" : Performst the "+m_name+" algorithm after adding to the input histogram the reference. I.e. performing: histogram += c*Reference. Adds to the output TObject list the modified input histogram."<<std::endl;
  out<<"Optional Parameter : MinStat : Minimum histogram statistics needed to perform Algorithm"<<std::endl;
  out<<"Optional Parameter : Coeff : The multiplication coefficient c, for reference. Default c=+1"<<std::endl;
 
}

Member Data Documentation

m_name

std::string dqm_algorithms::AddReference::m_name

private

Definition at line 26 of file AddReference.h.

---

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

• AddReference.h
• AddReference.cxx