cass::ACQIRIS::Channel Class Reference

A Channel of an Acqiris Instrument. More...

#include <channel.hpp>

Inheritance diagram for cass::ACQIRIS::Channel:

Collaboration diagram for cass::ACQIRIS::Channel:

Public Types
typedef std::vector< int16_t >	waveform_t
	define the waveform More...

Public Member Functions
	Channel ()
	constructor that will set the serialize version More...
	Channel (SerializerBackend &in)
	construct this from the stream More...
void	serialize (SerializerBackend &out) const
	will serialize this channel to the serializer More...
bool	deserialize (SerializerBackend &in)
	deserialize this channel from the serializer More...
double	fullscale () const
	getter More...
double &	horpos ()
	setter More...
double &	offset ()
	setter More...
double &	sampleInterval ()
	setter More...
double &	gain ()
	setter More...
waveform_t &	waveform ()
	setter More...
size_t &	channelNbr ()
	setter More...
double	horpos () const
	getter More...
double	offset () const
	getter More...
double	gain () const
	getter More...
double	sampleInterval () const
	getter More...
const waveform_t &	waveform () const
	getter More...
size_t	channelNbr () 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
size_t	_chNbr
	This Channels Number in the Acqiris Instrument. More...
double	_horpos
	Horizontal position of first data point with respect to the trigger. More...
double	_offset
	the vertical offset of this channel (in V) More...
double	_gain
	Vertical gain in Volts/LSB. More...
double	_sampleInterval
	the time between two consecutive datapoints in seconds More...
waveform_t	_waveform
	the waveform of this channel More...

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

Detailed Description

A Channel of an Acqiris Instrument.

contains all information that an Acqiris instrument will provide about a channel

Author

Lutz Foucar

Definition at line 31 of file channel.hpp.

Member Typedef Documentation

typedef std::vector<int16_t> cass::ACQIRIS::Channel::waveform_t

define the waveform

Definition at line 35 of file channel.hpp.

Constructor & Destructor Documentation

cass::ACQIRIS::Channel::Channel ( )

inline

constructor that will set the serialize version

Definition at line 38 of file channel.hpp.

cass::ACQIRIS::Channel::Channel ( SerializerBackend &  in )

inline

construct this from the stream

Parameters

in	the input stream to read this class from

Definition at line 51 of file channel.hpp.

References deserialize().

Member Function Documentation

size_t& cass::ACQIRIS::Channel::channelNbr ( )

inline

setter

Definition at line 106 of file channel.hpp.

References _chNbr.

Referenced by cass::ACQIRIS::AGATStreamer::operator()(), cass::ACQIRIS::Converter::operator()(), and cass::HDF5FileInput::runthis().

size_t cass::ACQIRIS::Channel::channelNbr ( ) const

inline

getter

Definition at line 115 of file channel.hpp.

References _chNbr.

bool cass::ACQIRIS::Channel::deserialize ( SerializerBackend &  in )

inlinevirtual

deserialize this channel from the serializer

Parameters

in	the stream to serialze this class from

read all variables and then the waveform from the input stream

read the length of the waveform

clear the wavefrom

Implements cass::Serializable.

Definition at line 81 of file channel.hpp.

References _gain, _horpos, _offset, _sampleInterval, _waveform, cass::Serializable::checkVersion(), and cass::SerializerBackend::retrieve().

Referenced by Channel().

double cass::ACQIRIS::Channel::fullscale ( ) const

inline

getter

will calculate the fullscale from the gain value, provided by the instrument

Definition at line 123 of file channel.hpp.

References _gain.

double& cass::ACQIRIS::Channel::gain ( )

inline

setter

Definition at line 104 of file channel.hpp.

References _gain.

Referenced by cass::ACQIRIS::CoM(), cass::ACQIRIS::ConstantFraction::getcfd(), cass::ACQIRIS::CenterOfMass::getcom(), cass::ACQIRIS::getfwhm(), cass::ACQIRIS::getmaximum(), cass::ACQIRIS::Converter::operator()(), cass::HDF5FileInput::runthis(), and cass::ACQIRIS::startstop().

double cass::ACQIRIS::Channel::gain ( ) const

inline

getter

Definition at line 112 of file channel.hpp.

References _gain.

double& cass::ACQIRIS::Channel::horpos ( )

inline

setter

Definition at line 101 of file channel.hpp.

References _horpos.

Referenced by cass::ACQIRIS::CoM(), cass::ACQIRIS::ConstantFraction::getcfd(), cass::ACQIRIS::LmaReader::operator()(), cass::ACQIRIS::Converter::operator()(), cass::HDF5FileInput::runthis(), and cass::ACQIRIS::startstop().

double cass::ACQIRIS::Channel::horpos ( ) const

inline

getter

Definition at line 110 of file channel.hpp.

References _horpos.

double& cass::ACQIRIS::Channel::offset ( )

inline

setter

Definition at line 102 of file channel.hpp.

References _offset.

Referenced by cass::ACQIRIS::CoM(), cass::ACQIRIS::ConstantFraction::getcfd(), cass::ACQIRIS::CenterOfMass::getcom(), cass::ACQIRIS::getfwhm(), cass::ACQIRIS::getmaximum(), cass::ACQIRIS::Converter::operator()(), cass::HDF5FileInput::runthis(), and cass::ACQIRIS::startstop().

double cass::ACQIRIS::Channel::offset ( ) const

inline

getter

Definition at line 111 of file channel.hpp.

References _offset.

double& cass::ACQIRIS::Channel::sampleInterval ( )

inline

setter

Definition at line 103 of file channel.hpp.

References _sampleInterval.

Referenced by cass::ACQIRIS::CoM(), cass::ACQIRIS::ConstantFraction::getcfd(), cass::ACQIRIS::Converter::operator()(), cass::ACQIRIS::LmaReader::readHeaderInfo(), cass::HDF5FileInput::runthis(), and cass::ACQIRIS::startstop().

double cass::ACQIRIS::Channel::sampleInterval ( ) const

inline

getter

Definition at line 113 of file channel.hpp.

References _sampleInterval.

void cass::ACQIRIS::Channel::serialize ( SerializerBackend &  out ) const

inlinevirtual

will serialize this channel to the serializer

Parameters

out	the stream to serialze this class to

output all variables obtained from the acqiris

write the length of the waveform

the waveform itselve

Implements cass::Serializable.

Definition at line 62 of file channel.hpp.

References _gain, _horpos, _offset, _sampleInterval, _waveform, cass::SerializerBackend::add(), and cass::Serializable::writeVersion().

waveform_t& cass::ACQIRIS::Channel::waveform ( )

inline

setter

Definition at line 105 of file channel.hpp.

References _waveform.

Referenced by cass::ACQIRIS::CoM(), cass::ACQIRIS::ConstantFraction::getcfd(), cass::ACQIRIS::CenterOfMass::getcom(), cass::ACQIRIS::getfwhm(), cass::ACQIRIS::getmaximum(), cass::ACQIRIS::Converter::operator()(), cass::HDF5FileInput::runthis(), and cass::ACQIRIS::startstop().

const waveform_t& cass::ACQIRIS::Channel::waveform ( ) const

inline

getter

Definition at line 114 of file channel.hpp.

References _waveform.

Member Data Documentation

size_t cass::ACQIRIS::Channel::_chNbr

private

This Channels Number in the Acqiris Instrument.

Definition at line 127 of file channel.hpp.

Referenced by channelNbr().

double cass::ACQIRIS::Channel::_gain

private

Vertical gain in Volts/LSB.

(V = vGain * data - vOffset)

Definition at line 136 of file channel.hpp.

Referenced by deserialize(), fullscale(), gain(), and serialize().

double cass::ACQIRIS::Channel::_horpos

private

Horizontal position of first data point with respect to the trigger.

Definition at line 130 of file channel.hpp.

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

double cass::ACQIRIS::Channel::_offset

private

the vertical offset of this channel (in V)

Definition at line 133 of file channel.hpp.

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

double cass::ACQIRIS::Channel::_sampleInterval

private

the time between two consecutive datapoints in seconds

Definition at line 139 of file channel.hpp.

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

waveform_t cass::ACQIRIS::Channel::_waveform

private

the waveform of this channel

Definition at line 142 of file channel.hpp.

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

---

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

• channel.hpp