ml::WEMPrimitiveValueList Class Reference

This class comprises some attributes that are common for a WEM and a WEMPatch. More...

#include <WEMPrimitiveValueList.h>

List of all members.

Public Member Functions
	WEMPrimitiveValueList ()
	Constructor.
	WEMPrimitiveValueList (std::string description)
	Constructor.
	WEMPrimitiveValueList (const WEMPrimitiveValueList &valueList)
	Copy constructor.
	~WEMPrimitiveValueList ()
	Destructor.
void	copyProperties (const WEMPrimitiveValueList &valueList)
	Copy properties of the given primitive value list.
std::string	getDescription () const
	Get description.
std::string	getUnits () const
	Get units.
void	setUnits (std::string units)
	Set units.
PrimitiveValueListTypes	getPrimitiveValueListType () const
	Get primitive mode.
void	setPrimitiveValueListType (PrimitiveValueListTypes primitiveValueListType)
	Set primitive mode.
bool	isValid () const
	Are the values valid? The description should be non-empty, the list should contain values and the minimum and maximum values should be set.
unsigned int	getNumValues () const
	Get number of values.
bool	isPersistent () const
	Should the value list be saved when saving the WEM?
void	setPersistence (bool persistent)
	Set whether the value list should be saved when saving the WEM.
MLDataType	getDataType () const
	Get data type.
void	setDataType (MLDataType dataType)
	Set data type.
double	getMinValue () const
	Get minimum value.
double	getMaxValue () const
	Get maximum value.
double	getMeanValue () const
	Get mean value.
void	setMinMaxValue (double minValue, double maxValue)
	Set min - max values, switch to fixed values.
void	clampMinValue (double minValue)
	Clamp min value to given value.
void	clampMaxValue (double maxValue)
	Clamp max value to given value.
double	getStdValue () const
	Get standard deviation value.
double	getRMSDValue () const
	Get root mean square deviation value.
void	updateStatistics ()
	Update statistics: mean, std and rms.
double	getValue (unsigned int index) const
	Get value at given index.
void	setValue (unsigned int index, double value)
	Store given value at given index.
void	appendValue (double value)
	Append given value.
void	setValueFrom (unsigned int index, unsigned int source)
	Copy value from index source to given index.
void	addValueFrom (unsigned int index, unsigned int source, double modifier)
	Add value from index source to given index. Min - Max values are not adjusted.
void	resetValues ()
	Reset stored values.
void	initializeValues (unsigned int number, double value)
	Initialize X values with given value.
void	multiplyValues (double modifier)
	Multiply values with given modifier. Adjust min - max values.
void	extendValues (unsigned int number, double value)
	Extend list with given amount and initialize new values with given value.
void	saveTo (std::ostream &outstream)
	Save attributes to given output stream.
unsigned int	loadFrom (std::istream &instream, short version, bool swapBytes)
	Load attributes from given input stream.
unsigned int	loadFrom (char *map, short version, bool swapBytes)
	Load attributes from given memory map.

---

Detailed Description

This class comprises some attributes that are common for a WEM and a WEMPatch.

Definition at line 24 of file WEMPrimitiveValueList.h.

---

Constructor & Destructor Documentation

ml::WEMPrimitiveValueList::WEMPrimitiveValueList

(

)

Constructor.

ml::WEMPrimitiveValueList::WEMPrimitiveValueList

(

std::string

description

)

Constructor.

ml::WEMPrimitiveValueList::WEMPrimitiveValueList

(

const WEMPrimitiveValueList &

valueList

)

Copy constructor.

ml::WEMPrimitiveValueList::~WEMPrimitiveValueList

(

)

Destructor.

---

Member Function Documentation

void ml::WEMPrimitiveValueList::addValueFrom	(	unsigned int	index,
		unsigned int	source,
		double	modifier
	)			[inline]

Add value from index source to given index. Min - Max values are not adjusted.

Definition at line 104 of file WEMPrimitiveValueList.h.

void ml::WEMPrimitiveValueList::appendValue

(

double

value

)

[inline]

Append given value.

Use with caution!! Do not adjust min and max values! WEMPatch already adds a default value when a primitive is added, so use with caution!

Definition at line 100 of file WEMPrimitiveValueList.h.

void ml::WEMPrimitiveValueList::clampMaxValue

(

double

maxValue

)

Clamp max value to given value.

void ml::WEMPrimitiveValueList::clampMinValue

(

double

minValue

)

Clamp min value to given value.

void ml::WEMPrimitiveValueList::copyProperties

(

const WEMPrimitiveValueList &

valueList

)

Copy properties of the given primitive value list.

void ml::WEMPrimitiveValueList::extendValues	(	unsigned int	number,
		double	value
	)

Extend list with given amount and initialize new values with given value.

MLDataType ml::WEMPrimitiveValueList::getDataType

(

void

)

const [inline]

Get data type.

Definition at line 69 of file WEMPrimitiveValueList.h.

std::string ml::WEMPrimitiveValueList::getDescription

(

)

const [inline]

Get description.

Definition at line 45 of file WEMPrimitiveValueList.h.

double ml::WEMPrimitiveValueList::getMaxValue

(

)

const [inline]

Get maximum value.

Definition at line 76 of file WEMPrimitiveValueList.h.

double ml::WEMPrimitiveValueList::getMeanValue

(

)

const [inline]

Get mean value.

Definition at line 78 of file WEMPrimitiveValueList.h.

double ml::WEMPrimitiveValueList::getMinValue

(

)

const [inline]

Get minimum value.

Definition at line 74 of file WEMPrimitiveValueList.h.

unsigned int ml::WEMPrimitiveValueList::getNumValues

(

)

const [inline]

Get number of values.

Definition at line 61 of file WEMPrimitiveValueList.h.

PrimitiveValueListTypes ml::WEMPrimitiveValueList::getPrimitiveValueListType

(

)

const [inline]

Get primitive mode.

Definition at line 53 of file WEMPrimitiveValueList.h.

double ml::WEMPrimitiveValueList::getRMSDValue

(

)

const [inline]

Get root mean square deviation value.

Definition at line 88 of file WEMPrimitiveValueList.h.

double ml::WEMPrimitiveValueList::getStdValue

(

)

const [inline]

Get standard deviation value.

Definition at line 86 of file WEMPrimitiveValueList.h.

std::string ml::WEMPrimitiveValueList::getUnits

(

)

const [inline]

Get units.

Definition at line 48 of file WEMPrimitiveValueList.h.

double ml::WEMPrimitiveValueList::getValue

(

unsigned int

index

)

const [inline]

Get value at given index.

Definition at line 94 of file WEMPrimitiveValueList.h.

void ml::WEMPrimitiveValueList::initializeValues	(	unsigned int	number,
		double	value
	)

Initialize X values with given value.

bool ml::WEMPrimitiveValueList::isPersistent

(

)

const [inline]

Should the value list be saved when saving the WEM?

Definition at line 64 of file WEMPrimitiveValueList.h.

bool ml::WEMPrimitiveValueList::isValid

(

)

const

Are the values valid? The description should be non-empty, the list should contain values and the minimum and maximum values should be set.

unsigned int ml::WEMPrimitiveValueList::loadFrom	(	char *	map,
		short	version,
		bool	swapBytes
	)

Load attributes from given memory map.

unsigned int ml::WEMPrimitiveValueList::loadFrom	(	std::istream &	instream,
		short	version,
		bool	swapBytes
	)

Load attributes from given input stream.

void ml::WEMPrimitiveValueList::multiplyValues

(

double

modifier

)

Multiply values with given modifier. Adjust min - max values.

void ml::WEMPrimitiveValueList::resetValues

(

)

Reset stored values.

void ml::WEMPrimitiveValueList::saveTo

(

std::ostream &

outstream

)

Save attributes to given output stream.

void ml::WEMPrimitiveValueList::setDataType

(

MLDataType

dataType

)

[inline]

Set data type.

Definition at line 71 of file WEMPrimitiveValueList.h.

void ml::WEMPrimitiveValueList::setMinMaxValue	(	double	minValue,
		double	maxValue
	)			[inline]

Set min - max values, switch to fixed values.

Definition at line 80 of file WEMPrimitiveValueList.h.

void ml::WEMPrimitiveValueList::setPersistence

(

bool

persistent

)

[inline]

Set whether the value list should be saved when saving the WEM.

Definition at line 66 of file WEMPrimitiveValueList.h.

void ml::WEMPrimitiveValueList::setPrimitiveValueListType

(

PrimitiveValueListTypes

primitiveValueListType

)

[inline]

Set primitive mode.

Definition at line 55 of file WEMPrimitiveValueList.h.

void ml::WEMPrimitiveValueList::setUnits

(

std::string

units

)

[inline]

Set units.

Definition at line 50 of file WEMPrimitiveValueList.h.

void ml::WEMPrimitiveValueList::setValue	(	unsigned int	index,
		double	value
	)

Store given value at given index.

If index exceeds the size of the vector, the value is appended.

void ml::WEMPrimitiveValueList::setValueFrom	(	unsigned int	index,
		unsigned int	source
	)			[inline]

Copy value from index source to given index.

Definition at line 102 of file WEMPrimitiveValueList.h.

void ml::WEMPrimitiveValueList::updateStatistics

(

)

Update statistics: mean, std and rms.

---

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

• MeVisLab/Standard/Sources/ML/MLWEM/WEMBase/WEMPrimitiveValueList.h