CSPadPixCoords::CSPadNDArrProducer

CSPadPixCoords::CSPadNDArrProducer Class Reference
[CSPadPixCoords package]

CSPadNDArrProducer produces the CSPad data ndarray<T,3> array for each event and add it to the event in psana framework. More...

#include <CSPadNDArrProducer.h>

List of all members.

Public Types

typedef CSPadPixCoords::CSPadConfigPars CONFIG

Public Member Functions

 CSPadNDArrProducer (const std::string &name)
virtual ~CSPadNDArrProducer ()
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.

Static Public Attributes

static const uint32_t NQuadsMax = 4
static const uint32_t N2x1 = 8
static const uint32_t NRows2x1 = 185
static const uint32_t NCols2x1 = 388
static const uint32_t SizeOf2x1Arr = NRows2x1 * NCols2x1

Protected Member Functions

void printInputParameters ()
 Print input parameters.
void procEvent (Event &evt, Env &env)
void checkTypeImplementation ()

Detailed Description

CSPadNDArrProducer produces the CSPad data ndarray<T,3> array for each event and add it to the event in psana framework.

1) get cspad configuration and data from the event, 2) produce the CSPad data ndarray<T,3> array, 3) save array in the event for further modules.

This class should not be used directly in the code of users modules. Instead, it should be added as a module in the psana.cfg file with appropriate parameters. Then, the produced Image2D object can be extracted from event and used in other modules.

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

See also:
PixCoords2x1, PixCoordsQuad, PixCoordsCSPad, CSPadImageGetTest
Version:
$Id: CSPadNDArrProducer.h 8040 2014-04-19 01:00:36Z dubrovin@SLAC.STANFORD.EDU $
Author:
Mikhail S. Dubrovin

Definition at line 68 of file CSPadNDArrProducer.h.

Member Typedef Documentation

typedef CSPadPixCoords::CSPadConfigPars CSPadPixCoords::CSPadNDArrProducer::CONFIG

Definition at line 71 of file CSPadNDArrProducer.h.

Constructor & Destructor Documentation

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

Definition at line 50 of file CSPadNDArrProducer.cpp.

References checkTypeImplementation().

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

Definition at line 78 of file CSPadNDArrProducer.cpp.

Member Function Documentation

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

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

Definition at line 140 of file CSPadNDArrProducer.cpp.

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

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

Definition at line 106 of file CSPadNDArrProducer.cpp.

References printInputParameters(), and CSPadPixCoords::printSizeOfTypes().

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

Method which is called at the beginning of the run.

Definition at line 139 of file CSPadNDArrProducer.cpp.

void CSPadPixCoords::CSPadNDArrProducer::checkTypeImplementation (  )  [protected]

Definition at line 160 of file CSPadNDArrProducer.cpp.

References CSPadPixCoords::DOUBLE, CSPadPixCoords::FLOAT, CSPadPixCoords::INT, CSPadPixCoords::INT16, and GeometryAccess::msg.

Referenced by CSPadNDArrProducer().

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

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

Definition at line 141 of file CSPadNDArrProducer.cpp.

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

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

Definition at line 143 of file CSPadNDArrProducer.cpp.

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

Method which is called at the end of the run.

Definition at line 142 of file CSPadNDArrProducer.cpp.

void CSPadPixCoords::CSPadNDArrProducer::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 117 of file CSPadNDArrProducer.cpp.

References procEvent(), and CalibPars::status().

void CSPadPixCoords::CSPadNDArrProducer::printInputParameters (  )  [protected]

Print input parameters.

Definition at line 86 of file CSPadNDArrProducer.cpp.

Referenced by beginJob().

void CSPadPixCoords::CSPadNDArrProducer::procEvent ( Event &  evt,
Env &  env 
) [protected]

Definition at line 148 of file CSPadNDArrProducer.cpp.

References CSPadPixCoords::DOUBLE, CSPadPixCoords::FLOAT, CSPadPixCoords::INT, and CSPadPixCoords::INT16.

Referenced by event().

Member Data Documentation

const uint32_t CSPadPixCoords::CSPadNDArrProducer::N2x1 = 8 [static]

Definition at line 74 of file CSPadNDArrProducer.h.

const uint32_t CSPadPixCoords::CSPadNDArrProducer::NCols2x1 = 388 [static]

Definition at line 76 of file CSPadNDArrProducer.h.

const uint32_t CSPadPixCoords::CSPadNDArrProducer::NQuadsMax = 4 [static]

Definition at line 73 of file CSPadNDArrProducer.h.

const uint32_t CSPadPixCoords::CSPadNDArrProducer::NRows2x1 = 185 [static]

Definition at line 75 of file CSPadNDArrProducer.h.

const uint32_t CSPadPixCoords::CSPadNDArrProducer::SizeOf2x1Arr = NRows2x1 * NCols2x1 [static]

Definition at line 77 of file CSPadNDArrProducer.h.

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