SummaryPlotFactoryBase Class Reference

#include <SummaryPlotFactoryBase.h>

Inheritance diagram for SummaryPlotFactoryBase:

Protected Member Functions
void	fill (TH1 &summary_histo)
void	init (const sistrip::Monitorable &, const sistrip::Presentation &, const sistrip::View &, const std::string &top_level_dir, const sistrip::Granularity &)
	SummaryPlotFactoryBase ()
	~SummaryPlotFactoryBase ()

Protected Attributes
SummaryGenerator *	generator_
sistrip::Granularity	gran_
std::string	level_
sistrip::Monitorable	mon_
sistrip::Presentation	pres_
sistrip::View	view_

Detailed Description

Definition at line 9 of file SummaryPlotFactoryBase.h.

Constructor & Destructor Documentation

SummaryPlotFactoryBase::SummaryPlotFactoryBase ( )

protected

Definition at line 11 of file SummaryPlotFactoryBase.cc.

                                               :
  mon_(sistrip::UNKNOWN_MONITORABLE),
  pres_(sistrip::UNKNOWN_PRESENTATION),
  view_(sistrip::UNKNOWN_VIEW),
  level_(sistrip::root_),
  gran_(sistrip::UNKNOWN_GRAN),
  generator_(nullptr) 
{;} 

SummaryPlotFactoryBase::~SummaryPlotFactoryBase ( )

protected

Definition at line 22 of file SummaryPlotFactoryBase.cc.

References generator_.

                                                {
  if ( generator_ ) { delete generator_; }
}

Member Function Documentation

void SummaryPlotFactoryBase::fill ( TH1 &  summary_histo )

protected

Definition at line 112 of file SummaryPlotFactoryBase.cc.

References SummaryGenerator::format(), generator_, gran_, SummaryGenerator::histo1D(), SummaryGenerator::histo2DScatter(), SummaryGenerator::histo2DSum(), sistrip::HISTO_1D, sistrip::HISTO_2D_SCATTER, sistrip::HISTO_2D_SUM, level_, sistrip::mlSummaryPlots_, mon_, SummaryGenerator::nBins(), pres_, SiStripEnumsAndStrings::presentation(), SummaryGenerator::profile1D(), sistrip::PROFILE_1D, sistrip::UNKNOWN_RUN_TYPE, and view_.

Referenced by SummaryPlotFactory< FedCablingAnalysis * >::fill(), SummaryPlotFactory< T >::fill(), and SummaryPlotFactory< CommissioningAnalysis * >::fill().

                                                      {
  
  // Check if instance of generator class exists
  if ( !generator_ ) { 
    edm::LogWarning(mlSummaryPlots_) 
      << "[SummaryPlotFactoryBase::" << __func__ << "]" 
      << " NULL pointer to SummaryGenerator object!";
    return;
  }
  
  // Check if map is filled
  if ( !generator_->nBins() ) { 
    edm::LogWarning(mlSummaryPlots_)
      << "[SummaryPlotFactoryBase::" << __func__ << "]" 
      << " Zero bins returned by SummaryGenerator!";
    return; 
  } 
  
  // Print contents of map for histogram
  //generator_->printMap();
  
  // Generate appropriate summary histogram 
  if ( pres_ == sistrip::HISTO_1D ) {
    generator_->histo1D( summary_histo );
  } else if ( pres_ == sistrip::HISTO_2D_SUM ) {
    generator_->histo2DSum( summary_histo );
  } else if ( pres_ == sistrip::HISTO_2D_SCATTER ) {
    generator_->histo2DScatter( summary_histo );
  } else if ( pres_ == sistrip::PROFILE_1D ) {
    generator_->profile1D( summary_histo );
  } else { 
    edm::LogWarning(mlSummaryPlots_)
      << "[SummaryPlotFactoryBase::" << __func__ << "]" 
      << " Unexpected presentation type: "
      << SiStripEnumsAndStrings::presentation( pres_ );
    return; 
  }
  
  // Histogram formatting
  generator_->format( sistrip::UNKNOWN_RUN_TYPE, //@@ not used
              mon_, 
              pres_, 
              view_, 
              level_, 
              gran_, 
              summary_histo );
  
}

void SummaryPlotFactoryBase::init ( const sistrip::Monitorable &  mon, const sistrip::Presentation &  pres, const sistrip::View &  view, const std::string &  top_level_dir, const sistrip::Granularity &  gran  )

protected

Definition at line 28 of file SummaryPlotFactoryBase.cc.

References SummaryGenerator::clearMap(), generator_, gran_, SiStripEnumsAndStrings::granularity(), sistrip::HISTO_1D, SummaryGenerator::instance(), hcalDigis_cfi::level, level_, sistrip::mlSummaryPlots_, LaserDQM_cfi::mon, mon_, SiStripEnumsAndStrings::monitorable(), pres_, SiStripEnumsAndStrings::presentation(), sistrip::UNDEFINED_GRAN, sistrip::UNDEFINED_MONITORABLE, sistrip::UNDEFINED_PRESENTATION, sistrip::UNDEFINED_VIEW, sistrip::undefinedView_, sistrip::UNKNOWN_GRAN, sistrip::UNKNOWN_MONITORABLE, sistrip::UNKNOWN_PRESENTATION, sistrip::UNKNOWN_VIEW, sistrip::unknownView_, SiStripEnumsAndStrings::view(), and view_.

Referenced by SummaryPlotFactory< FedCablingAnalysis * >::init(), SummaryPlotFactory< T >::init(), and SummaryPlotFactory< CommissioningAnalysis * >::init().

                                                    {
  
  // Create generator object
  if ( generator_ ) { delete generator_; generator_ = nullptr; }
  generator_ = SummaryGenerator::instance( view );
  
  // Check if generator object exists
  if ( !generator_ ) { 
    edm::LogWarning(mlSummaryPlots_) 
      << "[SummaryPlotFactoryBase::" << __func__ << "]" 
      << " NULL pointer to generator object!"; 
    return; 
  }
  
  // Clear map used to build histogram 
  generator_->clearMap();
  
  // Set parameters
  mon_ = mon;
  pres_ = pres;
  view_ = view;
  level_ = level;
  gran_ = gran;
  
  // Some checks
  if ( mon_ == sistrip::UNKNOWN_MONITORABLE ||
       mon_ == sistrip::UNDEFINED_MONITORABLE ) {
    edm::LogWarning(mlSummaryPlots_) 
      << "[SummaryPlotFactoryBase::" << __func__ << "]"
      << " Unexpected monitorable: " 
      << SiStripEnumsAndStrings::monitorable(mon_);
  }
  
  if ( pres_ == sistrip::UNKNOWN_PRESENTATION ||
       pres_ == sistrip::UNDEFINED_PRESENTATION ) {
    edm::LogWarning(mlSummaryPlots_) 
      << "[SummaryPlotFactoryBase::" << __func__ << "]"
      << " Unexpected presentation: " 
      << SiStripEnumsAndStrings::presentation(pres_);
  } 

  if ( view_ == sistrip::UNKNOWN_VIEW ||
       view_ == sistrip::UNDEFINED_VIEW ) {
    edm::LogWarning(mlSummaryPlots_) 
      << "[SummaryPlotFactoryBase::" << __func__ << "]"
      << " Unexpected view: " 
      << SiStripEnumsAndStrings::view(view_);
  }
  
  if ( level_.empty() ||
       level_.find(sistrip::unknownView_) != std::string::npos ||
       level_.find(sistrip::undefinedView_) != std::string::npos ) {
    edm::LogWarning(mlSummaryPlots_) 
      << "[SummaryPlotFactoryBase::" << __func__ << "]"
      << " Unexpected top-level directory: \"" 
      << level_ << "\"";
  } 
  
  if ( ( gran_ == sistrip::UNKNOWN_GRAN ||
     gran_ == sistrip::UNDEFINED_GRAN ) &&
       pres != sistrip::HISTO_1D ) {
    edm::LogWarning(mlSummaryPlots_) 
      << "[SummaryPlotFactoryBase::" << __func__ << "]"
      << " Unexpected granularity: " 
      << SiStripEnumsAndStrings::granularity(gran_);
  }
  
//   ss << "[SummaryPlotFactoryBase::" << __func__ << "]" 
//      << " Dump of parameters defining summary plot:" << std::endl
//      << " Monitorable   : " << SiStripEnumsAndStrings::monitorable( mon_ ) << std::endl
//      << " Presentation  : " << SiStripEnumsAndStrings::presentation( pres_ ) << std::endl
//      << " Logical view  : " << SiStripEnumsAndStrings::view( view_ ) << std::endl
//      << " Top level dir : " << level_ << std::endl
//      << " Granularity   : " << SiStripEnumsAndStrings::granularity( gran_ );
//   LogTrace(mlSummaryPlots_) << ss.str();
  
}

Member Data Documentation

SummaryGenerator* SummaryPlotFactoryBase::generator_

protected

Definition at line 35 of file SummaryPlotFactoryBase.h.

Referenced by ApvTimingSummaryFactory::extract(), NoiseSummaryFactory::extract(), VpspScanSummaryFactory::extract(), OptoScanSummaryFactory::extract(), CalibrationSummaryFactory::extract(), FastFedCablingSummaryFactory::extract(), PedestalsSummaryFactory::extract(), PedsFullNoiseSummaryFactory::extract(), PedsOnlySummaryFactory::extract(), fill(), SummaryPlotFactory< FedCablingAnalysis * >::fill(), SummaryPlotFactory< CommissioningAnalysis * >::fill(), ApvTimingSummaryFactory::format(), FastFedCablingSummaryFactory::format(), init(), SummaryPlotFactory< FedCablingAnalysis * >::init(), SummaryPlotFactory< T >::init(), SummaryPlotFactory< CommissioningAnalysis * >::init(), and ~SummaryPlotFactoryBase().

sistrip::Granularity SummaryPlotFactoryBase::gran_

protected

Definition at line 32 of file SummaryPlotFactoryBase.h.

Referenced by ApvTimingSummaryFactory::extract(), VpspScanSummaryFactory::extract(), CalibrationSummaryFactory::extract(), PedsFullNoiseSummaryFactory::extract(), PedsOnlySummaryFactory::extract(), NoiseSummaryFactory::extract(), FastFedCablingSummaryFactory::extract(), PedestalsSummaryFactory::extract(), OptoScanSummaryFactory::extract(), fill(), init(), SummaryPlotFactory< FedCablingAnalysis * >::init(), and SummaryPlotFactory< T >::init().

std::string SummaryPlotFactoryBase::level_

protected

Definition at line 31 of file SummaryPlotFactoryBase.h.

Referenced by ApvTimingSummaryFactory::extract(), VpspScanSummaryFactory::extract(), CalibrationSummaryFactory::extract(), PedsFullNoiseSummaryFactory::extract(), PedsOnlySummaryFactory::extract(), NoiseSummaryFactory::extract(), FastFedCablingSummaryFactory::extract(), PedestalsSummaryFactory::extract(), OptoScanSummaryFactory::extract(), fill(), init(), SummaryPlotFactory< FedCablingAnalysis * >::init(), and SummaryPlotFactory< T >::init().

sistrip::Monitorable SummaryPlotFactoryBase::mon_

protected

Definition at line 28 of file SummaryPlotFactoryBase.h.

Referenced by ApvTimingSummaryFactory::extract(), FastFedCablingSummaryFactory::extract(), NoiseSummaryFactory::extract(), PedsOnlySummaryFactory::extract(), SamplingSummaryFactory::extract(), OptoScanSummaryFactory::extract(), VpspScanSummaryFactory::extract(), CalibrationSummaryFactory::extract(), PedestalsSummaryFactory::extract(), PedsFullNoiseSummaryFactory::extract(), fill(), SummaryPlotFactory< FedCablingAnalysis * >::fill(), FastFedCablingSummaryFactory::format(), OptoScanSummaryFactory::format(), PedestalsSummaryFactory::format(), NoiseSummaryFactory::format(), VpspScanSummaryFactory::format(), ApvTimingSummaryFactory::format(), CalibrationSummaryFactory::format(), PedsOnlySummaryFactory::format(), SamplingSummaryFactory::format(), PedsFullNoiseSummaryFactory::format(), init(), and SummaryPlotFactory< FedCablingAnalysis * >::init().

sistrip::Presentation SummaryPlotFactoryBase::pres_

protected

Definition at line 29 of file SummaryPlotFactoryBase.h.

Referenced by fill(), and init().

sistrip::View SummaryPlotFactoryBase::view_

protected

Definition at line 30 of file SummaryPlotFactoryBase.h.

Referenced by fill(), and init().