Processor to match object table with sky catalog. More...

#include <MatchSkyCatalog.h>

Inheritance diagram for luiza::MatchSkyCatalog:

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

virtual void	init ()

virtual void	startAnalysis (GloriaDataContainer *data)
	Called before first data loop. More...

virtual void	processData (GloriaDataContainer *data)

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

virtual void	concludeAnalysis (GloriaDataContainer *data)
	Called after all data processing loops to finalize the analysis.

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 Member Functions
void	printEndMessage () const

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...

Protected Attributes
string	_inputCollectionName
	Name of the collection containing object lists.

string	_skyCatalogName
	Name of the collection containing sky catalog to be matched.

string	_outputCollectionName
	Name of the output collection (for modified object list)

double	_matchingTolerance
	Position matching tolerance for object and reference stars.

std::vector< std::string >	_positionColumns
	Names of the position columns in the object table.

bool	_permanentCollection
	Flag the output collection to be permanent.

std::vector< std::string >	_copyColumns
	Names of catalog columns to be copied in the output object table.

std::vector< std::string >	_newColumnNames
	New column names, for columns copied from the catalog.

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

Detailed Description

Processor to match object table with sky catalog.

This processor matches objects in the table of the input collection with sky objects stored in catalog table (gloria::GloriaSkyCatalog), based on their coordinates on the sky (RA and DEC from astrometry). Selected entries (columns) from the catalog can also be copied into the object table (for matched entries). Matched catalog brightness can be then used eg. for image calibration.

Input: Processor reads object lists and catalog from input collections

Parameters

InputCollectionName	- Name of the collection containing object list with RA and DEC positions reconstructed (eg. after astrometry)
SkyCatalogName	- Name of the collection containing GloriaSkyCatalog

Algorithm parameters: User has to specify matching tolerance.

Parameters

MatchingTolerance	Tolerance for object position matching, given in degrees
PositionColumns	Names of the object table columns from which object position should be taken. These are 'RA' and 'DEC' by default (default column names for Luiza astrometry processor), but can be changed by user.

Output: Object list is stored in the output table

Parameters

OutputCollectionName	Name of the collection where the resulting objects table should be stored. If missing, input collection table will be modified.
PermanentCollection	Flag output collection, as permanent, not deleted after loop is finished (default is false)
CopyColumns	Names of the columns in the catalog, which should be copied to the output table
NewColumnNames	Names which should be used for copied columns. This allows user to avoid conflicts of column names between two tables. If missing, same column name will be used for a copied column.

Member Function Documentation

void luiza::MatchSkyCatalog::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::MatchSkyCatalog::end ( )

virtual

Called after data processing for clean up.

Reimplemented from luiza::Processor.

References printEndMessage().

void luiza::MatchSkyCatalog::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 _copyColumns, _inputCollectionName, _newColumnNames, _outputCollectionName, _skyCatalogName, luiza::Processor::name(), and luiza::Processor::parameters().

virtual Processor* luiza::MatchSkyCatalog::newProcessor ( )

inlinevirtual

Return a new instance of the processor.

Has to be implemented by subclasses.

Implements luiza::Processor.

void luiza::MatchSkyCatalog::printEndMessage ( ) const

protected

Test method for const.

Referenced by end().

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

virtual

Called for every data loop

Reimplemented from luiza::Processor.

References _copyColumns, _inputCollectionName, _matchingTolerance, _newColumnNames, _outputCollectionName, _permanentCollection, _positionColumns, _skyCatalogName, gloria::GloriaFitsTable::ColumnExists(), gloria::GloriaDataContainer::CreateTableCollection(), gloria::GloriaSkyCatalog::GetObjectNumber(), gloria::GloriaDataContainer::GetTableCollection(), gloria::GloriaFitsTable::IsSortedBy(), gloria::GloriaSkyCatalog::MatchObjectTable(), luiza::Processor::setReturnValue(), gloria::GloriaFitsTable::SortTable(), gloria::GloriaDataContainer::TableCollectionExists(), and gloria::GloriaDataContainer::TableCollectionPermanent().

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

virtual

Called before first data loop.

Can be used to create permanent data structures, if needed.

Reimplemented from luiza::Processor.

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

MatchSkyCatalog.h
MatchSkyCatalog.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation