CSPadPixCoords::SaveImageInFile Class Reference
[CSPadPixCoords package]

SaveImageInFile is a test/example module for psana framework. More...

#include <SaveImageInFile.h>

List of all members.

Public Member Functions

 SaveImageInFile (const std::string &name)
virtual ~SaveImageInFile ()
virtual void beginJob (Event &evt, Env &env)
 Method which is called once at the beginning of the job.
virtual void beginRun (Event &evt, Env &env)
 Method which is called at the beginning of the run.
virtual void beginCalibCycle (Event &evt, Env &env)
 Method which is called at the beginning of the calibration cycle.
virtual void event (Event &evt, Env &env)
virtual void endCalibCycle (Event &evt, Env &env)
 Method which is called at the end of the calibration cycle.
virtual void endRun (Event &evt, Env &env)
 Method which is called at the end of the run.
virtual void endJob (Event &evt, Env &env)
 Method which is called once at the end of the job.
std::string strTimeStamp (Event &evt)
std::string strRunNumber (Event &evt)
std::string strEventCounter ()
void saveImageInFile (Event &evt)
void printInputParameters ()
 Print input parameters.


Detailed Description

SaveImageInFile is a test/example module for psana framework.

SaveImageInFile psana module class works after CSPadImageProducer. It gets the Image2D object from the event. This image object may be used in data processing. For the test purpose, the image of particular event is saved in the text file. This event number is defined in the psana.cfg configuration file.

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

See also:
CSPadImageProducer
Version:
$Id: SaveImageInFile.h 8040 2014-04-19 01:00:36Z dubrovin@SLAC.STANFORD.EDU $
Author:
Mikhail S. Dubrovin

Definition at line 62 of file SaveImageInFile.h.


Constructor & Destructor Documentation

CSPadPixCoords::SaveImageInFile::SaveImageInFile ( const std::string &  name  ) 

Definition at line 53 of file SaveImageInFile.cpp.

CSPadPixCoords::SaveImageInFile::~SaveImageInFile (  )  [virtual]

Definition at line 76 of file SaveImageInFile.cpp.


Member Function Documentation

void CSPadPixCoords::SaveImageInFile::beginCalibCycle ( Event &  evt,
Env &  env 
) [virtual]

Method which is called at the beginning of the calibration cycle.

Definition at line 103 of file SaveImageInFile.cpp.

void CSPadPixCoords::SaveImageInFile::beginJob ( Event &  evt,
Env &  env 
) [virtual]

Method which is called once at the beginning of the job.

Definition at line 86 of file SaveImageInFile.cpp.

References printInputParameters().

void CSPadPixCoords::SaveImageInFile::beginRun ( Event &  evt,
Env &  env 
) [virtual]

Method which is called at the beginning of the run.

Definition at line 95 of file SaveImageInFile.cpp.

void CSPadPixCoords::SaveImageInFile::endCalibCycle ( Event &  evt,
Env &  env 
) [virtual]

Method which is called at the end of the calibration cycle.

Definition at line 125 of file SaveImageInFile.cpp.

void CSPadPixCoords::SaveImageInFile::endJob ( Event &  evt,
Env &  env 
) [virtual]

Method which is called once at the end of the job.

Definition at line 141 of file SaveImageInFile.cpp.

void CSPadPixCoords::SaveImageInFile::endRun ( Event &  evt,
Env &  env 
) [virtual]

Method which is called at the end of the run.

Definition at line 133 of file SaveImageInFile.cpp.

void CSPadPixCoords::SaveImageInFile::event ( Event &  evt,
Env &  env 
) [virtual]

Method which is called with event data, this is the only required method, all other methods are optional

Definition at line 112 of file SaveImageInFile.cpp.

References saveImageInFile().

void CSPadPixCoords::SaveImageInFile::printInputParameters (  ) 

Print input parameters.

Definition at line 227 of file SaveImageInFile.cpp.

Referenced by beginJob().

void CSPadPixCoords::SaveImageInFile::saveImageInFile ( Event &  evt  ) 

Definition at line 193 of file SaveImageInFile.cpp.

References strRunNumber(), and strTimeStamp().

Referenced by event().

std::string CSPadPixCoords::SaveImageInFile::strEventCounter (  ) 

Definition at line 184 of file SaveImageInFile.cpp.

std::string CSPadPixCoords::SaveImageInFile::strRunNumber ( Event &  evt  ) 

Definition at line 170 of file SaveImageInFile.cpp.

Referenced by saveImageInFile().

std::string CSPadPixCoords::SaveImageInFile::strTimeStamp ( Event &  evt  ) 

Definition at line 151 of file SaveImageInFile.cpp.

Referenced by saveImageInFile().


The documentation for this class was generated from the following files:
Generated on 19 Dec 2016 for PSANAmodules by  doxygen 1.4.7