ImgAlgos::ImgIntForBins Class Reference
[ImgAlgos package]

Example module class for psana. More...

#include <ImgIntForBins.h>

List of all members.

Public Types
typedef double	data_out_t
Public Member Functions
	ImgIntForBins (const std::string &name)
virtual	~ImgIntForBins ()
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.
void	printInputParameters ()
void	printEventRecord (Event &evt)
Protected Member Functions
void	init (Event &evt, Env &env)
void	procEvent (Event &evt, Env &env)
void	saveIntensityBinsInEvent (Event &evt)
std::string	strRecord ()

---

Detailed Description

Example module class for psana.

Evaluates average 2d image intensity in bins defined by the map, saves output file with I(bin,event). Apply corrections to 2d image using pedestals, background, gain factor, and mask.

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

Version:

$Id: ImgIntForBins.h 8035 2014-04-19 00:56:24Z dubrovin@SLAC.STANFORD.EDU $

Author:

Mikhail S. Dubrovin

Definition at line 61 of file ImgIntForBins.h.

---

Member Typedef Documentation

typedef double ImgAlgos::ImgIntForBins::data_out_t

Definition at line 64 of file ImgIntForBins.h.

---

Constructor & Destructor Documentation

ImgAlgos::ImgIntForBins::ImgIntForBins

(

const std::string &

name

)

Definition at line 47 of file ImgIntForBins.cpp.

References config.

ImgAlgos::ImgIntForBins::~ImgIntForBins

(

)

[virtual]

Definition at line 98 of file ImgIntForBins.cpp.

---

Member Function Documentation

void ImgAlgos::ImgIntForBins::beginCalibCycle	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 118 of file ImgIntForBins.cpp.

void ImgAlgos::ImgIntForBins::beginJob	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 104 of file ImgIntForBins.cpp.

References printInputParameters().

void ImgAlgos::ImgIntForBins::beginRun	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the beginning of the run.

Definition at line 112 of file ImgIntForBins.cpp.

void ImgAlgos::ImgIntForBins::endCalibCycle	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 137 of file ImgIntForBins.cpp.

void ImgAlgos::ImgIntForBins::endJob	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 149 of file ImgIntForBins.cpp.

References src::psana_doc_info::info, MsgLog, and setup::name.

void ImgAlgos::ImgIntForBins::endRun	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the end of the run.

Definition at line 143 of file ImgIntForBins.cpp.

void ImgAlgos::ImgIntForBins::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 125 of file ImgIntForBins.cpp.

References init(), printEventRecord(), and procEvent().

void ImgAlgos::ImgIntForBins::init	(	Event &	evt,
		Env &	env
	)			[protected]

Definition at line 159 of file ImgIntForBins.cpp.

References ImgAlgos::ImgParametersV1::data(), ImgAlgos::defineImageShape(), ex_all_dets::i, src::psana_doc_info::info, MsgLog, setup::name, and print().

Referenced by event().

void ImgAlgos::ImgIntForBins::printEventRecord

(

Event &

evt

)

Definition at line 211 of file ImgIntForBins.cpp.

References src::psana_doc_info::info, MsgLog, setup::name, ImgAlgos::stringFromUint(), ImgAlgos::stringRunNumber(), and ImgAlgos::stringTimeStamp().

Referenced by event().

void ImgAlgos::ImgIntForBins::printInputParameters

(

)

Definition at line 73 of file ImgIntForBins.cpp.

References src::psana_doc_info::info, src::kerberos_::log, setup::name, ImgAlgos::printSizeOfTypes(), and WithMsgLog.

Referenced by beginJob().

void ImgAlgos::ImgIntForBins::procEvent	(	Event &	evt,
		Env &	env
	)			[protected]

Definition at line 186 of file ImgIntForBins.cpp.

References src::psana_doc_info::info, MsgLog, and setup::name.

Referenced by event().

void ImgAlgos::ImgIntForBins::saveIntensityBinsInEvent

(

Event &

evt

)

[protected]

std::string ImgAlgos::ImgIntForBins::strRecord

(

)

[protected]

Definition at line 200 of file ImgIntForBins.cpp.

---

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

• ImgAlgos/include/ImgIntForBins.h
• ImgAlgos/src/ImgIntForBins.cpp

---