#include <freVectorFieldSetVarianceCalculator.h>
VectorFieldSetVarianceCalculator can be used to calculate differenc characteristics (mean, variance, min max) from a set of vector fields. Therefore the mean vector field (MVF) of the given set will be calculated. MVF will be used to calculate a difference vector field (DVF) for every vector field in the set. From this set of DVF the characteristics will be calculated: a mean difference vector field and variance vector field
Definition at line 47 of file freVectorFieldSetVarianceCalculator.h.
| typedef ImageTypes<VImageDimension>::TransformationFieldType FREE::VectorFieldSetVarianceCalculator< VImageDimension >::VectorFieldType |
Definition at line 51 of file freVectorFieldSetVarianceCalculator.h.
| typedef VectorFieldType::Pointer FREE::VectorFieldSetVarianceCalculator< VImageDimension >::VectorFieldPointer |
Definition at line 52 of file freVectorFieldSetVarianceCalculator.h.
| typedef std::vector< VectorFieldPointer > FREE::VectorFieldSetVarianceCalculator< VImageDimension >::VectorFieldArrayType |
Definition at line 53 of file freVectorFieldSetVarianceCalculator.h.
| typedef ImageTypes<VImageDimension>::InternalImageType FREE::VectorFieldSetVarianceCalculator< VImageDimension >::VarianceFieldType |
Definition at line 55 of file freVectorFieldSetVarianceCalculator.h.
| typedef VarianceFieldType::Pointer FREE::VectorFieldSetVarianceCalculator< VImageDimension >::VarianceFieldPointer |
Definition at line 56 of file freVectorFieldSetVarianceCalculator.h.
| FREE::VectorFieldSetVarianceCalculator< VImageDimension >::VectorFieldSetVarianceCalculator | ( | ) | [inline] |
Constructor. The constructor is defined as protected, because the class RegistratorBase should not be directly used. Only derived classes implementing needed virtual functions (e.g. Registrator3D), may be used.
Definition at line 214 of file freVectorFieldSetVarianceCalculator.txx.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_bFieldsOnDisk, and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset().

| FREE::VectorFieldSetVarianceCalculator< VImageDimension >::~VectorFieldSetVarianceCalculator | ( | ) | [inline, virtual] |
Definition at line 222 of file freVectorFieldSetVarianceCalculator.txx.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset().

| virtual const char* FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetNameOfClass | ( | ) | const [inline, virtual] |
Definition at line 58 of file freVectorFieldSetVarianceCalculator.h.
| void FREE::VectorFieldSetVarianceCalculator< VImageDimension >::ComputeDifferenceVectorFields | ( | ) | [protected] |
Function computes all DVFs by using the MVF and stores them.
| void FREE::VectorFieldSetVarianceCalculator< VImageDimension >::ComputeVarianceDifferenceField | ( | ) | [protected] |
Function computes the mean variance field out of all DVF and stores it in m_smpVarianceDifferenceField.
| void FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetVectorField | ( | const VectorFieldPointer & | smpField, | |
| unsigned int | iIndex | |||
| ) | [inline, protected] |
Saves a vector field temporarily for further use. The saving location depends on m_bFieldsOnDisk. If it is true the transformation file will be saved as file in a path specified by m_sFieldsPath. Otherwise it will be stored in m_VectorFields, so it will stay in memory.
| [in] | smpField | Smartpointer to the field that schould be stored. |
| [in] | iIndex | Index used to generate the file name if needed. |
| [in] | smpField | Smartpointer to the field that schould be stored. |
| [in] | iIndex | Index used to generate the file name if needed. |
Definition at line 83 of file freVectorFieldSetVarianceCalculator.txx.
References catchAllNPassMacro, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorFieldName(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_bFieldsOnDisk, and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_VectorFields.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::AddVectorField(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute().

| VectorFieldSetVarianceCalculator< VImageDimension >::VectorFieldPointer FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorField | ( | unsigned int | iIndex | ) | [inline, protected] |
Get a vector field. The location for retrieval depends on m_bFieldsOnDisk. If it is true the transformation file will be loaded from file in a path specified by m_sFieldsPath. Otherwise it will be retrieved from m_VectorFields. If no TransformationField with the given index/filename can be found an exception will be raised.
| [in] | iIndex | Index used to indentify the field (index of the field vector or part of the file name). |
| [in] | iIndex | Index used to indentify the field (index of the field vector or part of the file name). |
Definition at line 123 of file freVectorFieldSetVarianceCalculator.txx.
References catchAllNPassMacro, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorFieldName(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_bFieldsOnDisk, and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_VectorFields.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute().

| void FREE::VectorFieldSetVarianceCalculator< VImageDimension >::ClearVectorFields | ( | ) | [inline, protected] |
Removes all vector fields from m_VectorFields or deletes the tempory field files if they are stored on disc (m_bFieldsOnDisc = true)
Definition at line 155 of file freVectorFieldSetVarianceCalculator.txx.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorFieldName(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_bFieldsOnDisk, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_iSetSize, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_VectorFields, and throwExceptionMacro.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset().

| std::string FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorFieldName | ( | unsigned int | iIndex | ) | [inline, protected] |
Generates the path/filename for a specified sample of the set, by combining path, name of the calculation and the passed index.
Pattern: [m_sFieldsPath]/VFSDifference_Smpl_[iIndex].mhd
| iIndex | Index used to generate the name |
Definition at line 174 of file freVectorFieldSetVarianceCalculator.txx.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_sFieldsPath, and FREE::Convert::ToStr().
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::ClearVectorFields(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorField(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetVectorField().

| static const int FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetDimension | ( | ) | [inline, static] |
Function returns the dimension, the evaluator will process.
Definition at line 125 of file freVectorFieldSetVarianceCalculator.h.
| void FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetFieldsPath | ( | std::string | sPath | ) | [inline] |
Function to access the member variable m_sFieldsPath.
| [in] | sPath | Path where the fields will be stored. |
Definition at line 129 of file freVectorFieldSetVarianceCalculator.h.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_sFieldsPath.
| const std::string FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetFieldsPath | ( | ) | const [inline] |
Function to access the member variable m_sFieldsPath.
Definition at line 133 of file freVectorFieldSetVarianceCalculator.h.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_sFieldsPath.
| void FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetSaveFieldsOnDisk | ( | bool | bOnDisk | ) | [inline] |
Function to access the member variable m_bFieldsOnDisk.
| [in] | bOnDisk | Boolean, indicates if transformation should be stored on disk or kept in memory. |
Definition at line 138 of file freVectorFieldSetVarianceCalculator.h.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_bFieldsOnDisk.
| const bool FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetSaveFieldsOnDisk | ( | ) | const [inline] |
Function to access the member variable m_bFieldsOnDisk.
Definition at line 142 of file freVectorFieldSetVarianceCalculator.h.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_bFieldsOnDisk.
| void FREE::VectorFieldSetVarianceCalculator< VImageDimension >::AddVectorField | ( | VectorFieldType * | pVectorField | ) | [inline] |
Adds a vector field to the set, that will be used for calculation.
| pVectorField | Pointer to the vector field, that should be added. |
Definition at line 183 of file freVectorFieldSetVarianceCalculator.txx.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_iSetSize, and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetVectorField().

| const unsigned int FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetSetSize | ( | ) | [inline] |
Function to access the member variable m_iSetSize.
Definition at line 150 of file freVectorFieldSetVarianceCalculator.h.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_iSetSize.
| void FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute | ( | ) | [inline] |
This function starts the calculation.
Definition at line 42 of file freVectorFieldSetVarianceCalculator.txx.
References FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::AddField(), FREE::MeanVectorFieldGenerator< TInputVectorField, TOutputVectorField >::AddField(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::fnOnNewDifferenceVectorField, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::fnOnNextVectorField, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::fnOnProgress, FREE::VarianceFieldGenerator< TInputVectorField, TOutputField >::GetOutput(), FREE::MeanVectorFieldGenerator< TInputVectorField, TOutputVectorField >::GetOutput(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorField(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_iSetSize, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_smpMeanVectorField, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_smpVarianceDifferenceField, and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetVectorField().

| VectorFieldType* FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetMeanVectorField | ( | ) | [inline] |
Returns the MVF computed by the calculator.
Definition at line 157 of file freVectorFieldSetVarianceCalculator.h.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_smpMeanVectorField.
| VarianceFieldType* FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVarianceField | ( | ) | [inline] |
Returns the variance field computed by the calculator.
Definition at line 161 of file freVectorFieldSetVarianceCalculator.h.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_smpVarianceDifferenceField.
| void FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset | ( | ) | [inline] |
Clears the transformation field and resets the evaluator.
Definition at line 192 of file freVectorFieldSetVarianceCalculator.txx.
References FREE::VectorFieldSetVarianceCalculator< VImageDimension >::ClearVectorFields(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::fnOnNewDifferenceVectorField, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::fnOnNextVectorField, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::fnOnProgress, FREE::GetGeneralFREEPath(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_bFieldsOnDisk, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_iSetSize, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_sFieldsPath, FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_smpMeanVectorField, and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_smpVarianceDifferenceField.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::VectorFieldSetVarianceCalculator(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::~VectorFieldSetVarianceCalculator().

VectorFieldPointer FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_smpMeanVectorField [protected] |
Pointer to the final mean vector field..
Definition at line 59 of file freVectorFieldSetVarianceCalculator.h.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetMeanVectorField(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset().
VarianceFieldPointer FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_smpVarianceDifferenceField [protected] |
Pointer to the final variance difference field. Established by calculating the variance of all DVF (pixelwise).
Definition at line 67 of file freVectorFieldSetVarianceCalculator.h.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVarianceField(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset().
std::string FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_sFieldsPath [protected] |
The path where fields should be saved, if m_bFieldsOnDisk is true. Default value is FREE::sGeneralTemporaryPath.
Definition at line 71 of file freVectorFieldSetVarianceCalculator.h.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetFieldsPath(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorFieldName(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetFieldsPath().
bool FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_bFieldsOnDisk [protected] |
Indicates if the calculator stores every field of the evaluation process in a specified path on disk (default) or if it will be kept in memory (This could mean a huge amount of needed memory depending on set size. Space needed: n+2 times the size of one vector field (n: set size)). First option needs less memory but is slower (2*n saving and loading processes; n: set size).
Definition at line 77 of file freVectorFieldSetVarianceCalculator.h.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::ClearVectorFields(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetSaveFieldsOnDisk(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorField(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetSaveFieldsOnDisk(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetVectorField(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::VectorFieldSetVarianceCalculator().
unsigned int FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_iSetSize [protected] |
Size of the set used for calculation.
Definition at line 80 of file freVectorFieldSetVarianceCalculator.h.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::AddVectorField(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::ClearVectorFields(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetSetSize(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset().
VectorFieldArrayType FREE::VectorFieldSetVarianceCalculator< VImageDimension >::m_VectorFields [protected] |
Set of vector fields used for the calculation. If m_bFieldsOnDisk true then the fields won't be stored in the array but on disk (therefore see m_VectorFieldFiles). First the added sample fields will be stored, in the process of ComputeDifferenceVectorFields() the will be replaced with the corresponding DVF.
Definition at line 87 of file freVectorFieldSetVarianceCalculator.h.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::ClearVectorFields(), FREE::VectorFieldSetVarianceCalculator< VImageDimension >::GetVectorField(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::SetVectorField().
| ProgressEventBase::Pointer FREE::VectorFieldSetVarianceCalculator< VImageDimension >::fnOnProgress |
Function pointer, which can be set, if e.g. a GUI interaction is wanted. The function is called, when ever a new section in the calculation process has been reached.
Definition at line 176 of file freVectorFieldSetVarianceCalculator.h.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset().
| ProgressEventBase::Pointer FREE::VectorFieldSetVarianceCalculator< VImageDimension >::fnOnNextVectorField |
Function pointer, which can be set, if e.g. a GUI interaction is wanted. The function is called, when a new vector field will be processed.
Definition at line 180 of file freVectorFieldSetVarianceCalculator.h.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset().
| CallbackEventBase::Pointer FREE::VectorFieldSetVarianceCalculator< VImageDimension >::fnOnNewDifferenceVectorField |
Function pointer, which can be set, if e.g. a GUI interaction is wanted. The function is called, when a new DVF has been generated as interim result. This allows the further use of the interim results. Callback ID indicates the id/position of the DVF which is equal to the vector field which was used to calculate the differences. pData contains the DVF (VectorFieldType*) as void pointer.
Definition at line 188 of file freVectorFieldSetVarianceCalculator.h.
Referenced by FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Compute(), and FREE::VectorFieldSetVarianceCalculator< VImageDimension >::Reset().
1.5.3 written by Dimitri van Heesch,
© 1997-2000