FREE::VarianceFieldGenerator< TInputVectorField, TOutputField > Class Template Reference
[Evaluation tools]

Computes a variance field out of a set of passed fields. More...

#include <freVarianceFieldGenerator.h>

List of all members.

Public Types
typedef TInputVectorField	InputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::ValueType	InputValueType
typedef TOutputField	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::ValueType	OutputValueType
typedef OutputImageType::RegionType	OutputRegionType
typedef OutputImageType::PointType	OutputPointType
Public Member Functions
OutputRegionType	GetOutputRegion () const
void	SetOutputGeometry (const OutputRegionType &outputRegion, const OutputPointType &origin)
InputImagePointer	AddField (const InputImageType *pField, const InputImageType *pMeanField)
OutputImagePointer	GetOutput (void) const
void	Reset ()
	VarianceFieldGenerator ()
	~VarianceFieldGenerator ()
Private Member Functions
void	ResizeSumField (const InputImageType *elementField)
Private Attributes
OutputImagePointer	m_SumField
unsigned int	m_iFieldCount
bool	m_bUserRegion
OutputRegionType	m_OutputRegion
OutputPointType	m_OutputOrigin

---

Detailed Description

template<class TInputVectorField, class TOutputField>
class FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >

Computes a variance field out of a set of passed fields.

VarianceFieldGenerator uses a given set of vector fields to calculate a variance field. Depending on its setting the region of the output will be the same then the first added element or can be defined by user.

Remarks:

In this version the generator assumes that all images have the same spacing

Definition at line 39 of file freVarianceFieldGenerator.h.

---

Member Typedef Documentation

template<class TInputVectorField, class TOutputField>

typedef TInputVectorField FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::InputImageType

Definition at line 42 of file freVarianceFieldGenerator.h.

template<class TInputVectorField, class TOutputField>

typedef InputImageType::Pointer FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::InputImagePointer

Definition at line 43 of file freVarianceFieldGenerator.h.

template<class TInputVectorField, class TOutputField>

typedef InputImageType::ValueType FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::InputValueType

Definition at line 44 of file freVarianceFieldGenerator.h.

template<class TInputVectorField, class TOutputField>

typedef TOutputField FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::OutputImageType

Definition at line 45 of file freVarianceFieldGenerator.h.

template<class TInputVectorField, class TOutputField>

typedef OutputImageType::Pointer FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::OutputImagePointer

Definition at line 46 of file freVarianceFieldGenerator.h.

template<class TInputVectorField, class TOutputField>

typedef OutputImageType::ValueType FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::OutputValueType

Definition at line 47 of file freVarianceFieldGenerator.h.

template<class TInputVectorField, class TOutputField>

typedef OutputImageType::RegionType FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::OutputRegionType

Definition at line 48 of file freVarianceFieldGenerator.h.

template<class TInputVectorField, class TOutputField>

typedef OutputImageType::PointType FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::OutputPointType

Definition at line 49 of file freVarianceFieldGenerator.h.

---

Constructor & Destructor Documentation

template<class TInputVectorField, class TOutputField>

FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::VarianceFieldGenerator

(

)

[inline]

Definition at line 139 of file freVarianceFieldGenerator.txx.

References FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::Reset().

Here is the call graph for this function:

template<class TInputVectorField, class TOutputField>

FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::~VarianceFieldGenerator

(

)

[inline]

Definition at line 146 of file freVarianceFieldGenerator.txx.

---

Member Function Documentation

template<class TInputVectorField, class TOutputField>

void FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::ResizeSumField

(

const InputImageType *

elementField

)

[inline, private]

Function checks if the sum field must be extendend because of the element field which will be added to the set. Behaviour depends on m_bDynamicResize.

Parameters:

[in]

elementField

Pointer to the field which should be added to the set.

Definition at line 37 of file freVarianceFieldGenerator.txx.

References FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_bUserRegion, FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_iFieldCount, FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_OutputOrigin, FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_OutputRegion, and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_SumField.

Referenced by FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::AddField().

template<class TInputVectorField, class TOutputField>

VarianceFieldGenerator< TInputVectorField, TOutputField >::OutputRegionType FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::GetOutputRegion

(

)

const [inline]

Definition at line 153 of file freVarianceFieldGenerator.txx.

References FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_OutputRegion.

template<class TInputVectorField, class TOutputField>

void FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::SetOutputGeometry	(	const OutputRegionType &	outputRegion,
		const OutputPointType &	origin
	)			[inline]

Definition at line 161 of file freVarianceFieldGenerator.txx.

References FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_bUserRegion, FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_OutputOrigin, and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_OutputRegion.

template<class TInputVectorField, class TOutputField>

VarianceFieldGenerator< TInputVectorField, TOutputField >::InputImagePointer FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::AddField	(	const InputImageType *	pField,
		const InputImageType *	pMeanField
	)			[inline]

Adds the field to the set of fields, that will be used to compute the variance field. The value of the added field will be copied, so after calling the function the added field isn't needed anymore. The function returns the difference field between pField and pMeanField.

Parameters:

[in]	pField	Pointer to a field, that should be used for the calculation.
[in]	pMeanField	Pointer to the mean field, that should be used for the calculation.

Returns:

The difference between pField and pMeanField.

Definition at line 61 of file freVarianceFieldGenerator.txx.

References FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_iFieldCount, FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_OutputRegion, FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_SumField, and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::ResizeSumField().

Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute().

Here is the call graph for this function:

template<class TInputVectorField, class TOutputField>

VarianceFieldGenerator< TInputVectorField, TOutputField >::OutputImagePointer FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::GetOutput

(

void

)

const [inline]

Function creates an output vector field containing the variance vector.

Definition at line 103 of file freVarianceFieldGenerator.txx.

References FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_iFieldCount, and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_SumField.

Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute().

template<class TInputVectorField, class TOutputField>

void FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::Reset

(

)

[inline]

Resets the set of contributing vector fields. After the reset output vector field will be empty as long as no new field has been added.

Definition at line 131 of file freVarianceFieldGenerator.txx.

References FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_bUserRegion, and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_iFieldCount.

Referenced by FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::VarianceFieldGenerator().

---

Member Data Documentation

template<class TInputVectorField, class TOutputField>

OutputImagePointer FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_SumField [private]

Pointer to the vector field containing the sum of all vectors.

Definition at line 53 of file freVarianceFieldGenerator.h.

Referenced by FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::AddField(), FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::GetOutput(), and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::ResizeSumField().

template<class TInputVectorField, class TOutputField>

unsigned int FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_iFieldCount [private]

Count of the elements used to calculate the mean

Definition at line 56 of file freVarianceFieldGenerator.h.

Referenced by FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::AddField(), FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::GetOutput(), FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::Reset(), and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::ResizeSumField().

template<class TInputVectorField, class TOutputField>

bool FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_bUserRegion [private]

Flag indicates if the output region has been set by the user.

Definition at line 60 of file freVarianceFieldGenerator.h.

Referenced by FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::Reset(), FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::ResizeSumField(), and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::SetOutputGeometry().

template<class TInputVectorField, class TOutputField>

OutputRegionType FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_OutputRegion [private]

Definition at line 62 of file freVarianceFieldGenerator.h.

Referenced by FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::AddField(), FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::GetOutputRegion(), FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::ResizeSumField(), and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::SetOutputGeometry().

template<class TInputVectorField, class TOutputField>

OutputPointType FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::m_OutputOrigin [private]

Definition at line 63 of file freVarianceFieldGenerator.h.

Referenced by FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::ResizeSumField(), and FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::SetOutputGeometry().

---

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

• freVarianceFieldGenerator.h
• freVarianceFieldGenerator.txx

---