Base class for Marlin processors. More...
#include <Processor.h>
Public Member Functions | |
Processor (const std::string &typeName) | |
Possible verbosity levels. More... | |
virtual | ~Processor () |
Destructor. | |
virtual Processor * | newProcessor ()=0 |
Return a new instance of the processor. More... | |
virtual void | init () |
Called at the begin of the job before anything is read. More... | |
virtual void | processRunHeader (LCRunHeader *) |
Called for every run, e.g. More... | |
virtual void | processEvent (LCEvent *) |
Called for every event - the working horse. | |
virtual void | check (LCEvent *) |
Called for every event - right after processEvent() has been called for this processor. More... | |
virtual void | end () |
Called after data processing for clean up in the inverse order of the init() method so that resources allocated in the first processor also will be available for all following processors. | |
virtual const std::string & | type () const |
Return type name for the processor (as set in constructor). | |
virtual const std::string & | name () const |
Return name of this processor. | |
virtual const std::string & | logLevelName () const |
Return name of the local verbosity level of this processor - "" if not set. | |
virtual std::shared_ptr < StringParameters > | parameters () |
Return parameters defined for this Processor. | |
virtual void | printDescription () |
Print information about this processor in ASCII steering file format. | |
virtual void | printDescriptionXML (std::ostream &stream=std::cout) |
Print information about this processor in XML steering file format. | |
template<class T > | |
void | printParameters () |
Print the parameters and their values depending on the given verbosity level. | |
void | printParameters () |
Print the parameters and their values with verbosity level MESSAGE. | |
const std::string & | description () |
Description of processor. | |
bool | isFirstEvent () |
True if first event in processEvent(evt) - use this e.g. More... | |
std::string | getLCIOInType (const std::string &colName) |
Return the LCIO input type for the collection colName - empty string if colName is not a registered collection name. | |
std::string | getLCIOOutType (const std::string &colName) |
Return the LCIO output type for the collection colName - empty string if colName is not a registered collection name. | |
bool | isInputCollectionName (const std::string ¶meterName) |
True if the given parameter defines an LCIO input collection, i.e. More... | |
bool | isOutputCollectionName (const std::string ¶meterName) |
True if the given parameter defines an LCIO output collection. | |
virtual void | setParameters (std::shared_ptr< StringParameters > parameters) |
Helper function returns the ProcessorParameter for the given name. More... | |
virtual void | setName (const std::string &processorName) |
Set processor name. | |
Protected Member Functions | |
void | setReturnValue (bool val) |
Set the return value for this processor - typically at end of processEvent(). More... | |
void | setReturnValue (const std::string &name, bool val) |
Set a named return value for this processor - typically at end of processEvent() The value can be used in a condition in the steering file referred to by ProcessorName.name of the processor. | |
template<class T > | |
void | registerProcessorParameter (const std::string ¶meterName, const std::string ¶meterDescription, T ¶meter, const T &defaultVal, int setSize=0) |
Register a steering variable for this processor - call in constructor of processor. More... | |
void | registerInputCollection (const std::string &collectionType, const std::string ¶meterName, const std::string ¶meterDescription, std::string ¶meter, const std::string &defaultVal, int setSize=0) |
Specialization of registerProcessorParameter() for a parameter that defines an input collection - can be used fo checking the consistency of the steering file. | |
void | registerOutputCollection (const std::string &collectionType, const std::string ¶meterName, const std::string ¶meterDescription, std::string ¶meter, const std::string &defaultVal, int setSize=0) |
Specialization of registerProcessorParameter() for a parameter that defines an output collection - can be used fo checking the consistency of the steering file. | |
void | registerInputCollections (const std::string &collectionType, const std::string ¶meterName, const std::string ¶meterDescription, StringVec ¶meter, const StringVec &defaultVal, int setSize=0) |
Specialization of registerProcessorParameter() for a parameter that defines one or several input collections - can be used fo checking the consistency of the steering file. | |
template<class T > | |
void | registerOptionalParameter (const std::string ¶meterName, const std::string ¶meterDescription, T ¶meter, const T &defaultVal, int setSize=0) |
Same as registerProcessorParameter except that the parameter is optional. More... | |
bool | parameterSet (const std::string &name) |
Tests whether the parameter has been set in the steering file. | |
void | checkForExistingParameter (const std::string ¶meterName) |
Tests whether the parameter has been registered before. More... | |
template<class T > | |
void | message (const std::string &m) const |
Print message according to verbosity level of the templated parameter (one of DEBUG, MESSAGE, WARNING, ERROR ) and the global parameter "Verbosity". More... | |
template<class T > | |
void | message (const std::basic_ostream< char, std::char_traits< char > > &m) const |
Same as message(const std::string& message) except that it allows the output of more complex messages in the argument using the log() method, e.g. More... | |
std::stringstream & | log () const |
Returns an empty stringstream that is used by the message method. More... | |
Protected Attributes | |
std::string | _description ="" |
Describes what the processor does. More... | |
std::string | _typeName ="" |
std::string | _processorName ="" |
std::shared_ptr< StringParameters > | _parameters {} |
ProcParamMap | _map {} |
bool | _isFirstEvent = false |
LCIOTypeMap | _inTypeMap {} |
LCIOTypeMap | _outTypeMap {} |
std::string | _logLevelName {} |
Friends | |
class | ProcessorMgr |
class | CMProcessor |
class | XMLFixCollTypes |
Base class for Marlin processors.
Users can optionaly overwrite the following methods:
init, processRun, processEvent and end.
Use registerProcessorParameter to define all parameters that the module uses. Registered parameters are filled automatically before init() is called. With MyAplication -l you can print a list of available processors including the steering parameters they use/need.
With MyAplication -x you can print an example XML steering file for all known processors.
marlin::Processor::Processor | ( | const std::string & | typeName | ) |
Possible verbosity levels.
Global variable used to set the verbosity level Default constructor - subclasses need to call this in their default constructor.
References marlin::ProcessorMgr::instance(), registerOptionalParameter(), and marlin::ProcessorMgr::registerProcessor().
|
inlinevirtual |
Called for every event - right after processEvent() has been called for this processor.
Use to check processing and/or produce check plots.
Reimplemented in marlin::SimpleFastMCProcessor, marlin::AIDAProcessor, marlin::EventSelector, marlin::TestProcessor, MemoryMonitor, and Statusmonitor.
|
inlineprotected |
Tests whether the parameter has been registered before.
name | name of the parameter to check |
logic_error | if parameter has been registered before |
|
inlinevirtual |
Called at the begin of the job before anything is read.
Use to initialize the processor, e.g. book histograms.
Reimplemented in marlin::SimpleFastMCProcessor, marlin::LCIOOutputProcessor, marlin::ConditionsProcessor, marlin::AIDAProcessor, marlin::StdHepReader, marlin::EventSelector, marlin::TestProcessor, MemoryMonitor, and Statusmonitor.
|
inline |
True if first event in processEvent(evt) - use this e.g.
to initialize histograms etc.
Referenced by marlin::SimpleFastMCProcessor::check(), and marlin::TestProcessor::processEvent().
bool marlin::Processor::isInputCollectionName | ( | const std::string & | parameterName | ) |
True if the given parameter defines an LCIO input collection, i.e.
the type has been defined with setLCIOInType().
Referenced by getLCIOInType(), marlin::XMLFixCollTypes::parse(), and printDescriptionXML().
|
protected |
Returns an empty stringstream that is used by the message method.
|
inlineprotected |
Print message according to verbosity level of the templated parameter (one of DEBUG, MESSAGE, WARNING, ERROR ) and the global parameter "Verbosity".
If Marlin is compiled w/o debug mode ($MARLINDEBUG not set) then DEBUG messages will be ignored completely at compile time, i.e. no output (and code!) will be generated, regardless of the value of the "Verbosity" parameter. This is useful in order to save CPU time in production mode.
Every line of the output string will be prepended by the verbosity level of the message and the processor name, e.g:
[ MESSAGE "MyTestProcessor" ] processing event 42 in run 4711
Use this method for simple strings. In order to use more complex messages, including numbers, use:
|
inlineprotected |
Same as message(const std::string& message) except that it allows the output of more complex messages in the argument using the log() method, e.g.
:
message<MESSAGE>( log() << " processing event " << evt->getEventNumber() << " in run " << evt->getRunNumber() ) ;
|
pure virtual |
Return a new instance of the processor.
Has to be implemented by subclasses.
Implemented in marlin::SimpleFastMCProcessor, marlin::LCIOOutputProcessor, marlin::ConditionsProcessor, marlin::AIDAProcessor, marlin::EventSelector, marlin::StdHepReader, MemoryMonitor, marlin::TestProcessor, and Statusmonitor.
Referenced by marlin::ProcessorMgr::addActiveProcessor().
|
inlinevirtual |
Called for every run, e.g.
overwrite to initialize run dependent histograms.
Reimplemented in marlin::SimpleFastMCProcessor, marlin::LCIOOutputProcessor, marlin::AIDAProcessor, marlin::EventSelector, marlin::TestProcessor, MemoryMonitor, and Statusmonitor.
|
inlineprotected |
Same as registerProcessorParameter except that the parameter is optional.
The value of the parameter will still be set to the default value, which is used to print an example steering line. Use parameterSet() to check whether it actually has been set in the steering file.
Referenced by Processor().
|
inlineprotected |
Register a steering variable for this processor - call in constructor of processor.
The default value has to be of the same type as the parameter, e.g.
float _cut ;
...
registerProcessorParameter( "Cut", "cut...", _cut , float( 3.141592 ) ) ;
as implicit conversions don't work for templates.
The optional parameter setSize is used for formating the printout of parameters. This can be used if the parameter values are expected to come in sets of fixed size.
|
virtual |
Helper function returns the ProcessorParameter for the given name.
Initialize the parameters
References parameterSet().
Referenced by marlin::ProcessorMgr::addActiveProcessor().
|
protected |
Set the return value for this processor - typically at end of processEvent().
The value can be used in a condition in the steering file referred to by the name of the processor.
References marlin::ProcessorMgr::instance(), and marlin::ProcessorMgr::setProcessorReturnValue().
Referenced by marlin::TestProcessor::processEvent(), and marlin::EventSelector::processEvent().
|
protected |
Describes what the processor does.
Set in constructor.