Abstract base class to all WValueSets. More...

#include <WValueSetBase.h>

Inheritance diagram for WValueSetBase:

Collaboration diagram for WValueSetBase:

Public Types
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
	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	size () const =0

virtual size_t	rawSize () const =0

virtual double	getScalarDouble (size_t i) const =0

virtual WValue< double >	getWValueDouble (size_t i) const =0

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

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

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

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

Protected Attributes
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
	Creates a boost::variant reference. More...

Detailed Description

Abstract base class to all WValueSets.

This class doesn't provide any genericness.

Definition at line 59 of file WValueSetBase.h.

Member Typedef Documentation

◆ ConstSPtr

typedef std::shared_ptr< const WValueSetBase > WValueSetBase::ConstSPtr

Shared pointer to an const instance of this class.

Definition at line 70 of file WValueSetBase.h.

◆ SPtr

typedef std::shared_ptr< WValueSetBase > WValueSetBase::SPtr

Shared pointer to an instance of this class.

Definition at line 65 of file WValueSetBase.h.

Constructor & Destructor Documentation

◆ WValueSetBase()

WValueSetBase::WValueSetBase	(	size_t	order,
		size_t	dimension,
		dataType	inDataType
	)

Despite this is an abstract class all subclasses should have an order and dimension.

Parameters

order	the tensor order of the values stored in this WValueSet
dimension	the tensor dimension of the values stored in this WValueSet
inDataType	indication of the primitive data type used to store the values

Definition at line 31 of file WValueSetBase.cpp.

References dimension(), and order().

Here is the call graph for this function:

◆ ~WValueSetBase()

WValueSetBase::~WValueSetBase ( )

pure virtual

Dummy since each class with virtual member functions needs one.

Definition at line 40 of file WValueSetBase.cpp.

Member Function Documentation

◆ applyFunction()

template<typename Func_T >

Func_T::result_type WValueSetBase::applyFunction ( Func_T const & func )

inline

Apply a function object to this valueset.

Template Parameters

Func_T The type of the function object, should be derived from the boost::static_visitor template.

Parameters

func	The function object to apply.

Returns: The result of the operation.

Definition at line 167 of file WValueSetBase.h.

References getVariant().

Referenced by VisitorVSetA::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dimension()

virtual size_t WValueSetBase::dimension ( ) const

inlinevirtual

Returns: Dimension of the values in this ValueSet

Definition at line 111 of file WValueSetBase.h.

References m_dimension.

Referenced by WValueSet< T >::getRequiredRawSizePerVoxel(), VisitorVSetB< VSetAType >::operator()(), WValueSetBaseTest::testDimension(), and WValueSetBase().

Here is the caller graph for this function:

◆ elementsPerValue()

virtual size_t WValueSetBase::elementsPerValue ( ) const

inlinevirtual

Returns the number of elements of type T per value.

Note: this is dimension to the power of order.

Returns: number of elements per value

Definition at line 129 of file WValueSetBase.h.

References m_dimension, and m_order.

◆ getDataType()

virtual dataType WValueSetBase::getDataType ( ) const

inlinevirtual

Returns: Dimension of the values in this ValueSet

Definition at line 137 of file WValueSetBase.h.

References m_dataType.

Referenced by WValueSetBaseTest::testDataType().

Here is the caller graph for this function:

◆ getMaximumValue()

virtual double WValueSetBase::getMaximumValue ( ) const

pure virtual

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.

Implemented in WValueSet< T >, WValueSet< VSetAType >, and Dummy.

◆ getMinimumValue()

virtual double WValueSetBase::getMinimumValue ( ) const

pure virtual

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).