Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::RigidRegistrationPreset Class Reference

Class to load and save parameter presets for rigid registration. More...

#include <mitkRigidRegistrationPreset.h>

Inheritance diagram for mitk::RigidRegistrationPreset:
Collaboration diagram for mitk::RigidRegistrationPreset:

Public Member Functions

 RigidRegistrationPreset ()
 
 ~RigidRegistrationPreset ()
 
bool LoadPreset ()
 Tries to find mitkRigidRegistrationPresets.xml in /mitk/Config and loads all presets stored in this file. More...
 
bool LoadPreset (std::string fileName)
 Tries to open preset xml file fileName and loads all presets stored in this file. More...
 
itk::Array< double > getTransformValues (std::string name)
 Returns an array including all all transform values belonging to preset name. More...
 
itk::Array< double > getMetricValues (std::string name)
 Returns an array including all all metric values belonging to preset name. More...
 
itk::Array< double > getOptimizerValues (std::string name)
 Returns an array including all all optimizer values belonging to preset name. More...
 
itk::Array< double > getInterpolatorValues (std::string name)
 Returns an array including all interpolator values belonging to preset name. More...
 
std::list< std::string > & getAvailablePresets ()
 
std::map< std::string, itk::Array< double > > & getTransformValuesPresets ()
 Returns a map with all preset names and their according transform values as an array. More...
 
std::map< std::string, itk::Array< double > > & getMetricValuesPresets ()
 Returns a map with all preset names and their according metric values as an array. More...
 
std::map< std::string, itk::Array< double > > & getOptimizerValuesPresets ()
 Returns a map with all preset names and their according optimizer values as an array. More...
 
std::map< std::string, itk::Array< double > > & getInterpolatorValuesPresets ()
 Returns a map with all preset names and their according interpolator values as an array. More...
 
bool newPresets (std::map< std::string, itk::Array< double >> newTransformValues, std::map< std::string, itk::Array< double >> newMetricValues, std::map< std::string, itk::Array< double >> newOptimizerValues, std::map< std::string, itk::Array< double >> newInterpolatorValues, std::string fileName="")
 Saves new presets in the previous opened xml file or in the new fileName location. More...
 

Detailed Description

Class to load and save parameter presets for rigid registration.

This class stores parameter presets for rigid registration applications. To that belong parameters for transformations, metrics, optimizer and interpolators. The presets will be stored in a xml file. Existing presets can be opened with LoadPreset() and saved with newPresets(...).

Author
Daniel Stein

Definition at line 46 of file mitkRigidRegistrationPreset.h.

Constructor & Destructor Documentation

mitk::RigidRegistrationPreset::RigidRegistrationPreset ( )

Definition at line 30 of file mitkRigidRegistrationPreset.cpp.

mitk::RigidRegistrationPreset::~RigidRegistrationPreset ( )

Definition at line 36 of file mitkRigidRegistrationPreset.cpp.

Member Function Documentation

std::list< std::string > & mitk::RigidRegistrationPreset::getAvailablePresets ( )

Definition at line 161 of file mitkRigidRegistrationPreset.cpp.

itk::Array< double > mitk::RigidRegistrationPreset::getInterpolatorValues ( std::string  name)

Returns an array including all interpolator values belonging to preset name.

Definition at line 156 of file mitkRigidRegistrationPreset.cpp.

std::map< std::string, itk::Array< double > > & mitk::RigidRegistrationPreset::getInterpolatorValuesPresets ( )

Returns a map with all preset names and their according interpolator values as an array.

Definition at line 188 of file mitkRigidRegistrationPreset.cpp.

itk::Array< double > mitk::RigidRegistrationPreset::getMetricValues ( std::string  name)

Returns an array including all all metric values belonging to preset name.

Definition at line 154 of file mitkRigidRegistrationPreset.cpp.

std::map< std::string, itk::Array< double > > & mitk::RigidRegistrationPreset::getMetricValuesPresets ( )

Returns a map with all preset names and their according metric values as an array.

Definition at line 178 of file mitkRigidRegistrationPreset.cpp.

itk::Array< double > mitk::RigidRegistrationPreset::getOptimizerValues ( std::string  name)

Returns an array including all all optimizer values belonging to preset name.

Definition at line 155 of file mitkRigidRegistrationPreset.cpp.

Referenced by mitk::RegistrationInterfaceCommand< TRegistration, TPixel >::Execute().

std::map< std::string, itk::Array< double > > & mitk::RigidRegistrationPreset::getOptimizerValuesPresets ( )

Returns a map with all preset names and their according optimizer values as an array.

Definition at line 183 of file mitkRigidRegistrationPreset.cpp.

itk::Array< double > mitk::RigidRegistrationPreset::getTransformValues ( std::string  name)

Returns an array including all all transform values belonging to preset name.

Definition at line 153 of file mitkRigidRegistrationPreset.cpp.

Referenced by mitk::RegistrationInterfaceCommand< TRegistration, TPixel >::Execute().

std::map< std::string, itk::Array< double > > & mitk::RigidRegistrationPreset::getTransformValuesPresets ( )

Returns a map with all preset names and their according transform values as an array.

Definition at line 173 of file mitkRigidRegistrationPreset.cpp.

bool mitk::RigidRegistrationPreset::LoadPreset ( )

Tries to find mitkRigidRegistrationPresets.xml in /mitk/Config and loads all presets stored in this file.

Definition at line 37 of file mitkRigidRegistrationPreset.cpp.

Referenced by mitk::RegistrationInterfaceCommand< TRegistration, TPixel >::Execute(), and mitk::PyramidalRegistrationMethod::PyramidalRegistrationMethod().

bool mitk::RigidRegistrationPreset::LoadPreset ( std::string  fileName)

Tries to open preset xml file fileName and loads all presets stored in this file.

Definition at line 38 of file mitkRigidRegistrationPreset.cpp.

References ModuleContext::GetModule(), us::GetModuleContext(), and MITK_INFO.

bool mitk::RigidRegistrationPreset::newPresets ( std::map< std::string, itk::Array< double >>  newTransformValues,
std::map< std::string, itk::Array< double >>  newMetricValues,
std::map< std::string, itk::Array< double >>  newOptimizerValues,
std::map< std::string, itk::Array< double >>  newInterpolatorValues,
std::string  fileName = "" 
)

Saves new presets in the previous opened xml file or in the new fileName location.

Every old entry will be removed from the xml file and replaced by the ones stored in the parameter maps. Make sure you have the old presets as well as the new ones within the maps.

Definition at line 61 of file mitkRigidRegistrationPreset.cpp.


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