#include <AnalysisAlgorithm.hxx>

Inheritance diagram for AnalysisAlgorithm:

Public Types
enum	enumAnalysisPoint { kInitialize =0, kDefineProductions, kDefineInputConverters, kDefineSelections, kDefineCorrections, kDefineSystematics, kDefineConfigurations, kDefineMicroTrees, kDefineTruthTree, kFillConfigTree, kInitializeSpill, kInitializeBunch, kInitializeConfiguration, kInitializeToy, kInitializeSelection, kFinalizeSelection, kFinalizeToy, kFillToyVarsInMicroTrees, kFinalizeConfiguration, kFillCategories, kFillMicroTrees, kFinalizeBunch, kFillTruthTree, kFinalizeSpill, kFinalize }

enum	enumStandardMicroTrees_AnalysisAlgorithm { firstCategory = OutputManager::enumStandardMicroTreesLast_OutputManager+1, firstCategoryCounter = firstCategory+NMAXCATEG, entry = firstCategoryCounter + NMAXCATEGCOUNTERS, toy_ref, toy_index, toy_par_weight, toy_par_var, NWEIGHTSYST, weight_syst, weight_syst_total, weight_corr, weight_corr_total, redo, accum_level, first_cut, last_cut =first_cut+NMAXSTEPS, enumStandardMicroTreesLast_AnalysisAlgorithm }

enum	enumConfigTree_AnalysisAlgorithm { SoftwareVersion =0, HOSTNAME, CMTPATH, INPUTFILE, OriginalFile, MinAccumLevelToSave, enumConfigTreeLast_AnalysisAlgorithm }

Public Member Functions
	AnalysisAlgorithm (AnalysisAlgorithm *ana=NULL)

virtual void	Finalize ()
	[AnalysisAlgorithm_optional]

virtual bool	InitializeSpill ()

virtual void	FinalizeSpill ()

virtual void	InitializeBunch ()

virtual void	FinalizeBunch ()

virtual void	InitializeConfiguration ()

virtual bool	FinalizeConfiguration ()

virtual void	InitializeToy ()

virtual void	FinalizeToy ()

virtual void	InitializeSelection (const SelectionBase &)

virtual void	FinalizeSelection (const SelectionBase &)

virtual void	FillCategories ()

virtual void	FillConfigTree ()

virtual AnaEventC *	MakeEvent ()=0
	[AnalysisAlgorithm_optional] More...

virtual bool	Initialize ()=0
	[AnalysisAlgorithm_mandatory]

virtual void	DefineProductions ()=0

virtual void	DefineInputConverters ()=0

virtual void	DefineSelections ()=0

virtual void	DefineCorrections ()=0

virtual void	DefineSystematics ()=0

virtual void	DefineConfigurations ()=0

virtual void	DefineMicroTrees (bool addBase=true)=0

virtual void	DefineTruthTree ()=0

virtual void	FillMicroTrees (bool addBase=true)=0

virtual void	FillToyVarsInMicroTrees (bool addBase=true)=0

virtual void	FillTruthTree ()=0

void	FinalizeToyBase ()
	[AnalysisAlgorithm_mandatory] More...

void	SetFillSuccessOnly (bool fill)
	Fill trees and process weight systematics only when any of the branches is successful.

bool	GetFillSuccessOnly ()

void	SetInitializeTrees (bool ini)
	Initialize trees at the beginning of each configuration.

bool	GetInitializeTrees ()

void	SetMinAccumCutLevelToSave (Int_t level)
	Set the minimum accumulated cut level to save an event into the micro-tree.

Int_t	GetMinAccumCutLevelToSave ()
	Get the minimum accumulated cut level to save an event into the micro-tree.

bool	CheckAccumLevelToSave ()
	Check if the condition is fulfilled for at least one branch.

void	SetEvent (AnaEventC *event)
	Set the current event into the algorithm and all used algorithms.

void	SetToyBox (const ToyBoxB *box, Int_t isel=0)
	Set the current box into the algorithm and all used algorithms. This is useful when one Analysis uses another.

void	UseAnalysis (AnalysisAlgorithm *ana)
	Used a given analysis.

void	SetSelectedSelection (Int_t sel)
	Select one of the selections.

void	SetVersionCheck (bool check)
	Set version checking.

void	SetAnalysisPoint (enumAnalysisPoint point)
	Set the point of the analysis at which AnalysisLoop is.

HighlandInputManager &	input ()

SelectionManager &	sel ()

CorrectionManager &	corr ()

SystematicManager &	syst ()

EventWeightManager &	eweight ()

EventVariationManager &	evar ()

OutputManager &	output ()

ConfigurationManager &	conf ()

CategoryManager &	cat ()

DocStringManager &	doc ()

virtual const ToyBoxB &	boxB (Int_t isel=-1) const

Protected Attributes
HighlandInputManager *	_inputManager
	Input Manager: access to the current Event.

CorrectionManager *	_corrManager
	Correction Manager.

SystematicManager *	_systManager
	Systematics Manager.

EventWeightManager *	_weightManager
	EventWeight Manager.

EventVariationManager *	_variationManager
	EventVariation Manager.

OutputManager *	_outputManager
	Output Manager.

ConfigurationManager *	_confManager
	Configuration Manager.

SelectionManager *	_selManager

CategoryManager *	_categManager

DocStringManager *	_docManager

const ToyBoxB *	_box [NMAXSELECTIONS]
	The analysis box.

Int_t	_min_accum_cut_level
	the minimum accumulated cut level to save an event into the micro-tree

bool	_fillSuccessOnly
	Fill trees and process weight systematics only when any of the branches is succesful.

bool	_initializeTrees
	Initialize trees at the beginning of each configuration.

AnaEventC *	_event
	The current event.

std::vector< AnalysisAlgorithm * >	_usedAnalyses
	The Vector of used analysis.

Int_t	_selectedSelection
	The selected selection.

bool	_setMethodCalled
	Boolean parameter to know whether nny of the methods that sets things into used analysis has been called.

bool	_versionCheck

enumAnalysisPoint	_analysisPoint

Detailed Description

This class provides a base for user analyses. It handles many common functions, and provides a structure so that users don't have to write too much "boiler-plate" code.

User analyses should inherit from this class.

Definition at line 22 of file AnalysisAlgorithm.hxx.

Constructor & Destructor Documentation

§ AnalysisAlgorithm()

AnalysisAlgorithm::AnalysisAlgorithm ( AnalysisAlgorithm * ana = NULL )

Constructor, which instantiates the necessary converters for converting input files to the AnaSpill format.

Boolean parameter to know whether nny of the methods that sets things into used analysis has been called

Version check enabled by default

Definition at line 7 of file AnalysisAlgorithm.cxx.

                                                           {
 //********************************************************************
   
   if (ana){
     _inputManager     = &(ana->input());
     _selManager       = &(ana->sel());
     _corrManager      = &(ana->corr());
     _systManager      = &(ana->syst());
     _weightManager    = &(ana->eweight());
     _variationManager = &(ana->evar());
     _outputManager    = &(ana->output());
     _confManager      = &(ana->conf()); 
     _categManager     = &(ana->cat()); 
     _docManager       = &(ana->doc()); 
   }
   else{
     _inputManager     = new HighlandInputManager();
     _selManager       = new SelectionManager();
     _corrManager      = new CorrectionManager();
     _systManager      = new SystematicManager();
     _weightManager    = new EventWeightManager();
     _variationManager = new EventVariationManager();
     _outputManager    = new OutputManager();
     _confManager      = new ConfigurationManager();
     _categManager     = new CategoryManager();
     _docManager       = new DocStringManager();
   }
 
   _outputManager->SetDocStringManager(_docManager);
 
   anaUtils::_categ = &cat();
 
   for (UInt_t i=0;i<NMAXSELECTIONS;i++)
     _box[i] = NULL;
 
   _selectedSelection=0;
 
   // Minimum cut level to save the event. By default save everything
   _min_accum_cut_level = 0;
 
   // By default save events that don't pass the selection 
   _fillSuccessOnly=false;
 
   // By default initialize micro-trees at the beginning of each configuration
   _initializeTrees=true;
 
   /// Boolean parameter to know whether nny of the methods that sets things into used analysis has been called
   _setMethodCalled=false; 
 
 
   /// Version check enabled by default
   _versionCheck = true;
 }

Member Function Documentation

§ FinalizeToyBase()

void AnalysisAlgorithm::FinalizeToyBase ( )

[AnalysisAlgorithm_mandatory]

Finalize toy

Definition at line 184 of file AnalysisAlgorithm.cxx.

                                        {
 //********************************************************************
 
   // This method Sets the appropriate ToyBox to be used when filling the Micro-trees.
   // If any of the selections is succesfull chose the first found 
   // If not chose the one with higher accum_level
 
   static bool first = true;
 
   Int_t maxAccumLevel=-1;
   bool found=false;
 
   for (std::vector<SelectionBase*>::iterator it=sel().GetSelections().begin();it!=sel().GetSelections().end();it++){
     SelectionBase* selec = *it;
     if (!selec->IsEnabled()) continue;
 
     Int_t isel = selec->GetEnabledIndex();
 
     // Get the ToyBox of the previous Toy
     const ToyBoxB& box = selec->GetPreviousToyBox();
     
     if (first){  
       // Set the box into this and all used algorithms. Only the first time since the Box is always the same for a given selection
       SetToyBox(&box,isel);
     }
 
     if (!found){
       if (box.SuccessfulBranch>-1){
         SetSelectedSelection(isel);
         found=true;
       }
       else if (selec->GetMaxAccumCutLevel()> maxAccumLevel){ 
         SetSelectedSelection(isel);
         maxAccumLevel = selec->GetMaxAccumCutLevel();
       }
     }
     else if (box.SuccessfulBranch>-1){
       std::cout << "AnalysisAlgorithm::FinalizeToyBase(). Selections are not mutually exclusive !!! Run/Subrun/Event/Bunch " 
                 << _event->GetEventInfoString()  
                 << " passing selection '" << selec->Name() << ", was also successfull in selection '" << sel().GetSelection(_selectedSelection)->Name() << "'." 
                 << " Results for first selection being passed will be saved in micro-trees for this event. " << std::endl;        
       if (!_allowNonExclusiveSelections){ 
         std::cout << "Non exclusive selections are in general problematic. THE PROGRAM WILL STOP NOW !!!!" << std::endl;
         std::cout << "Set '_allowNonExclusiveSelections=true' at the begining of highlandTools/vXrY/src/AnalysisAlgorithm.cxx to allow non-exclusive selections" << std::endl;
         exit(1);
       }
     }
 
   }
   first = false;
 }

§ MakeEvent()

virtual AnaEventC* AnalysisAlgorithm::MakeEvent ( )

pure virtual

[AnalysisAlgorithm_optional]

Create the appropriate event time from an Spill and a Bunch in that spill

Implemented in baseAnalysis, and p0dExampleAnalysis.

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

/hep/T2K/nd280rep/ANALYSIS/HIGHLAND2/ANAPARTICLE/highland2/highlandCore/v2r10/src/AnalysisAlgorithm.hxx
/hep/T2K/nd280rep/ANALYSIS/HIGHLAND2/ANAPARTICLE/highland2/highlandCore/v2r10/src/AnalysisAlgorithm.cxx

Public Types