Base class for all event processing components. More...

#include <Processor.h>

Inheritance diagram for Processor:

Public Member Functions
	Processor (const std::string &name, Process &process)
	Class constructor.

virtual	~Processor ()

virtual void	configure (const ParameterSet &parameters)
	Callback for the Processor to configure itself from the given set of parameters.

virtual void	initialize (TTree *tree)=0
	Callback for the Processor to take any necessary action when the processing of events starts, such as creating histograms.

virtual void	initialize (std::string inFilename, std::string outFilename)
	Callback for the Processor to take any necessary action when the processing of events starts, such as initializing files.

virtual void	setFile (TFile *outFile)
	Set output TFile for AnaProcessors.

virtual bool	process ()
	Process the histograms and generate analysis output.

virtual bool	process (IEvent *ievent)=0
	Process the event and put new data products into it.

virtual void	finalize ()=0
	Callback for the Processor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.

Static Public Member Functions
static void	declare (const std::string &classname, ProcessorMaker *)
	Internal function which is part of the ProcessorFactory machinery.

Protected Attributes
Process &	process_

TFile *	outF_ {nullptr}

std::string	name_

Detailed Description

Base class for all event processing components.

Definition at line 34 of file Processor.h.

Constructor & Destructor Documentation

◆ Processor()

Processor	(	const std::string &	name,
		Process &	process
	)

Class constructor.

Parameters

name	Name for this instance of the class.
process	The Process class associated with Processor, provided by the framework.

Note: The name provided to this function should not be the class name, but rather a logical label for this instance of the class, as more than one copy of a given class can be loaded into a Process with different parameters. Names should not include whitespace or special characters.

Definition at line 10 of file Processor.cxx.

◆ ~Processor()

virtual ~Processor ( )

inlinevirtual

Class destructor.

Definition at line 54 of file Processor.h.

Member Function Documentation

◆ configure()

virtual void configure ( const ParameterSet & parameters )

inlinevirtual

Callback for the Processor to configure itself from the given set of parameters.

Parameters

parameters ParameterSet for configuration.

Reimplemented in Apv25RoXtalkAnaProcessor, BhMassResSystematicsProcessor, BhToysHistoProcessor, ClusterOnTrackAnaProcessor, ECalDataProcessor, EventProcessor, FinalStateParticleProcessor, HodoDataProcessor, MCAnaProcessor, MCEcalHitProcessor, MCParticleProcessor, MCTrackerHitProcessor, NewVertexAnaProcessor, NTupplizer, RecoHitAnaProcessor, RefittedTracksProcessor, SimpZBiOptimizationProcessor, StdhepMCParticleProcessor, SvtBl2DAnaProcessor, SvtBlFitHistoProcessor, SvtRawDataAnaProcessor, SvtRawDataProcessor, TrackEfficiencyProcessor, Tracker2DHitProcessor, Tracker3DHitProcessor, TrackHitAnaProcessor, TrackingAnaProcessor, TrackingProcessor, TridentAnaProcessor, TridentWABAnaProcessor, VertexAnaProcessor, VertexProcessor, and VtxHistoProcessor.

Definition at line 61 of file Processor.h.

◆ declare()

void declare	(	const std::string &	classname,
		ProcessorMaker *	maker
	)

static

Internal function which is part of the ProcessorFactory machinery.

Parameters

classname	The class name of the processor.
classtype	The class type of the processor (1 for Producer, 2 for Analyzer).

Definition at line 14 of file Processor.cxx.

◆ finalize()

virtual void finalize ( )

pure virtual

Callback for the Processor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.

Implemented in Apv25RoXtalkAnaProcessor, BhMassResSystematicsProcessor, BhToysHistoProcessor, ClusterOnTrackAnaProcessor, ECalDataProcessor, EventProcessor, FinalStateParticleProcessor, HodoDataProcessor, HPSEventProcessor, MCAnaProcessor, MCEcalHitProcessor, MCParticleProcessor, MCTrackerHitProcessor, NewVertexAnaProcessor, NTupplizer, RecoHitAnaProcessor, RefittedTracksProcessor, SimpZBiOptimizationProcessor, StdhepMCParticleProcessor, SvtBl2DAnaProcessor, SvtBlFitHistoProcessor, SvtDataProcessor, SvtRawDataAnaProcessor, SvtRawDataProcessor, TrackEfficiencyProcessor, Tracker2DHitProcessor, Tracker3DHitProcessor, TrackHitAnaProcessor, TrackingAnaProcessor, TrackingProcessor, TridentAnaProcessor, TridentWABAnaProcessor, VertexAnaProcessor, VertexProcessor, and VtxHistoProcessor.

◆ initialize() [1/2]

virtual void initialize	(	std::string	inFilename,
		std::string	outFilename
	)

inlinevirtual

Callback for the Processor to take any necessary action when the processing of events starts, such as initializing files.

Parameters

inFilename
outFilename

Reimplemented in BhMassResSystematicsProcessor, BhToysHistoProcessor, SimpZBiOptimizationProcessor, StdhepMCParticleProcessor, SvtBlFitHistoProcessor, and VtxHistoProcessor.

Definition at line 81 of file Processor.h.

◆ initialize() [2/2]

virtual void initialize ( TTree * tree )

pure virtual

Callback for the Processor to take any necessary action when the processing of events starts, such as creating histograms.

Parameters

tree

Implemented in Apv25RoXtalkAnaProcessor, BhMassResSystematicsProcessor, BhToysHistoProcessor, ClusterOnTrackAnaProcessor, ECalDataProcessor, EventProcessor, FinalStateParticleProcessor, HodoDataProcessor, HPSEventProcessor, MCAnaProcessor, MCEcalHitProcessor, MCParticleProcessor, MCTrackerHitProcessor, NewVertexAnaProcessor, NTupplizer, RecoHitAnaProcessor, RefittedTracksProcessor, SimpZBiOptimizationProcessor, StdhepMCParticleProcessor, SvtBl2DAnaProcessor, SvtBlFitHistoProcessor, SvtDataProcessor, SvtRawDataAnaProcessor, SvtRawDataProcessor, TrackEfficiencyProcessor, Tracker2DHitProcessor, Tracker3DHitProcessor, TrackHitAnaProcessor, TrackingAnaProcessor, TrackingProcessor, TridentAnaProcessor, TridentWABAnaProcessor, VertexAnaProcessor, VertexProcessor, and VtxHistoProcessor.

◆ process() [1/2]

virtual bool process ( )

inlinevirtual

Process the histograms and generate analysis output.

Returns: status of the processing.

Reimplemented in BhMassResSystematicsProcessor, BhToysHistoProcessor, SimpZBiOptimizationProcessor, StdhepMCParticleProcessor, SvtBlFitHistoProcessor, and VtxHistoProcessor.

Definition at line 95 of file Processor.h.

◆ process() [2/2]

virtual bool process ( IEvent * ievent )

pure virtual

Process the event and put new data products into it.

Parameters

event The Event to process.

Returns: status of the processing, false will move to next event and skip other processes.

Implemented in BhMassResSystematicsProcessor, BhToysHistoProcessor, ECalDataProcessor, HodoDataProcessor, SimpZBiOptimizationProcessor, StdhepMCParticleProcessor, SvtBlFitHistoProcessor, VtxHistoProcessor, Apv25RoXtalkAnaProcessor, ClusterOnTrackAnaProcessor, EventProcessor, FinalStateParticleProcessor, HPSEventProcessor, MCAnaProcessor, MCEcalHitProcessor, MCParticleProcessor, MCTrackerHitProcessor, NewVertexAnaProcessor, NTupplizer, RecoHitAnaProcessor, RefittedTracksProcessor, SvtBl2DAnaProcessor, SvtDataProcessor, SvtRawDataAnaProcessor, SvtRawDataProcessor, TrackEfficiencyProcessor, Tracker2DHitProcessor, Tracker3DHitProcessor, TrackHitAnaProcessor, TrackingAnaProcessor, TrackingProcessor, TridentAnaProcessor, TridentWABAnaProcessor, VertexAnaProcessor, and VertexProcessor.

◆ setFile()

virtual void setFile ( TFile * outFile )

inlinevirtual

Set output TFile for AnaProcessors.

Parameters

pointer to output TFile

Definition at line 88 of file Processor.h.

Member Data Documentation

◆ name_

std::string name_

protected

The name of the Processor.

Definition at line 128 of file Processor.h.

◆ outF_

TFile* outF_ {nullptr}

protected

output file pointer

Definition at line 125 of file Processor.h.

◆ process_

Process& process_

protected

Handle to the Process.

Definition at line 122 of file Processor.h.

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

processing/include/Processor.h
processing/src/Processor.cxx

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Processor()

◆ ~Processor()

Member Function Documentation

◆ configure()

◆ declare()

◆ finalize()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ process() [1/2]

◆ process() [2/2]

◆ setFile()

Member Data Documentation

◆ name_

◆ outF_

◆ process_