Detector containing a ccd camera image. More...

#include <pixeldetector.hpp>

Inheritance diagram for cass::pixeldetector::Detector:

Collaboration diagram for cass::pixeldetector::Detector:

Public Types
typedef float	pixel_t
	define a pixel of the pixel detector More...

typedef std::vector< pixel_t >	frame_t
	a frame is a vector of pixels More...

typedef std::pair< size_t, size_t >	shape_t
	define a shape of an image columnsxrows More...

Public Member Functions
	Detector ()
	constructor More...

	Detector (SerializerBackend &in)
	constructor More...

void	serialize (SerializerBackend &out) const
	serialize the data to the Serializer More...

bool	deserialize (SerializerBackend &in)
	deserialize the data from the Serializer More...


uint16_t &	columns ()
	setter More...

uint16_t &	rows ()
	setter More...

frame_t &	frame ()
	setter More...

uint32_t &	camaxMagic ()
	setter More...

std::string &	info ()
	setter More...

std::string &	timingFilename ()
	setter More...

uint64_t &	id ()
	setter More...


uint16_t	columns () const
	getter More...

uint16_t	rows () const
	getter More...

shape_t	shape () const
	getter More...

const frame_t &	frame () const
	getter More...

uint32_t	camaxMagic () const
	getter More...

const std::string &	info () const
	getter More...

const std::string &	timingFilename () const
	getter More...

uint64_t	id () const
	getter More...

Public Member Functions inherited from cass::Serializable
	Serializable (uint16_t version)
	constructor initializing the version More...

virtual	~Serializable ()
	virtual destructor to avoid warning with gcc 4.1.2 More...

uint16_t	ver () const
	retrieve the version of the serializer More...

virtual void	writeVersion (SerializerBackend &out) const
	write the version to the stream More...

virtual void	checkVersion (SerializerBackend &in) const
	check the version More...

Private Attributes
frame_t	_frame
	Linear array of CCD data. More...

uint16_t	_columns
	number of columns of the frame More...

uint16_t	_rows
	number of rows of the frame More...

uint32_t	_camaxMagic
	magic camax info, encodes ie. More...

std::string	_info
	infostring of the detector, telling the name of the detector (pnCCD specific) More...

std::string	_timingFilename
	filename of the file containing the timing info of the sequenzer (pnCCD specific) More...

uint64_t	_eventID
	the eventid that this detector belongs to (can be used for crosschecks More...

Additional Inherited Members
Protected Attributes inherited from cass::Serializable
uint16_t	_version
	the version for de/serializing More...

Detailed Description

Detector containing a ccd camera image.

This class represents a ccd camera image with all its properties.

Author: Lutz Foucar; Nicola Coppola

Definition at line 34 of file pixeldetector.hpp.

Member Typedef Documentation

typedef std::vector<pixel_t> cass::pixeldetector::Detector::frame_t

a frame is a vector of pixels

Definition at line 61 of file pixeldetector.hpp.

typedef float cass::pixeldetector::Detector::pixel_t

define a pixel of the pixel detector

Definition at line 58 of file pixeldetector.hpp.

typedef std::pair<size_t,size_t> cass::pixeldetector::Detector::shape_t

define a shape of an image columnsxrows

Definition at line 64 of file pixeldetector.hpp.

Constructor & Destructor Documentation

cass::pixeldetector::Detector::Detector ( )

inline

constructor

Definition at line 38 of file pixeldetector.hpp.

cass::pixeldetector::Detector::Detector ( SerializerBackend & in )

inline

constructor

constructs the Detector from data contained in the serialzer

Parameters

in	the serializer object to read the data from

Definition at line 50 of file pixeldetector.hpp.

References deserialize().

Member Function Documentation

uint32_t& cass::pixeldetector::Detector::camaxMagic ( )

inline

setter

Definition at line 110 of file pixeldetector.hpp.

References _camaxMagic.

Referenced by cass::pixeldetector::copyAdditionalPnccdInfo().

uint32_t cass::pixeldetector::Detector::camaxMagic ( ) const

inline

getter

Definition at line 121 of file pixeldetector.hpp.

References _camaxMagic.

uint16_t& cass::pixeldetector::Detector::columns ( )

inline

setter

Definition at line 107 of file pixeldetector.hpp.

References _columns.

Referenced by cass::pixeldetector::AdvancedDetector::associate(), cass::pixeldetector::copyAdditionalPnccdInfo(), cass::pixeldetector::copyCsPadFrame(), cass::pixeldetector::copyEpixFrame(), and cass::pixeldetector::Converter::operator()().

uint16_t cass::pixeldetector::Detector::columns ( ) const

inline

getter

Definition at line 117 of file pixeldetector.hpp.

References _columns.

bool cass::pixeldetector::Detector::deserialize ( SerializerBackend & in )

inlinevirtual

deserialize the data from the Serializer

reads the frame the info about columns and rows from the serialzer

Returns: true when de serialization was successfull

Parameters

in	the serializer object to read the data from

get the number of columns and rows

clear the frame and read it from the stream

Implements cass::Serializable.

Definition at line 90 of file pixeldetector.hpp.

References _columns, _frame, _rows, cass::Serializable::checkVersion(), and cass::SerializerBackend::retrieve().

Referenced by Detector().

frame_t& cass::pixeldetector::Detector::frame ( )

inline

setter

Definition at line 109 of file pixeldetector.hpp.

References _frame.

Referenced by cass::pixeldetector::AdvancedDetector::associate(), cass::pixeldetector::copyCsPadFrame(), cass::OctalDetector::copyData(), cass::pixeldetector::copyEpixFrame(), cass::pixeldetector::copyPnCCDFrame(), cass::SACLAConverter::operator()(), cass::pixeldetector::Converter::operator()(), cass::ZMQInput::runthis(), cass::XFELOnlineInput::runthis(), and cass::HDF5FileInput::runthis().

const frame_t& cass::pixeldetector::Detector::frame ( ) const

inline

getter

Definition at line 120 of file pixeldetector.hpp.

References _frame.

uint64_t& cass::pixeldetector::Detector::id ( )

inline

setter

Definition at line 113 of file pixeldetector.hpp.

References _eventID.

Referenced by cass::pixeldetector::AdvancedDetector::associate(), cass::pixeldetector::SHMStreamer::operator()(), cass::pixeldetector::RAWSSSReader::operator()(), cass::pixeldetector::Frms6Reader::operator()(), cass::pixeldetector::Converter::operator()(), and cass::XFELHDF5FileInput::runthis().

uint64_t cass::pixeldetector::Detector::id ( ) const

inline

getter

Definition at line 124 of file pixeldetector.hpp.

References _eventID.

std::string& cass::pixeldetector::Detector::info ( )

inline

setter

Definition at line 111 of file pixeldetector.hpp.

References _info.

Referenced by cass::pixeldetector::copyAdditionalPnccdInfo().

const std::string& cass::pixeldetector::Detector::info ( ) const

inline

getter

Definition at line 122 of file pixeldetector.hpp.

References _info.

uint16_t& cass::pixeldetector::Detector::rows ( )

inline

setter

Definition at line 108 of file pixeldetector.hpp.

References _rows.

Referenced by cass::pixeldetector::AdvancedDetector::associate(), cass::pixeldetector::copyAdditionalPnccdInfo(), cass::pixeldetector::copyCsPadFrame(), cass::pixeldetector::copyEpixFrame(), and cass::pixeldetector::Converter::operator()().

uint16_t cass::pixeldetector::Detector::rows ( ) const

inline

getter

Definition at line 118 of file pixeldetector.hpp.

References _rows.

void cass::pixeldetector::Detector::serialize ( SerializerBackend & out ) const

inlinevirtual

serialize the data to the Serializer

serializes the frame, the info about colums and rows to the serializer.

Parameters

out	the serializer object that the data will be serialzed to

write the columns rows and then the frame

Implements cass::Serializable.

Definition at line 73 of file pixeldetector.hpp.

References _columns, _frame, _rows, cass::SerializerBackend::add(), and cass::Serializable::writeVersion().

shape_t cass::pixeldetector::Detector::shape ( ) const

inline

getter

Definition at line 119 of file pixeldetector.hpp.

References _columns, and _rows.

std::string& cass::pixeldetector::Detector::timingFilename ( )

inline

setter

Definition at line 112 of file pixeldetector.hpp.

References _timingFilename.

Referenced by cass::pixeldetector::copyAdditionalPnccdInfo().

const std::string& cass::pixeldetector::Detector::timingFilename ( ) const

inline

getter

Definition at line 123 of file pixeldetector.hpp.

References _timingFilename.

Member Data Documentation

uint32_t cass::pixeldetector::Detector::_camaxMagic

private

magic camax info, encodes ie.

the gain of the ccd (pnCCD specific)

Definition at line 141 of file pixeldetector.hpp.

Referenced by camaxMagic().

uint16_t cass::pixeldetector::Detector::_columns

private

number of columns of the frame

Definition at line 135 of file pixeldetector.hpp.

Referenced by columns(), deserialize(), serialize(), and shape().

uint64_t cass::pixeldetector::Detector::_eventID

private

the eventid that this detector belongs to (can be used for crosschecks

Definition at line 150 of file pixeldetector.hpp.

Referenced by id().

frame_t cass::pixeldetector::Detector::_frame

private

Linear array of CCD data.

see cass::pixeldetector::Converter for layout

Definition at line 132 of file pixeldetector.hpp.

Referenced by deserialize(), frame(), and serialize().

std::string cass::pixeldetector::Detector::_info

private

infostring of the detector, telling the name of the detector (pnCCD specific)

Definition at line 144 of file pixeldetector.hpp.

Referenced by info().

uint16_t cass::pixeldetector::Detector::_rows

private

number of rows of the frame

Definition at line 138 of file pixeldetector.hpp.

Referenced by deserialize(), rows(), serialize(), and shape().

std::string cass::pixeldetector::Detector::_timingFilename

private

filename of the file containing the timing info of the sequenzer (pnCCD specific)

Definition at line 147 of file pixeldetector.hpp.

Referenced by timingFilename().

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

pixeldetector.hpp

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation