go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes
elastix::ParameterObject Class Reference

#include <elxParameterObject.h>

Detailed Description

Definition at line 32 of file elxParameterObject.h.

Inheritance diagram for elastix::ParameterObject:
Inheritance graph
[legend]

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using ParameterFileNameType = std::string
 
using ParameterFileNameVectorConstIterator = ParameterFileNameVectorType::const_iterator
 
using ParameterFileNameVectorIterator = ParameterFileNameVectorType::iterator
 
using ParameterFileNameVectorType = std::vector< ParameterFileNameType >
 
using ParameterKeyType = std::string
 
using ParameterMapConstIterator = ParameterMapType::const_iterator
 
using ParameterMapIterator = ParameterMapType::iterator
 
using ParameterMapType = std::map< ParameterKeyType, ParameterValueVectorType >
 
using ParameterMapVectorType = std::vector< ParameterMapType >
 
using ParameterValueType = std::string
 
using ParameterValueVectorIterator = ParameterValueVectorType::iterator
 
using ParameterValueVectorType = std::vector< ParameterValueType >
 
using Pointer = itk::SmartPointer< Self >
 
using Self = ParameterObject
 

Public Member Functions

void AddParameterFile (const ParameterFileNameType &parameterFileName)
 
void AddParameterMap (const ParameterMapType &parameterMap)
 
virtual const char * GetClassName () const
 
unsigned int GetNumberOfParameterMaps () const
 
const ParameterValueVectorTypeGetParameter (const unsigned int index, const ParameterKeyType &key)
 
const ParameterMapVectorTypeGetParameterMap () const
 
const ParameterMapTypeGetParameterMap (const unsigned int index) const
 
void ReadParameterFile (const ParameterFileNameType &parameterFileName)
 
void ReadParameterFile (const ParameterFileNameVectorType &parameterFileNameVector)
 
void RemoveParameter (const ParameterKeyType &key)
 
void RemoveParameter (const unsigned int index, const ParameterKeyType &key)
 
void SetParameter (const ParameterKeyType &key, const ParameterValueType &value)
 
void SetParameter (const ParameterKeyType &key, const ParameterValueVectorType &value)
 
void SetParameter (const unsigned int index, const ParameterKeyType &key, const ParameterValueType &value)
 
void SetParameter (const unsigned int index, const ParameterKeyType &key, const ParameterValueVectorType &value)
 
void SetParameterMap (const ParameterMapType &parameterMap)
 
void SetParameterMap (const ParameterMapVectorType &parameterMaps)
 
void SetParameterMap (const unsigned int index, const ParameterMapType &parameterMap)
 
void WriteParameterFile () const
 
void WriteParameterFile (const ParameterFileNameType &parameterFileName) const
 
void WriteParameterFile (const ParameterFileNameVectorType &parameterFileNameVector) const
 

Static Public Member Functions

static const ParameterMapType GetDefaultParameterMap (const std::string &transformName, const unsigned int numberOfResolutions=4u, const double finalGridSpacingInPhysicalUnits=10.0)
 
static Pointer New ()
 
static void WriteParameterFile (const ParameterMapType &parameterMap, const ParameterFileNameType &parameterFileName)
 
static void WriteParameterFile (const ParameterMapVectorType &parameterMapVector, const ParameterFileNameVectorType &parameterFileNameVector)
 

Protected Member Functions

void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Private Attributes

ParameterMapVectorType m_ParameterMaps
 

Member Typedef Documentation

◆ ConstPointer

using elastix::ParameterObject::ConstPointer = itk::SmartPointer<const Self>

Definition at line 37 of file elxParameterObject.h.

◆ ParameterFileNameType

Definition at line 49 of file elxParameterObject.h.

◆ ParameterFileNameVectorConstIterator

using elastix::ParameterObject::ParameterFileNameVectorConstIterator = ParameterFileNameVectorType::const_iterator

Definition at line 52 of file elxParameterObject.h.

◆ ParameterFileNameVectorIterator

using elastix::ParameterObject::ParameterFileNameVectorIterator = ParameterFileNameVectorType::iterator

Definition at line 51 of file elxParameterObject.h.

◆ ParameterFileNameVectorType

Definition at line 50 of file elxParameterObject.h.

◆ ParameterKeyType

Definition at line 41 of file elxParameterObject.h.

◆ ParameterMapConstIterator

using elastix::ParameterObject::ParameterMapConstIterator = ParameterMapType::const_iterator

Definition at line 47 of file elxParameterObject.h.

◆ ParameterMapIterator

using elastix::ParameterObject::ParameterMapIterator = ParameterMapType::iterator

Definition at line 46 of file elxParameterObject.h.

◆ ParameterMapType

Definition at line 45 of file elxParameterObject.h.

◆ ParameterMapVectorType

Definition at line 48 of file elxParameterObject.h.

◆ ParameterValueType

Definition at line 42 of file elxParameterObject.h.

◆ ParameterValueVectorIterator

using elastix::ParameterObject::ParameterValueVectorIterator = ParameterValueVectorType::iterator

Definition at line 44 of file elxParameterObject.h.

◆ ParameterValueVectorType

Definition at line 43 of file elxParameterObject.h.

◆ Pointer

using elastix::ParameterObject::Pointer = itk::SmartPointer<Self>

Definition at line 36 of file elxParameterObject.h.

◆ Self

Definition at line 35 of file elxParameterObject.h.

Member Function Documentation

◆ AddParameterFile()

void elastix::ParameterObject::AddParameterFile ( const ParameterFileNameType parameterFileName)

◆ AddParameterMap()

void elastix::ParameterObject::AddParameterMap ( const ParameterMapType parameterMap)

◆ GetClassName()

virtual const char * elastix::ParameterObject::GetClassName ( ) const
virtual

◆ GetDefaultParameterMap()

static const ParameterMapType elastix::ParameterObject::GetDefaultParameterMap ( const std::string &  transformName,
const unsigned int  numberOfResolutions = 4u,
const double  finalGridSpacingInPhysicalUnits = 10.0 
)
static

◆ GetNumberOfParameterMaps()

unsigned int elastix::ParameterObject::GetNumberOfParameterMaps ( ) const
inline

Definition at line 74 of file elxParameterObject.h.

◆ GetParameter()

const ParameterValueVectorType & elastix::ParameterObject::GetParameter ( const unsigned int  index,
const ParameterKeyType key 
)

◆ GetParameterMap() [1/2]

const ParameterMapVectorType & elastix::ParameterObject::GetParameterMap ( ) const
inline

Definition at line 68 of file elxParameterObject.h.

◆ GetParameterMap() [2/2]

const ParameterMapType & elastix::ParameterObject::GetParameterMap ( const unsigned int  index) const

◆ New()

static Pointer elastix::ParameterObject::New ( )
static

◆ PrintSelf()

void elastix::ParameterObject::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

◆ ReadParameterFile() [1/2]

void elastix::ParameterObject::ReadParameterFile ( const ParameterFileNameType parameterFileName)

◆ ReadParameterFile() [2/2]

void elastix::ParameterObject::ReadParameterFile ( const ParameterFileNameVectorType parameterFileNameVector)

◆ RemoveParameter() [1/2]

void elastix::ParameterObject::RemoveParameter ( const ParameterKeyType key)

◆ RemoveParameter() [2/2]

void elastix::ParameterObject::RemoveParameter ( const unsigned int  index,
const ParameterKeyType key 
)

◆ SetParameter() [1/4]

void elastix::ParameterObject::SetParameter ( const ParameterKeyType key,
const ParameterValueType value 
)

◆ SetParameter() [2/4]

void elastix::ParameterObject::SetParameter ( const ParameterKeyType key,
const ParameterValueVectorType value 
)

◆ SetParameter() [3/4]

void elastix::ParameterObject::SetParameter ( const unsigned int  index,
const ParameterKeyType key,
const ParameterValueType value 
)

◆ SetParameter() [4/4]

void elastix::ParameterObject::SetParameter ( const unsigned int  index,
const ParameterKeyType key,
const ParameterValueVectorType value 
)

◆ SetParameterMap() [1/3]

void elastix::ParameterObject::SetParameterMap ( const ParameterMapType parameterMap)

◆ SetParameterMap() [2/3]

void elastix::ParameterObject::SetParameterMap ( const ParameterMapVectorType parameterMaps)

◆ SetParameterMap() [3/3]

void elastix::ParameterObject::SetParameterMap ( const unsigned int  index,
const ParameterMapType parameterMap 
)

◆ WriteParameterFile() [1/5]

void elastix::ParameterObject::WriteParameterFile ( ) const

◆ WriteParameterFile() [2/5]

void elastix::ParameterObject::WriteParameterFile ( const ParameterFileNameType parameterFileName) const

◆ WriteParameterFile() [3/5]

void elastix::ParameterObject::WriteParameterFile ( const ParameterFileNameVectorType parameterFileNameVector) const

◆ WriteParameterFile() [4/5]

static void elastix::ParameterObject::WriteParameterFile ( const ParameterMapType parameterMap,
const ParameterFileNameType parameterFileName 
)
static

◆ WriteParameterFile() [5/5]

static void elastix::ParameterObject::WriteParameterFile ( const ParameterMapVectorType parameterMapVector,
const ParameterFileNameVectorType parameterFileNameVector 
)
static

Field Documentation

◆ m_ParameterMaps

ParameterMapVectorType elastix::ParameterObject::m_ParameterMaps
private

Definition at line 124 of file elxParameterObject.h.



Generated on 2023-01-13 for elastix by doxygen 1.9.6 elastix logo