Processor for writing tables to output TEXT files. More...

#include <TableTextWriter.h>

Inheritance diagram for luiza::TableTextWriter:

Public Member Functions
virtual TableTextWriter *	newProcessor ()
	Return a new instance of the processor. More...

virtual void	init ()

virtual void	startAnalysis (GloriaDataContainer *data)

virtual void	processData (GloriaDataContainer *data)

virtual void	check (GloriaDataContainer *data)
	Called for every loop - right after processData() call. More...

virtual void	concludeAnalysis (GloriaDataContainer *data)

virtual void	end ()

Public Member Functions inherited from luiza::Processor
	Processor (const std::string &typeName)
	Default constructor. More...

virtual	~Processor ()
	Destructor.

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 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. to initialize histograms etc.

GloriaCollectionType	getGloriaInType (const std::string &colName)
	Return the input type for the collection colName. More...

GloriaCollectionType	getGloriaOutType (const std::string &colName)
	Return the output type for the collection colName. More...

bool	isInputCollectionName (const std::string &parameterName)
	Check if parameter defines collection. More...

bool	isOutputCollectionName (const std::string &parameterName)
	True if the given parameter defines an LCIO output collection */.

Protected Attributes
string	_tableCollectionName
	Name of the table collection which should be stored.

string	_textFileNameRoot
	Output file name root.

bool	_oneFile
	Flag for output to single file.

bool	_addCounter
	Flag for output to single file.

std::vector< std::string >	_selectedColumns
	Table columns to be stored.

std::vector< std::string >	_headerRecords
	Header records to be stored.

GloriaFitsTable *	_outputTable
	Temporary table to prepare text output.

ofstream	_outputStream
	Output file pointer.

int	_nLoops
	Loop counter.

int	_nTables
	Table counter, used to number file name.

int	_nWritten
	Counter for images successfully written to file.

Protected Attributes inherited from luiza::Processor
std::string	_description
	Describes what the processor does. Set in constructor.

Additional Inherited Members
Protected Member Functions inherited from luiza::Processor
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() More...

template<class T >
void	registerProcessorParameter (const std::string &name, const std::string &description, T &parameter, const T &defaultVal, int setSize=0)
	Register a steering variable for this processor - call in constructor of processor. More...

void	registerInputCollection (const GloriaCollectionType &type, const std::string &name, const std::string &description, std::string &parameter, const std::string &defaultVal, int setSize=0)
	Register parameter describing input collection. More...

void	registerOutputCollection (const GloriaCollectionType &type, const std::string &name, const std::string &description, std::string &parameter, const std::string &defaultVal, int setSize=0)
	Register parameter describing output collection. More...

void	registerInputCollections (const GloriaCollectionType &type, const std::string &name, const std::string &description, StringVec &parameter, const StringVec &defaultVal, int setSize=0)
	Register parameter describing input collections. More...

template<class T >
void	registerOptionalParameter (const std::string &name, const std::string &description, T &parameter, 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.

template<class T >
void	message (const std::string &message) const
	Print message according to verbosity level. More...

template<class T >
void	message (const std::basic_ostream< char, std::char_traits< char > > &m) const
	Similar to message(const std::string& message) More...

std::stringstream &	log () const
	Returns an empty stringstream that is used by the message method.

virtual void	setProcessorParameters (StringParameters *parameters)
	Allow friend class CCProcessor to change/reset processor parameters.

virtual void	updateParameters ()
	Allow friend class CCProcessor to update processor parameters.

virtual void	updateTelescopeParameters (std::string name)
	Allow to update processor parameters for given telescope name. More...

virtual void	updateTelescopeParameters (GloriaFitsHeader *header)
	Update processor parameters based on FITS header. More...

Detailed Description

Processor for writing tables to output TEXT files.

This processor writes tables to output file in the plain text format

Input: Tables are taken from the data collection. User has to specify in the steering file:

Parameters

TableCollectionName - Name of the table collection which should be stored to file(s)

Output: GloriaFitsTables from given collection are stored as TEXT files. Output file names consist of file name root, table number (starting from 1) and .tbl extension. Tables are stored at each loop unless the collection is permanent - then they are stored only at concludeAnalysis() call. User can also choose to write all tables in the collection to one big file.

Parameters

TextFileNameRoot	- Output file name root, which will be appended by the table number and extension
OneFile	- flag to force storing all tables in one big file
SelectedColumns	- names of columns to be stored in the file. If not specified (empty list) all columns are written.
AddCounter	- flag to add row number as the first column in the output file. If OneFile option is used, table number is also added.
HeaderRecords	- list of FITS header fields to be added to the table.

Author: A.F. Zarnecki, University of Warsaw

Member Function Documentation

void luiza::TableTextWriter::check ( GloriaDataContainer * )

virtual

Called for every loop - right after processData() call.

Can be used to check processing and/or produce check plots.

Reimplemented from luiza::Processor.

void luiza::TableTextWriter::concludeAnalysis ( GloriaDataContainer * data )

virtual

Called after all data loops to conclude analysis

Reimplemented from luiza::Processor.

Referenced by processData().

void luiza::TableTextWriter::end ( )

virtual

Called after data processing for clean up.

Reimplemented from luiza::Processor.

References _oneFile, and _outputStream.

void luiza::TableTextWriter::init ( )

virtual

Called at the begin of the job before anything is read. Use to initialize the processor, e.g. book histograms.

Reimplemented from luiza::Processor.

References _nLoops, _nTables, _nWritten, _outputTable, luiza::Processor::name(), and luiza::Processor::parameters().

TableTextWriter * luiza::TableTextWriter::newProcessor ( )

virtual

Return a new instance of the processor.

Has to be implemented by subclasses.

Implements luiza::Processor.

void luiza::TableTextWriter::processData ( GloriaDataContainer * data )

virtual

Called for every data collection

Reimplemented from luiza::Processor.

References _nLoops, _tableCollectionName, and concludeAnalysis().

void luiza::TableTextWriter::startAnalysis ( GloriaDataContainer * data )

virtual

Called for before first data loop

Reimplemented from luiza::Processor.

References _oneFile, _outputStream, and _textFileNameRoot.

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

TableTextWriter.h
TableTextWriter.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation