#include <ScopeMultiImage.h>

Inherited by scope::ScopeMultiImageResonanceSW.

Public Member Functions
	ScopeMultiImage (const uint32_t &_area=0, const size_t &_nochannels=1, const uint32_t &_lines=256, const uint32_t &_linewidth=256)

void	FillRandom ()

Several accessor methods
uint32_t	Area () const

size_t	Channels () const

uint32_t	Lines () const

uint32_t	Linewidth () const

uint32_t	Pixels () const

uint16_t	GetPixel (const size_t &_ch, const uint32_t &_x, const uint32_t &_y) const

std::vector< uint16_t >	GetMultiPixel (const uint32_t &_x, const uint32_t &_y) const

ScopeImageU16Ptr	GetChannel (const size_t &chan) const

uint32_t	GetAvgCount () const

uint32_t	GetAvgMax () const

uint32_t	GetImageNumber () const

bool	IsCompleteFrame () const

bool	IsCompleteAvg () const

double	PercentComplete () const

Several mutator methods
void	SetChannel (const size_t &_chan, ScopeImageU16Ptr const _newimg)

void	SetAvgCount (const uint32_t &_avg_count)

void	SetAvgMax (const uint32_t &_avg_max)

void	SetImageNumber (const uint32_t &_imagenumber)

void	SetCompleteFrame (const bool &_complete)

void	SetCompleteAvg (const bool &_complete)

void	SetPercentComplete (const double &_percent)

Protected Attributes
const uint32_t	area

const size_t	nochannels

const uint32_t	lines

const uint32_t	linewidth

std::vector< ScopeImageU16Ptr >	channels

uint32_t	avg_count

uint32_t	avg_max

bool	complete_avg

uint32_t	imagenumber

bool	complete_frame

double	percent_complete

Detailed Description

A multichannel image.

Definition at line 12 of file ScopeMultiImage.h.

Constructor & Destructor Documentation

scope::ScopeMultiImage::ScopeMultiImage	(	const uint32_t &	_area = `0`,
		const size_t &	_nochannels = `1`,
		const uint32_t &	_lines = `256`,
		const uint32_t &	_linewidth = `256`
	)

Initializes and generate blank images for each channel.

Definition at line 7 of file ScopeMultiImage.cpp.

Member Function Documentation

uint16_t scope::ScopeMultiImage::GetPixel	(	const size_t &	_ch,
		const uint32_t &	_x,
		const uint32_t &	_y
	)		const

Parameters

[in]	_ch	which channel
[in]	_x,_y	which pixel

Returns: value of pixel of channel

Definition at line 24 of file ScopeMultiImage.cpp.

std::vector< uint16_t > scope::ScopeMultiImage::GetMultiPixel	(	const uint32_t &	_x,
		const uint32_t &	_y
	)		const

Parameters

[in] _x,_y which pixel

Returns: vector with pixel value of every channel

Definition at line 29 of file ScopeMultiImage.cpp.

ScopeImageU16Ptr scope::ScopeMultiImage::GetChannel ( const size_t & chan ) const

Returns: pointer to one channel image

Definition at line 36 of file ScopeMultiImage.cpp.

void scope::ScopeMultiImage::SetChannel	(	const size_t &	_chan,
		ScopeImageU16Ptr const	_newimg
	)

Replaces one channel of the multiimage.

Parameters

[in]	_chan	channel to be replaced
[in]	_newimg	pointer to the new channel image

Definition at line 41 of file ScopeMultiImage.cpp.

void scope::ScopeMultiImage::SetAvgCount ( const uint32_t & _avg_count )

Sets the average count of this image.

Definition at line 46 of file ScopeMultiImage.cpp.

void scope::ScopeMultiImage::SetAvgMax ( const uint32_t & _avg_max )

Sets the maximum average count.

Definition at line 50 of file ScopeMultiImage.cpp.

void scope::ScopeMultiImage::SetImageNumber ( const uint32_t & _imagenumber )

inline

Sets the number of this image.

Definition at line 100 of file ScopeMultiImage.h.

void scope::ScopeMultiImage::SetCompleteFrame ( const bool & _complete )

Sets frame complete.

Definition at line 55 of file ScopeMultiImage.cpp.

void scope::ScopeMultiImage::SetCompleteAvg ( const bool & _complete )

Sets complete average.

Definition at line 68 of file ScopeMultiImage.cpp.

void scope::ScopeMultiImage::SetPercentComplete ( const double & _percent )

Sets percent complete.

Definition at line 61 of file ScopeMultiImage.cpp.

void scope::ScopeMultiImage::FillRandom ( )

Fills the multi image with random data.

Definition at line 74 of file ScopeMultiImage.cpp.

Member Data Documentation

const uint32_t scope::ScopeMultiImage::area

protected

the area from which the multi image comes

Definition at line 16 of file ScopeMultiImage.h.

const size_t scope::ScopeMultiImage::nochannels

protected

number of channels

Definition at line 19 of file ScopeMultiImage.h.

const uint32_t scope::ScopeMultiImage::lines

protected

number of lines (y-resolution)

Definition at line 22 of file ScopeMultiImage.h.

const uint32_t scope::ScopeMultiImage::linewidth

protected

the linewidth (x-resolution)

Definition at line 25 of file ScopeMultiImage.h.

std::vector<ScopeImageU16Ptr> scope::ScopeMultiImage::channels

protected

the ScopeImages that contain the data for each channel

Definition at line 28 of file ScopeMultiImage.h.

uint32_t scope::ScopeMultiImage::avg_count

protected

this image is the xth average

Definition at line 31 of file ScopeMultiImage.h.

uint32_t scope::ScopeMultiImage::avg_max

protected

...

of this many to average

Definition at line 34 of file ScopeMultiImage.h.

bool scope::ScopeMultiImage::complete_avg

protected

false if this is a not completely averaged frame, this is then only for display purpose and will not be stored

Definition at line 37 of file ScopeMultiImage.h.

uint32_t scope::ScopeMultiImage::imagenumber

protected

number of this image

Definition at line 40 of file ScopeMultiImage.h.

bool scope::ScopeMultiImage::complete_frame

protected

false if frame not complete, allows for partial display during acquisition

Definition at line 43 of file ScopeMultiImage.h.

double scope::ScopeMultiImage::percent_complete

protected

how many percent of the frame are already filled

Definition at line 46 of file ScopeMultiImage.h.

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

scope/helpers/ScopeMultiImage.h
scope/helpers/ScopeMultiImage.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation