FREE::Accessor::VectorTo2DProjectionAccessor< TVector > Class Template Reference
[Evaluation tools]

Accessor class which computes the projection of a vector on a to dim plane. More...

#include <freVectorTo2DProjectionAccessor.h>

List of all members.

Public Types
typedef VectorTo2DProjectionAccessor	Self
typedef TVector	InternalType
typedef itk::Vector < typename InternalType::ValueType, 2 >	ExternalType
Public Member Functions
void	Set (InternalType &output, const ExternalType &input) const
ExternalType	Get (const InternalType &input) const
void	SetActiveDimensions (const unsigned int &index1, const unsigned int &index2)
	VectorTo2DProjectionAccessor ()
Private Attributes
unsigned int	m_ActiveDim1
unsigned int	m_ActiveDim2

---

Detailed Description

template<class TVector>
class FREE::Accessor::VectorTo2DProjectionAccessor< TVector >

Accessor class which computes the projection of a vector on a to dim plane.

The accessor calculates the projection of a vector onto one of the base planes. The active dimension may be specified by indeces. If nothing has been specified, the projectes will be onto a plane spanned between the first and the 2nd dimension. The sequence of the vector values will never be changed. The vectors will only be reduced to the values of the two active dimensions.

Definition at line 45 of file freVectorTo2DProjectionAccessor.h.

---

Member Typedef Documentation

template<class TVector>

typedef VectorTo2DProjectionAccessor FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::Self

Standard class typedefs.

Definition at line 49 of file freVectorTo2DProjectionAccessor.h.

template<class TVector>

typedef TVector FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::InternalType

Internal typedef. It defines the internal real representation of data

Definition at line 53 of file freVectorTo2DProjectionAccessor.h.

template<class TVector>

typedef itk::Vector<typename InternalType::ValueType,2> FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::ExternalType

External typedef. It defines the external aspect that this class will exhibit

Definition at line 57 of file freVectorTo2DProjectionAccessor.h.

---

Constructor & Destructor Documentation

template<class TVector>

FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::VectorTo2DProjectionAccessor

(

)

[inline]

Definition at line 32 of file freVectorTo2DProjectionAccessor.cxx.

References FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::m_ActiveDim1, and FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::m_ActiveDim2.

---

Member Function Documentation

template<class TVector>

void FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::Set	(	InternalType &	output,
		const ExternalType &	input
	)			const [inline]

Write access to the VectorTo2DProjection component

Definition at line 60 of file freVectorTo2DProjectionAccessor.h.

template<class TVector>

ExternalType FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::Get

(

const InternalType &

input

)

const [inline]

Read access to the VectorTo2DProjection component

Definition at line 67 of file freVectorTo2DProjectionAccessor.h.

template<class TVector>

void FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::SetActiveDimensions	(	const unsigned int &	index1,
		const unsigned int &	index2
	)			[inline]

Functions sets the two active dimensions of the projection.

Definition at line 76 of file freVectorTo2DProjectionAccessor.h.

---

Member Data Documentation

template<class TVector>

unsigned int FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::m_ActiveDim1 [private]

Index of the first dimension used for the projection.

Definition at line 94 of file freVectorTo2DProjectionAccessor.h.

Referenced by FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::VectorTo2DProjectionAccessor().

template<class TVector>

unsigned int FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::m_ActiveDim2 [private]

Index of the second dimension used for the projection.

Definition at line 96 of file freVectorTo2DProjectionAccessor.h.

Referenced by FREE::Accessor::VectorTo2DProjectionAccessor< TVector >::VectorTo2DProjectionAccessor().

---

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

• freVectorTo2DProjectionAccessor.h
• freVectorTo2DProjectionAccessor.cxx

---