Processor for reading input FITS images. More...

#include <FitsImageReader.h>

Inheritance diagram for luiza::FitsImageReader:

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

virtual void	init ()

virtual void	processData (GloriaDataContainer *data)

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

virtual void	end ()

Public Member Functions inherited from luiza::DataSourceProcessor
bool	OpenDataSource ()

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

virtual	~Processor ()
	Destructor.

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

virtual void	concludeAnalysis (GloriaDataContainer *)
	Called after all data processing loops. More...

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
std::vector< std::string >	_fitsFileList
	List of FITS files to be read.

std::vector< std::string >	_listFileList
	Names of files containing FITS file lists (one per line) - alternative method.

std::string	_imageCollectionName
	Name of the image collection to which images from file should be stored.

bool	_permanentCollection
	Flag for collections, which should not be deleted after loop is finished.

int	_imagesPerLoop
	Number of images to be read per processing loop (0 for all)

int	_nLoops
	Loop counter.

int	_nImages
	Image counter.

int	_nFiles
	File counter.

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

Detailed Description

Processor for reading input FITS images.

This processor reads FITS images from given files. It is usually the first processor in the analysis chain. Multiple instances can be used (under different names) to allow reading sky images as well as dark, bias or flat frames.

Input: Names of input FIT files can be given in two ways: directly, or by specifying names of list files (i.e. files containing image file names, one per line).

Parameters

FitsFileList	List of FITS files to be read
ListFileList	Names of files containing FITS file lists (one per line)
ImagesPerLoop	Number of images to be read in each processor call. Default is one. If zero value is set, all images from the list are read at the first call (!)

Output: Images read as gloria::GloriaFitsImage are added to specified image collection (named image vector) and put into global gloria::GloriaDataContainer

Parameters

ImageCollectionName	Name of the created GloriaImageCollection (default is "FitsImages");
PermanentCollection	Flag indicating that created collection should be kept in memory for the whole processing time. This is needed in case of eg. calibration frames (darks, flats) or collections containing analysis results. Default is false