Base Class for all value set types. More...

#include <WValueSet.h>

Inheritance diagram for WValueSet< T >:

Collaboration diagram for WValueSet< T >:

Classes
class	SubArray
	A helper class granting safe access to a certain part of the valueset. More...

Public Types
typedef T	ValueT
	The type of the single value in this value set. More...

Public Types inherited from WValueSetBase
typedef std::shared_ptr< WValueSetBase >	SPtr
	Shared pointer to an instance of this class. More...

typedef std::shared_ptr< const WValueSetBase >	ConstSPtr
	Shared pointer to an const instance of this class. More...

Public Member Functions
	WValueSet (size_t order, size_t dimension, const std::shared_ptr< std::vector< T > > data, dataType inDataType)
	Constructs a value set with values of type T. More...

	WValueSet (size_t order, size_t dimension, const std::shared_ptr< std::vector< T > > data)
	Constructs a value set with values of type T. More...

virtual size_t	size () const

virtual size_t	rawSize () const

virtual T	getScalar (size_t i) const

virtual double	getScalarDouble (size_t i) const

virtual WValue< double >	getWValueDouble (size_t i) const

WVector3d	getVector3D (size_t index) const
	Get the i'th vector. More...

WValue< T >	getWValue (size_t index) const
	Get the i'th WValue with the dimension of WValueSet. More...

const T *	rawData () const
	Sometimes we need raw access to the data array, for e.g. More...

const std::vector< T > *	rawDataVectorPointer () const
	Sometimes we need raw access to the data vector. More...

SubArray const	getSubArray (std::size_t start, std::size_t size) const
	Request (read-) access object to a subarray of this valueset. More...

virtual double	getMinimumValue () const
	This method returns the smallest value in the valueset. More...

virtual double	getMaximumValue () const
	This method returns the largest value in the valueset. More...

Public Member Functions inherited from WValueSetBase
	WValueSetBase (size_t order, size_t dimension, dataType inDataType)
	Despite this is an abstract class all subclasses should have an order and dimension. More...

virtual	~WValueSetBase ()=0
	Dummy since each class with virtual member functions needs one. More...

virtual size_t	dimension () const

virtual size_t	order () const

virtual size_t	elementsPerValue () const
	Returns the number of elements of type T per value. More...

virtual dataType	getDataType () const

template<typename Func_T >
Func_T::result_type	applyFunction (Func_T const &func)
	Apply a function object to this valueset. More...

Static Public Member Functions
static size_t	getRequiredRawSizePerVoxel (size_t oder, size_t dimension)
	Calculates the needed number of integral values for a valueset with specified order and dimension for one voxel. More...

Protected Attributes
T	m_minimum
	The smallest value in m_data. More...

T	m_maximum
	The largest value in m_data. More...

Protected Attributes inherited from WValueSetBase
const size_t	m_order
	The order of the tensors for this ValueSet. More...

const size_t	m_dimension
	The dimension of the tensors for this ValueSet. More...

const dataType	m_dataType
	The data type of the values' elements. More...

Private Member Functions
virtual WValueSetVariant const	getVariant () const
	Get a variant reference to this valueset (the reference is stored in the variant). More...

Private Attributes
const std::shared_ptr< std::vector< T > >	m_data
	Stores the values of type T as simple array which never should be modified. More...

Friends
class	WValueSetTest
	Only UnitTests are allowed to be friends. More...

Detailed Description

template<typename T>
class WValueSet< T >

Base Class for all value set types.

forward declaration

Definition at line 46 of file WValueSet.h.

Member Typedef Documentation

◆ ValueT

template<typename T >

typedef T WValueSet< T >::ValueT

The type of the single value in this value set.

Definition at line 57 of file WValueSet.h.

Constructor & Destructor Documentation

◆ WValueSet() [1/2]

template<typename T >

WValueSet< T >::WValueSet	(	size_t	order,
		size_t	dimension,
		const std::shared_ptr< std::vector< T > >	data,
		dataType	inDataType
	)

inline

Constructs a value set with values of type T.

Sets order and dimension to allow to interpret the values as tensors of a certain order and dimension.

Parameters

order	tensor order of values stored in the value set
dimension	tensor dimension of values stored in the value set
data	the vector holding the raw data
inDataType	indicator telling us which dataType comes in

Definition at line 122 of file WValueSet.h.

References WValueSet< T >::m_maximum, and WValueSet< T >::m_minimum.

◆ WValueSet() [2/2]

template<typename T >

WValueSet< T >::WValueSet	(	size_t	order,
		size_t	dimension,
		const std::shared_ptr< std::vector< T > >	data
	)

inline

Constructs a value set with values of type T.

Sets order and dimension to allow to interpret the values as tensors of a certain order and dimension.

Parameters

order	tensor order of values stored in the value set
dimension	tensor dimension of values stored in the value set
data	the vector holding the raw data

Definition at line 144 of file WValueSet.h.

References WValueSet< T >::m_maximum, and WValueSet< T >::m_minimum.

Member Function Documentation

◆ getMaximumValue()

template<typename T >

virtual double WValueSet< T >::getMaximumValue ( ) const

inlinevirtual

This method returns the largest value in the valueset.

It does not handle vectors, matrices and so on well. It simply returns the largest value in the data array. This is especially useful for texture scaling or other statistic tools (histograms).

Returns: the largest value in the data.

Implements WValueSetBase.

Definition at line 289 of file WValueSet.h.

References WValueSet< T >::m_maximum.

Referenced by WSegmentationAlgoThreshold::operator()().

Here is the caller graph for this function:

◆ getMinimumValue()

template<typename T >

virtual double WValueSet< T >::getMinimumValue ( ) const

inlinevirtual

This method returns the smallest value in the valueset.

It does not handle vectors, matrices and so on well. It simply returns the smallest value in the data array. This is especially useful for texture scaling or other statistic tools (histograms).

Returns: the smallest value in the data.

Implements WValueSetBase.

Definition at line 278 of file WValueSet.h.

References WValueSet< T >::m_minimum.

Referenced by WSegmentationAlgoThreshold::operator()().

Here is the caller graph for this function:

◆ getRequiredRawSizePerVoxel()

template<typename T >

size_t WValueSet< T >::getRequiredRawSizePerVoxel	(	size_t	oder,
		size_t	dimension
	)

static

Calculates the needed number of integral values for a valueset with specified order and dimension for one voxel.

The whole dataset will then be as large as the number of voxels multiplied by this value.

Parameters

oder	desired tensor order.
dimension	desired dimension.

Returns: the number of values needed

Definition at line 357 of file WValueSet.h.

References WValueSetBase::dimension().

Here is the call graph for this function:

◆ getScalar()

template<typename T >

virtual T WValueSet< T >::getScalar ( size_t i ) const

inlinevirtual

Parameters

i	id of the scalar to retrieve

Returns: The i-th scalar stored in this value set. There are rawSize() such scalars.

Definition at line 193 of file WValueSet.h.

References WValueSet< T >::m_data.

Referenced by WSegmentationAlgoThreshold::operator()().

Here is the caller graph for this function:

◆ getScalarDouble()

template<typename T >

virtual double WValueSet< T >::getScalarDouble ( size_t i ) const

inlinevirtual

Parameters

i	id of the scalar to retrieve

Returns: The i-th scalar stored in this value set. There are rawSize() such scalars.

Implements WValueSetBase.

Definition at line 202 of file WValueSet.h.

References WValueSet< T >::m_data.

◆ getSubArray()

template<typename T >

SubArray const WValueSet< T >::getSubArray	(	std::size_t	start,
		std::size_t	size
	)		const

inline

Request (read-) access object to a subarray of this valueset.

The object returned by this function can be used as an array ( starting at index 0 ), whose elements are the data elements at positions start to ( including ) start + size - 1 of the valueset.

Parameters