elastix::ParameterObject Class Reference

#include <elxParameterObject.h>

Detailed Description

Definition at line 34 of file elxParameterObject.h.

Inheritance diagram for elastix::ParameterObject:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef std::string	ParameterFileNameType
typedef ParameterFileNameVectorType::const_iterator	ParameterFileNameVectorConstIterator
typedef ParameterFileNameVectorType::iterator	ParameterFileNameVectorIterator
typedef std::vector< ParameterFileNameType >	ParameterFileNameVectorType
typedef ParameterFileParserType::Pointer	ParameterFileParserPointer
typedef itk::ParameterFileParser	ParameterFileParserType
typedef std::string	ParameterKeyType
typedef ParameterMapType::const_iterator	ParameterMapConstIterator
typedef ParameterMapType::iterator	ParameterMapIterator
typedef std::map< ParameterKeyType, ParameterValueVectorType >	ParameterMapType
typedef std::vector< ParameterMapType >	ParameterMapVectorType
typedef std::string	ParameterValueType
typedef ParameterValueVectorType::iterator	ParameterValueVectorIterator
typedef std::vector< ParameterValueType >	ParameterValueVectorType
typedef itk::SmartPointer< Self >	Pointer
typedef ParameterObject	Self

Public Member Functions
void	AddParameterFile (const ParameterFileNameType &parameterFileName)
void	AddParameterMap (const ParameterMapType &parameterMap)
virtual const char *	GetClassName () const
unsigned int	GetNumberOfParameterMaps () const
const ParameterValueVectorType &	GetParameter (const unsigned int &index, const ParameterKeyType &key)
virtual const ParameterMapVectorType &	GetParameterMap ()
const ParameterMapType &	GetParameterMap (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 &parameterMap)
void	SetParameterMap (const unsigned int &index, const ParameterMapType &parameterMap)
void	WriteParameterFile (const ParameterFileNameType &parameterFileName)
void	WriteParameterFile (const ParameterFileNameVectorType &parameterFileNameVector)
void	WriteParameterFile (const ParameterMapType &parameterMap, const ParameterFileNameType &parameterFileName)
void	WriteParameterFile (const ParameterMapVectorType &parameterMapVector, const ParameterFileNameVectorType &parameterFileNameVector)
void	WriteParameterFile (void)

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 ()

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

Private Attributes
ParameterMapVectorType	m_ParameterMap

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer< const Self > elastix::ParameterObject::ConstPointer

Definition at line 40 of file elxParameterObject.h.

ParameterFileNameType

typedef std::string elastix::ParameterObject::ParameterFileNameType

Definition at line 52 of file elxParameterObject.h.

ParameterFileNameVectorConstIterator

typedef ParameterFileNameVectorType::const_iterator elastix::ParameterObject::ParameterFileNameVectorConstIterator

Definition at line 55 of file elxParameterObject.h.

ParameterFileNameVectorIterator

typedef ParameterFileNameVectorType::iterator elastix::ParameterObject::ParameterFileNameVectorIterator

Definition at line 54 of file elxParameterObject.h.

ParameterFileNameVectorType

typedef std::vector< ParameterFileNameType > elastix::ParameterObject::ParameterFileNameVectorType

Definition at line 53 of file elxParameterObject.h.

ParameterFileParserPointer

typedef ParameterFileParserType::Pointer elastix::ParameterObject::ParameterFileParserPointer

Definition at line 57 of file elxParameterObject.h.

ParameterFileParserType

typedef itk::ParameterFileParser elastix::ParameterObject::ParameterFileParserType

Definition at line 56 of file elxParameterObject.h.

ParameterKeyType

typedef std::string elastix::ParameterObject::ParameterKeyType

Definition at line 44 of file elxParameterObject.h.

ParameterMapConstIterator

typedef ParameterMapType::const_iterator elastix::ParameterObject::ParameterMapConstIterator

Definition at line 50 of file elxParameterObject.h.

ParameterMapIterator

typedef ParameterMapType::iterator elastix::ParameterObject::ParameterMapIterator

Definition at line 49 of file elxParameterObject.h.

ParameterMapType

typedef std::map< ParameterKeyType, ParameterValueVectorType > elastix::ParameterObject::ParameterMapType

Definition at line 48 of file elxParameterObject.h.

ParameterMapVectorType

typedef std::vector< ParameterMapType > elastix::ParameterObject::ParameterMapVectorType

Definition at line 51 of file elxParameterObject.h.

ParameterValueType

typedef std::string elastix::ParameterObject::ParameterValueType

Definition at line 45 of file elxParameterObject.h.

ParameterValueVectorIterator

typedef ParameterValueVectorType::iterator elastix::ParameterObject::ParameterValueVectorIterator

Definition at line 47 of file elxParameterObject.h.

ParameterValueVectorType

typedef std::vector< ParameterValueType > elastix::ParameterObject::ParameterValueVectorType

Definition at line 46 of file elxParameterObject.h.

Pointer

typedef itk::SmartPointer< Self > elastix::ParameterObject::Pointer

Definition at line 39 of file elxParameterObject.h.

Self

typedef ParameterObject elastix::ParameterObject::Self

Definition at line 38 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 67 of file elxParameterObject.h.

GetParameter()

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

GetParameterMap() [1/2]

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

virtual

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 &

parameterMap

)

SetParameterMap() [3/3]

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

WriteParameterFile() [1/5]

void elastix::ParameterObject::WriteParameterFile

(

const ParameterFileNameType &

parameterFileName

)

WriteParameterFile() [2/5]

void elastix::ParameterObject::WriteParameterFile

(

const ParameterFileNameVectorType &

parameterFileNameVector

)

WriteParameterFile() [3/5]

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

WriteParameterFile() [4/5]

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

WriteParameterFile() [5/5]

void elastix::ParameterObject::WriteParameterFile

(

void

)

Field Documentation

m_ParameterMap

ParameterMapVectorType elastix::ParameterObject::m_ParameterMap

private

Definition at line 98 of file elxParameterObject.h.