cspad_mod::CsPadFilter Class Reference
[Cspad_mod]

Module which performs CsPad filtering. More...

#include <CsPadFilter.h>

List of all members.

Public Member Functions
	CsPadFilter (const std::string &name)
virtual	~CsPadFilter ()
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.

---

Detailed Description

Module which performs CsPad filtering.

This class defines psana module which perform event filtering based on the signal in CsPad images. If this module determines that CsPad does not have sufficient signal it forces psana to skip remaining modules for this event. It also skips event if there is no CsPad data at all, this behavior can be changed by setting configuration option "skipIfNoData" to "no" or "false".

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

Version:

$Id: CsPadFilter.h 2478 2011-10-05 16:33:11Z salnikov@SLAC.STANFORD.EDU $

Author:

Andy Salnikov

Definition at line 59 of file CsPadFilter.h.

---

Constructor & Destructor Documentation

cspad_mod::CsPadFilter::CsPadFilter

(

const std::string &

name

)

Definition at line 51 of file CsPadFilter.cpp.

cspad_mod::CsPadFilter::~CsPadFilter

(

)

[virtual]

Definition at line 69 of file CsPadFilter.cpp.

---

Member Function Documentation

void cspad_mod::CsPadFilter::beginCalibCycle	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 128 of file CsPadFilter.cpp.

void cspad_mod::CsPadFilter::beginJob	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 75 of file CsPadFilter.cpp.

void cspad_mod::CsPadFilter::beginRun	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the beginning of the run.

Definition at line 81 of file CsPadFilter.cpp.

References pdscalibdata::CsPadFilterV1::DataSize.

void cspad_mod::CsPadFilter::endCalibCycle	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 239 of file CsPadFilter.cpp.

void cspad_mod::CsPadFilter::endJob	(	Event &	evt,
		Env &	env
	)			[virtual]

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

Definition at line 251 of file CsPadFilter.cpp.

void cspad_mod::CsPadFilter::endRun	(	Event &	evt,
		Env &	env
	)			[virtual]

Method which is called at the end of the run.

Definition at line 245 of file CsPadFilter.cpp.

void cspad_mod::CsPadFilter::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 135 of file CsPadFilter.cpp.

---

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

• cspad_mod/include/CsPadFilter.h
• cspad_mod/src/CsPadFilter.cpp

---