#include <elxWeightedCombinationTransform.h>

Detailed Description

template<class TElastix>
class elastix::WeightedCombinationTransformElastix< TElastix >

A transform based on the itk::WeightedCombinationTransform.

This transform is a weighted combination transformation. It implements $T(x) = \sum_i w_i T_i(x)$ .

The transformparameters are the weighting factors for each subtransform . You could use this to implement registration using a statistical deformation model. Each subtransform would then be a principal component that follows from your statistical model for example.

A normalization factor can optionally be used: $T(x) = \sum_i w_i T_i(x) / \sum_i w_i$

You can also use this class to average transformations found by previous elastix runs.

The parameters used in this class are:

Parameters:

Transform: Select this transform as follows:
(Transform "WeightedCombinationTransform")

NormalizeCombinationWeights: use the normalized expression $T(x) = \sum_i w_i T_i(x) / \sum_i w_i$ .
(NormalizeCombinationWeights "true" )
Default value: "false". Different values in each resolution are not supported.

SubTransforms: a list of transform parameter filenames that will serve as subtransforms .
(SubTransforms "tp0.txt" "TransformParameters.1.txt" "tpbspline.txt" )

AutomaticScalesEstimation: if this parameter is set to "true" the Scales parameter is ignored and the scales are determined automatically.
example: (AutomaticScalesEstimation "true")
Default: "false".

Scales: The scale factor for each transform parameter, during optimization.
If your input subtransforms have very different magnitudes, you may compensate for that by supplying scales, which will make the optimization CostFunction better behaving. For subtransforms with a high magnitude, provide a large scale then. NB: not in all cases you may want this. example: (Scales 1.0 1.0 10.0)
Default: 1 for each parameter. See also AutomaticScalesEstimation, which is more convenient.

The transform parameters necessary for transformix, additionally defined by this class, are:

Transform Parameters:

NormalizeCombinationWeights: use the normalized expression $T(x) = \sum_i w_i T_i(x) / \sum_i w_i$ .
(NormalizeCombinationWeights "true" )
Default value: "false". Different values in each resolution are not supported.

SubTransforms: a list of transform parameter filenames that will serve as subtransforms .
(SubTransforms "tp0.txt" "TransformParameters.1.txt" "tpbspline.txt" )

See also: WeightedCombinationTransform

Definition at line 82 of file elxWeightedCombinationTransform.h.

Inheritance diagram for elastix::WeightedCombinationTransformElastix< TElastix >:

Public Types
typedef Superclass2::CombinationTransformType	CombinationTransformType

typedef Superclass2::CommandLineArgumentMapType	CommandLineArgumentMapType

typedef Superclass2::CommandLineEntryType	CommandLineEntryType

typedef Superclass2::ConfigurationPointer	ConfigurationPointer

typedef Superclass2::ConfigurationType	ConfigurationType

typedef itk::SmartPointer< const Self >	ConstPointer

typedef Superclass2::CoordRepType	CoordRepType

typedef Superclass2::ElastixPointer	ElastixPointer

typedef Superclass2::ElastixType	ElastixType

typedef Superclass2::FixedImageType	FixedImageType

typedef Superclass1::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass1::InputPointType	InputPointType

typedef Superclass1::InputVectorType	InputVectorType

typedef Superclass1::InputVnlVectorType	InputVnlVectorType

typedef Superclass2::ITKBaseType	ITKBaseType

typedef Superclass1::JacobianType	JacobianType

typedef Superclass2::MovingImageType	MovingImageType

typedef Superclass1::NumberOfParametersType	NumberOfParametersType

typedef Superclass1::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass1::OutputPointType	OutputPointType

typedef Superclass1::OutputVectorType	OutputVectorType

typedef Superclass1::OutputVnlVectorType	OutputVnlVectorType

typedef Superclass1::ParametersType	ParametersType

typedef itk::SmartPointer< Self >	Pointer

typedef Superclass2::RegistrationPointer	RegistrationPointer

typedef Superclass2::RegistrationType	RegistrationType

typedef Superclass1::ScalarType	ScalarType

typedef Superclass2::ScalesType	ScalesType

typedef WeightedCombinationTransformElastix	Self

typedef WeightedCombinationTransformType::TransformPointer	SubTransformPointer

typedef WeightedCombinationTransformType::TransformType	SubTransformType

typedef itk::AdvancedCombinationTransform< typename elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension >	Superclass1

typedef elx::TransformBase< TElastix >	Superclass2

typedef WeightedCombinationTransformType::TransformContainerType	TransformContainerType

typedef WeightedCombinationTransformType::Pointer	WeightedCombinationTransformPointer

typedef itk::WeightedCombinationTransform< typename elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension, elx::TransformBase< TElastix >::MovingImageDimension >	WeightedCombinationTransformType

Public Types inherited from itk::AdvancedCombinationTransform< elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension >
typedef SmartPointer< const Self >	ConstPointer

typedef CurrentTransformType::ConstPointer	CurrentTransformConstPointer

typedef CurrentTransformType::InverseTransformBasePointer	CurrentTransformInverseTransformBasePointer

typedef CurrentTransformType::InverseTransformBaseType	CurrentTransformInverseTransformBaseType

typedef CurrentTransformType::Pointer	CurrentTransformPointer

typedef Superclass	CurrentTransformType

typedef Superclass::DerivativeType	DerivativeType

typedef void(Self::*	EvaluateJacobianWithImageGradientProductFunctionPointer) (const InputPointType &, const MovingImageGradientType &, DerivativeType &, NonZeroJacobianIndicesType &) const

typedef Superclass::FixedParametersType	FixedParametersType

typedef void(Self::*	GetJacobianOfSpatialHessianFunctionPointer) (const InputPointType &, JacobianOfSpatialHessianType &, NonZeroJacobianIndicesType &) const

typedef void(Self::*	GetJacobianOfSpatialHessianFunctionPointer2) (const InputPointType &, SpatialHessianType &, JacobianOfSpatialHessianType &, NonZeroJacobianIndicesType &) const

typedef void(Self::*	GetJacobianOfSpatialJacobianFunctionPointer) (const InputPointType &, JacobianOfSpatialJacobianType &, NonZeroJacobianIndicesType &) const

typedef void(Self::*	GetJacobianOfSpatialJacobianFunctionPointer2) (const InputPointType &, SpatialJacobianType &, JacobianOfSpatialJacobianType &, NonZeroJacobianIndicesType &) const

typedef void(Self::*	GetSparseJacobianFunctionPointer) (const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const

typedef void(Self::*	GetSpatialHessianFunctionPointer) (const InputPointType &, SpatialHessianType &) const

typedef void(Self::*	GetSpatialJacobianFunctionPointer) (const InputPointType &, SpatialJacobianType &) const

typedef InitialTransformType::ConstPointer	InitialTransformConstPointer

typedef InitialTransformType::InverseTransformBasePointer	InitialTransformInverseTransformBasePointer

typedef InitialTransformType::InverseTransformBaseType	InitialTransformInverseTransformBaseType

typedef InitialTransformType::Pointer	InitialTransformPointer

typedef Superclass	InitialTransformType

typedef Superclass::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass::InputPointType	InputPointType

typedef Superclass::InputVectorType	InputVectorType

typedef Superclass::InputVnlVectorType	InputVnlVectorType

typedef Superclass::InternalMatrixType	InternalMatrixType

typedef Superclass::InverseTransformBasePointer	InverseTransformBasePointer

typedef Superclass::InverseTransformBaseType	InverseTransformBaseType

typedef Superclass::JacobianOfSpatialHessianType	JacobianOfSpatialHessianType

typedef Superclass::JacobianOfSpatialJacobianType	JacobianOfSpatialJacobianType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::MovingImageGradientType	MovingImageGradientType

typedef Superclass::MovingImageGradientValueType	MovingImageGradientValueType

typedef Superclass::NonZeroJacobianIndicesType	NonZeroJacobianIndicesType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::OutputVectorType	OutputVectorType

typedef Superclass::OutputVnlVectorType	OutputVnlVectorType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalarType	ScalarType

typedef AdvancedCombinationTransform	Self

typedef Superclass::SpatialHessianType	SpatialHessianType

typedef Superclass::SpatialJacobianType	SpatialJacobianType

typedef AdvancedTransform< elx::TransformBase< TElastix >::CoordRepType, NDimensions, NDimensions >	Superclass

typedef Superclass::TransformCategoryEnum	TransformCategoryEnum

typedef OutputPointType(Self::*	TransformPointFunctionPointer) (const InputPointType &) const

typedef Superclass::TransformType	TransformType

typedef TransformType::ConstPointer	TransformTypeConstPointer

typedef TransformType::Pointer	TransformTypePointer

Public Types inherited from itk::AdvancedTransform< elx::TransformBase< TElastix >::CoordRepType, NDimensions, NDimensions >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::FixedParametersType	FixedParametersType

typedef Superclass::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass::InputPointType	InputPointType

typedef Superclass::InputVectorType	InputVectorType

typedef Superclass::InputVnlVectorType	InputVnlVectorType

typedef SpatialJacobianType::InternalMatrixType	InternalMatrixType

typedef Superclass::InverseTransformBasePointer	InverseTransformBasePointer

typedef Superclass::InverseTransformBaseType	InverseTransformBaseType

typedef std::vector< SpatialHessianType >	JacobianOfSpatialHessianType

typedef std::vector< SpatialJacobianType >	JacobianOfSpatialJacobianType

typedef Superclass::JacobianType	JacobianType

typedef OutputCovariantVectorType	MovingImageGradientType

typedef MovingImageGradientType::ValueType	MovingImageGradientValueType

typedef std::vector< unsigned long >	NonZeroJacobianIndicesType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::OutputVectorType	OutputVectorType

typedef Superclass::OutputVnlVectorType	OutputVnlVectorType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalarType	ScalarType

typedef AdvancedTransform	Self

typedef FixedArray< Matrix< ScalarType, InputSpaceDimension, InputSpaceDimension >, OutputSpaceDimension >	SpatialHessianType

typedef Matrix< ScalarType, OutputSpaceDimension, InputSpaceDimension >	SpatialJacobianType

typedef Transform< elx::TransformBase< TElastix >::CoordRepType, NInputDimensions, NOutputDimensions >	Superclass

typedef Transform< elx::TransformBase< TElastix >::CoordRepType, NInputDimensions, NOutputDimensions >	TransformType

typedef TransformType::ConstPointer	TransformTypeConstPointer

typedef TransformType::Pointer	TransformTypePointer

Public Types inherited from elastix::TransformBase< TElastix >
typedef itk::AdvancedCombinationTransform< CoordRepType, itkGetStaticConstMacro(FixedImageDimension) >	CombinationTransformType

typedef ConfigurationType::CommandLineArgumentMapType	CommandLineArgumentMapType

typedef ConfigurationType::CommandLineEntryType	CommandLineEntryType

typedef ComponentDatabase	ComponentDatabaseType

typedef ComponentDatabaseType::ComponentDescriptionType	ComponentDescriptionType

typedef Configuration::Pointer	ConfigurationPointer

typedef Configuration	ConfigurationType

typedef ElastixType::CoordRepType	CoordRepType

typedef itk::Image< VectorPixelType, FixedImageDimension >	DeformationFieldImageType

typedef itk::WeakPointer< ElastixType >	ElastixPointer

typedef TElastix	ElastixType

typedef ElastixType::FixedImageType	FixedImageType

typedef CombinationTransformType::InitialTransformType	InitialTransformType

typedef ITKBaseType::InputPointType	InputPointType

typedef itk::AdvancedTransform< CoordRepType, itkGetStaticConstMacro(FixedImageDimension), itkGetStaticConstMacro(MovingImageDimension) >	ITKBaseType

typedef RegistrationType::ITKBaseType	ITKRegistrationType

typedef ElastixType::MovingImageType	MovingImageType

typedef itk::Object	ObjectType

typedef ITKRegistrationType::OptimizerType	OptimizerType

typedef ITKBaseType::OutputPointType	OutputPointType

typedef ElastixType::ParameterMapType	ParameterMapType

typedef ITKBaseType::ParametersType	ParametersType

typedef elx::ProgressCommand	ProgressCommandType

typedef ComponentDatabase::PtrToCreator	PtrToCreator

typedef RegistrationType *	RegistrationPointer

typedef ElastixType::RegistrationBaseType	RegistrationType

typedef OptimizerType::ScalesType	ScalesType

typedef TransformBase	Self

typedef BaseComponentSE< TElastix >	Superclass

typedef ParametersType::ValueType	ValueType

typedef itk::Vector< float, FixedImageDimension >	VectorPixelType

Public Types inherited from elastix::BaseComponentSE< TElastix >
typedef Configuration::Pointer	ConfigurationPointer

typedef Configuration	ConfigurationType

typedef itk::WeakPointer< ElastixType >	ElastixPointer

typedef TElastix	ElastixType

typedef RegistrationType *	RegistrationPointer

typedef ElastixType::RegistrationBaseType	RegistrationType

typedef BaseComponentSE	Self

typedef BaseComponent	Superclass

Public Member Functions
void	BeforeRegistration (void) override

	elxClassNameMacro ("WeightedCombinationTransform")

virtual const char *	GetClassName () const

virtual void	InitializeTransform (void)

	itkStaticConstMacro (SpaceDimension, unsigned int, Superclass2::FixedImageDimension)

virtual void	LoadSubTransforms (void)

void	ReadFromFile (void) override

virtual void	SetScales (void)

void	WriteToFile (const ParametersType &param) const override

Public Member Functions inherited from itk::AdvancedCombinationTransform< elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension >
void	EvaluateJacobianWithImageGradientProduct (const InputPointType &ipp, const MovingImageGradientType &movingImageGradient, DerivativeType &imageJacobian, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

virtual const char *	GetClassName () const

const FixedParametersType &	GetFixedParameters (void) const override

bool	GetHasNonZeroSpatialHessian (void) const override

virtual bool	GetInverse (Self *inverse) const

void	GetJacobian (const InputPointType &ipp, JacobianType &j, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

void	GetJacobianOfSpatialHessian (const InputPointType &ipp, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

void	GetJacobianOfSpatialHessian (const InputPointType &ipp, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

void	GetJacobianOfSpatialJacobian (const InputPointType &ipp, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

void	GetJacobianOfSpatialJacobian (const InputPointType &ipp, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

virtual const TransformTypePointer	GetNthTransform (SizeValueType n) const

NumberOfParametersType	GetNumberOfNonZeroJacobianIndices (void) const override

NumberOfParametersType	GetNumberOfParameters (void) const override

virtual SizeValueType	GetNumberOfTransforms (void) const

const ParametersType &	GetParameters (void) const override

void	GetSpatialHessian (const InputPointType &ipp, SpatialHessianType &sh) const override

void	GetSpatialJacobian (const InputPointType &ipp, SpatialJacobianType &sj) const override

TransformCategoryEnum	GetTransformCategory () const override

virtual bool	GetUseAddition () const

virtual bool	GetUseComposition () const

virtual bool	HasNonZeroJacobianOfSpatialHessian (void) const

bool	IsLinear (void) const override

	itkGetModifiableObjectMacro (CurrentTransform, CurrentTransformType)

	itkGetModifiableObjectMacro (InitialTransform, InitialTransformType)

	itkStaticConstMacro (SpaceDimension, unsigned int, NDimensions)

virtual void	SetCurrentTransform (CurrentTransformType *_arg)

void	SetFixedParameters (const FixedParametersType &fixedParam) override

virtual void	SetInitialTransform (InitialTransformType *_arg)

void	SetParameters (const ParametersType &param) override

void	SetParametersByValue (const ParametersType &param) override

virtual void	SetUseAddition (bool _arg)

virtual void	SetUseComposition (bool _arg)

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const override

OutputPointType	TransformPoint (const InputPointType &point) const override

OutputVectorType	TransformVector (const InputVectorType &) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const override

Public Member Functions inherited from itk::AdvancedTransform< elx::TransformBase< TElastix >::CoordRepType, NDimensions, NDimensions >
void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override

virtual void	EvaluateJacobianWithImageGradientProduct (const InputPointType &ipp, const MovingImageGradientType &movingImageGradient, DerivativeType &imageJacobian, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

virtual const char *	GetClassName () const

virtual bool	GetHasNonZeroJacobianOfSpatialHessian () const

virtual bool	GetHasNonZeroSpatialHessian () const

virtual void	GetJacobian (const InputPointType &ipp, JacobianType &j, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual void	GetJacobianOfSpatialHessian (const InputPointType &ipp, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual void	GetJacobianOfSpatialHessian (const InputPointType &ipp, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual void	GetJacobianOfSpatialJacobian (const InputPointType &ipp, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual void	GetJacobianOfSpatialJacobian (const InputPointType &ipp, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const=0

virtual NumberOfParametersType	GetNumberOfNonZeroJacobianIndices (void) const

virtual void	GetSpatialHessian (const InputPointType &ipp, SpatialHessianType &sh) const=0

virtual void	GetSpatialJacobian (const InputPointType &ipp, SpatialJacobianType &sj) const=0

	itkStaticConstMacro (InputSpaceDimension, unsigned int, NInputDimensions)

	itkStaticConstMacro (OutputSpaceDimension, unsigned int, NOutputDimensions)

Public Member Functions inherited from elastix::TransformBase< TElastix >
void	AfterRegistrationBase (void) override

int	BeforeAllBase (void) override

virtual int	BeforeAllTransformix (void)

void	BeforeRegistrationBase (void) override

virtual void	ComputeDeterminantOfSpatialJacobian (void) const

virtual void	ComputeSpatialJacobian (void) const

virtual void	CreateTransformParametersMap (const ParametersType &param, ParameterMapType *paramsMap) const

DeformationFieldImageType::Pointer	GenerateDeformationFieldImage (void) const

virtual CombinationTransformType *	GetAsCombinationTransform (void)

virtual const CombinationTransformType *	GetAsCombinationTransform (void) const

virtual ITKBaseType *	GetAsITKBaseType (void)

virtual const ITKBaseType *	GetAsITKBaseType (void) const

virtual const char *	GetClassName () const

virtual const InitialTransformType *	GetInitialTransform (void) const

virtual const char *	GetTransformParametersFileName () const

	ITK_DISALLOW_COPY_AND_ASSIGN (TransformBase)

	itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)

	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)

virtual void	ReadFromFile (void)

virtual void	ReadInitialTransformFromFile (const char *transformParameterFileName)

virtual void	ReadInitialTransformFromVector (const vcl_size_t index)

virtual void	SetFinalParameters (void)

virtual void	SetInitialTransform (InitialTransformType *_arg)

virtual void	SetReadWriteTransformParameters (const bool _arg)

virtual void	SetTransformParametersFileName (const char *filename)

virtual void	TransformPoints (void) const

virtual void	TransformPointsAllPoints (void) const

virtual void	TransformPointsSomePoints (const std::string filename) const

virtual void	TransformPointsSomePointsVTK (const std::string filename) const

void	WriteDeformationFieldImage (typename DeformationFieldImageType::Pointer) const

virtual void	WriteToFile (const ParametersType &param) const

virtual void	WriteToFile (void) const

Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
ConfigurationType *	GetConfiguration (void) const

ElastixType *	GetElastix (void) const

RegistrationPointer	GetRegistration (void) const

	ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponentSE)

void	SetConfiguration (ConfigurationType *_arg)

void	SetElastix (ElastixType *_arg)

Public Member Functions inherited from elastix::BaseComponent
virtual void	AfterEachIteration (void)

virtual void	AfterEachIterationBase (void)

virtual void	AfterEachResolution (void)

virtual void	AfterEachResolutionBase (void)

virtual void	AfterRegistration (void)

virtual void	AfterRegistrationBase (void)

virtual int	BeforeAll (void)

virtual int	BeforeAllBase (void)

virtual void	BeforeEachResolution (void)

virtual void	BeforeEachResolutionBase (void)

virtual void	BeforeRegistration (void)

virtual void	BeforeRegistrationBase (void)

virtual const char *	elxGetClassName (void) const

const char *	GetComponentLabel (void) const

	ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponent)

	itkTypeMacroNoParent (BaseComponent)

void	SetComponentLabel (const char *label, unsigned int idx)

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::AdvancedCombinationTransform< elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension >
static Pointer	New ()

Static Public Member Functions inherited from elastix::BaseComponent
static std::string	ConvertSecondsToDHMS (const double totalSeconds, const unsigned int precision)

static void	InitializeElastixExecutable ()

static bool	IsElastixLibrary ()

Protected Member Functions
	WeightedCombinationTransformElastix ()

	~WeightedCombinationTransformElastix () override

Protected Member Functions inherited from itk::AdvancedCombinationTransform< elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension >
	AdvancedCombinationTransform ()

void	EvaluateJacobianWithImageGradientProductNoCurrentTransform (const InputPointType &, const MovingImageGradientType &, DerivativeType &, NonZeroJacobianIndicesType &) const

void	EvaluateJacobianWithImageGradientProductNoInitialTransform (const InputPointType &, const MovingImageGradientType &, DerivativeType &, NonZeroJacobianIndicesType &) const

void	EvaluateJacobianWithImageGradientProductUseAddition (const InputPointType &, const MovingImageGradientType &, DerivativeType &, NonZeroJacobianIndicesType &) const

void	EvaluateJacobianWithImageGradientProductUseComposition (const InputPointType &, const MovingImageGradientType &, DerivativeType &, NonZeroJacobianIndicesType &) const

void	GetJacobianNoCurrentTransform (const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const

void	GetJacobianNoInitialTransform (const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const

void	GetJacobianOfSpatialHessianNoCurrentTransform (const InputPointType &ipp, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialHessianNoCurrentTransform (const InputPointType &ipp, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialHessianNoInitialTransform (const InputPointType &ipp, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialHessianNoInitialTransform (const InputPointType &ipp, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialHessianUseAddition (const InputPointType &ipp, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialHessianUseAddition (const InputPointType &ipp, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialHessianUseComposition (const InputPointType &ipp, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

virtual void	GetJacobianOfSpatialHessianUseComposition (const InputPointType &ipp, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialJacobianNoCurrentTransform (const InputPointType &ipp, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialJacobianNoCurrentTransform (const InputPointType &ipp, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialJacobianNoInitialTransform (const InputPointType &ipp, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialJacobianNoInitialTransform (const InputPointType &ipp, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialJacobianUseAddition (const InputPointType &ipp, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialJacobianUseAddition (const InputPointType &ipp, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialJacobianUseComposition (const InputPointType &ipp, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianOfSpatialJacobianUseComposition (const InputPointType &ipp, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

void	GetJacobianUseAddition (const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const

void	GetJacobianUseComposition (const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const

void	GetSpatialHessianNoCurrentTransform (const InputPointType &ipp, SpatialHessianType &sh) const

void	GetSpatialHessianNoInitialTransform (const InputPointType &ipp, SpatialHessianType &sh) const

void	GetSpatialHessianUseAddition (const InputPointType &ipp, SpatialHessianType &sh) const

void	GetSpatialHessianUseComposition (const InputPointType &ipp, SpatialHessianType &sh) const

void	GetSpatialJacobianNoCurrentTransform (const InputPointType &ipp, SpatialJacobianType &sj) const

void	GetSpatialJacobianNoInitialTransform (const InputPointType &ipp, SpatialJacobianType &sj) const

void	GetSpatialJacobianUseAddition (const InputPointType &ipp, SpatialJacobianType &sj) const

void	GetSpatialJacobianUseComposition (const InputPointType &ipp, SpatialJacobianType &sj) const

virtual void	NoCurrentTransformSet (void) const

OutputPointType	TransformPointNoCurrentTransform (const InputPointType &point) const

OutputPointType	TransformPointNoInitialTransform (const InputPointType &point) const

OutputPointType	TransformPointUseAddition (const InputPointType &point) const

OutputPointType	TransformPointUseComposition (const InputPointType &point) const

virtual void	UpdateCombinationMethod (void)

	~AdvancedCombinationTransform () override

Protected Member Functions inherited from itk::AdvancedTransform< elx::TransformBase< TElastix >::CoordRepType, NDimensions, NDimensions >
	AdvancedTransform ()

	AdvancedTransform (NumberOfParametersType numberOfParameters)

	~AdvancedTransform () override

Protected Member Functions inherited from elastix::TransformBase< TElastix >
void	AutomaticScalesEstimation (ScalesType &scales) const

void	AutomaticScalesEstimationStackTransform (const unsigned int &numSubTransforms, ScalesType &scales) const

	TransformBase ()=default

	~TransformBase () override=default

Protected Member Functions inherited from elastix::BaseComponentSE< TElastix >
	BaseComponentSE ()=default

	~BaseComponentSE () override=default

Protected Member Functions inherited from elastix::BaseComponent
	BaseComponent ()=default

virtual	~BaseComponent ()=default

Protected Attributes
std::vector< std::string >	m_SubTransformFileNames

WeightedCombinationTransformPointer	m_WeightedCombinationTransform

Protected Attributes inherited from itk::AdvancedCombinationTransform< elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension >
CurrentTransformPointer	m_CurrentTransform

InitialTransformPointer	m_InitialTransform

EvaluateJacobianWithImageGradientProductFunctionPointer	m_SelectedEvaluateJacobianWithImageGradientProductFunction

GetJacobianOfSpatialHessianFunctionPointer	m_SelectedGetJacobianOfSpatialHessianFunction

GetJacobianOfSpatialHessianFunctionPointer2	m_SelectedGetJacobianOfSpatialHessianFunction2

GetJacobianOfSpatialJacobianFunctionPointer	m_SelectedGetJacobianOfSpatialJacobianFunction

GetJacobianOfSpatialJacobianFunctionPointer2	m_SelectedGetJacobianOfSpatialJacobianFunction2

GetSparseJacobianFunctionPointer	m_SelectedGetSparseJacobianFunction

GetSpatialHessianFunctionPointer	m_SelectedGetSpatialHessianFunction

GetSpatialJacobianFunctionPointer	m_SelectedGetSpatialJacobianFunction

TransformPointFunctionPointer	m_SelectedTransformPointFunction

bool	m_UseAddition

bool	m_UseComposition

Protected Attributes inherited from itk::AdvancedTransform< elx::TransformBase< TElastix >::CoordRepType, NDimensions, NDimensions >
bool	m_HasNonZeroJacobianOfSpatialHessian

bool	m_HasNonZeroSpatialHessian

Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
ConfigurationPointer	m_Configuration {}

ElastixPointer	m_Elastix {}

RegistrationPointer	m_Registration {}

Private Member Functions
void	operator= (const Self &)

	WeightedCombinationTransformElastix (const Self &)

Member Typedef Documentation

◆ CombinationTransformType

template<class TElastix >

typedef Superclass2::CombinationTransformType elastix::WeightedCombinationTransformElastix< TElastix >::CombinationTransformType

Definition at line 149 of file elxWeightedCombinationTransform.h.

◆ CommandLineArgumentMapType

template<class TElastix >

typedef Superclass2::CommandLineArgumentMapType elastix::WeightedCombinationTransformElastix< TElastix >::CommandLineArgumentMapType

Definition at line 150 of file elxWeightedCombinationTransform.h.

◆ CommandLineEntryType

template<class TElastix >

typedef Superclass2::CommandLineEntryType elastix::WeightedCombinationTransformElastix< TElastix >::CommandLineEntryType

Definition at line 151 of file elxWeightedCombinationTransform.h.

◆ ConfigurationPointer

template<class TElastix >

typedef Superclass2::ConfigurationPointer elastix::WeightedCombinationTransformElastix< TElastix >::ConfigurationPointer

Definition at line 142 of file elxWeightedCombinationTransform.h.

◆ ConfigurationType

template<class TElastix >

typedef Superclass2::ConfigurationType elastix::WeightedCombinationTransformElastix< TElastix >::ConfigurationType

Definition at line 141 of file elxWeightedCombinationTransform.h.

◆ ConstPointer

template<class TElastix >

typedef itk::SmartPointer< const Self > elastix::WeightedCombinationTransformElastix< TElastix >::ConstPointer

Definition at line 107 of file elxWeightedCombinationTransform.h.

◆ CoordRepType

template<class TElastix >

typedef Superclass2::CoordRepType elastix::WeightedCombinationTransformElastix< TElastix >::CoordRepType

Definition at line 145 of file elxWeightedCombinationTransform.h.

◆ ElastixPointer

template<class TElastix >

typedef Superclass2::ElastixPointer elastix::WeightedCombinationTransformElastix< TElastix >::ElastixPointer

Definition at line 140 of file elxWeightedCombinationTransform.h.

◆ ElastixType

template<class TElastix >

typedef Superclass2::ElastixType elastix::WeightedCombinationTransformElastix< TElastix >::ElastixType

Typedef's from the TransformBase class.

Definition at line 139 of file elxWeightedCombinationTransform.h.

◆ FixedImageType

template<class TElastix >

typedef Superclass2::FixedImageType elastix::WeightedCombinationTransformElastix< TElastix >::FixedImageType

Definition at line 146 of file elxWeightedCombinationTransform.h.

◆ InputCovariantVectorType

template<class TElastix >

typedef Superclass1::InputCovariantVectorType elastix::WeightedCombinationTransformElastix< TElastix >::InputCovariantVectorType

Definition at line 131 of file elxWeightedCombinationTransform.h.

◆ InputPointType

template<class TElastix >

typedef Superclass1::InputPointType elastix::WeightedCombinationTransformElastix< TElastix >::InputPointType

Definition at line 135 of file elxWeightedCombinationTransform.h.

◆ InputVectorType

template<class TElastix >

typedef Superclass1::InputVectorType elastix::WeightedCombinationTransformElastix< TElastix >::InputVectorType

Definition at line 129 of file elxWeightedCombinationTransform.h.

◆ InputVnlVectorType

template<class TElastix >

typedef Superclass1::InputVnlVectorType elastix::WeightedCombinationTransformElastix< TElastix >::InputVnlVectorType

Definition at line 133 of file elxWeightedCombinationTransform.h.

◆ ITKBaseType

template<class TElastix >

typedef Superclass2::ITKBaseType elastix::WeightedCombinationTransformElastix< TElastix >::ITKBaseType

Definition at line 148 of file elxWeightedCombinationTransform.h.

◆ JacobianType

template<class TElastix >

typedef Superclass1::JacobianType elastix::WeightedCombinationTransformElastix< TElastix >::JacobianType

Definition at line 128 of file elxWeightedCombinationTransform.h.

◆ MovingImageType

template<class TElastix >

typedef Superclass2::MovingImageType elastix::WeightedCombinationTransformElastix< TElastix >::MovingImageType

Definition at line 147 of file elxWeightedCombinationTransform.h.

◆ NumberOfParametersType

template<class TElastix >

typedef Superclass1::NumberOfParametersType elastix::WeightedCombinationTransformElastix< TElastix >::NumberOfParametersType

Definition at line 127 of file elxWeightedCombinationTransform.h.

◆ OutputCovariantVectorType

template<class TElastix >

typedef Superclass1::OutputCovariantVectorType elastix::WeightedCombinationTransformElastix< TElastix >::OutputCovariantVectorType

Definition at line 132 of file elxWeightedCombinationTransform.h.

◆ OutputPointType

template<class TElastix >

typedef Superclass1::OutputPointType elastix::WeightedCombinationTransformElastix< TElastix >::OutputPointType

Definition at line 136 of file elxWeightedCombinationTransform.h.

◆ OutputVectorType

template<class TElastix >

typedef Superclass1::OutputVectorType elastix::WeightedCombinationTransformElastix< TElastix >::OutputVectorType

Definition at line 130 of file elxWeightedCombinationTransform.h.

◆ OutputVnlVectorType

template<class TElastix >

typedef Superclass1::OutputVnlVectorType elastix::WeightedCombinationTransformElastix< TElastix >::OutputVnlVectorType

Definition at line 134 of file elxWeightedCombinationTransform.h.

◆ ParametersType

template<class TElastix >

typedef Superclass1::ParametersType elastix::WeightedCombinationTransformElastix< TElastix >::ParametersType

Definition at line 126 of file elxWeightedCombinationTransform.h.

◆ Pointer

template<class TElastix >

typedef itk::SmartPointer< Self > elastix::WeightedCombinationTransformElastix< TElastix >::Pointer

Definition at line 106 of file elxWeightedCombinationTransform.h.

◆ RegistrationPointer

template<class TElastix >

typedef Superclass2::RegistrationPointer elastix::WeightedCombinationTransformElastix< TElastix >::RegistrationPointer

Definition at line 144 of file elxWeightedCombinationTransform.h.

◆ RegistrationType

template<class TElastix >

typedef Superclass2::RegistrationType elastix::WeightedCombinationTransformElastix< TElastix >::RegistrationType

Definition at line 143 of file elxWeightedCombinationTransform.h.

◆ ScalarType

template<class TElastix >

typedef Superclass1::ScalarType elastix::WeightedCombinationTransformElastix< TElastix >::ScalarType

Typedefs inherited from the superclass.

Definition at line 125 of file elxWeightedCombinationTransform.h.

◆ ScalesType

template<class TElastix >

typedef Superclass2::ScalesType elastix::WeightedCombinationTransformElastix< TElastix >::ScalesType

For scales setting in the optimizer

Definition at line 163 of file elxWeightedCombinationTransform.h.

◆ Self

template<class TElastix >

typedef WeightedCombinationTransformElastix elastix::WeightedCombinationTransformElastix< TElastix >::Self

Standard ITK-stuff.

Definition at line 91 of file elxWeightedCombinationTransform.h.

◆ SubTransformPointer

template<class TElastix >

typedef WeightedCombinationTransformType::TransformPointer elastix::WeightedCombinationTransformElastix< TElastix >::SubTransformPointer

Definition at line 160 of file elxWeightedCombinationTransform.h.

◆ SubTransformType

template<class TElastix >

typedef WeightedCombinationTransformType::TransformType elastix::WeightedCombinationTransformElastix< TElastix >::SubTransformType

Definition at line 158 of file elxWeightedCombinationTransform.h.

◆ Superclass1

template<class TElastix >

typedef itk::AdvancedCombinationTransform< typename elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension > elastix::WeightedCombinationTransformElastix< TElastix >::Superclass1

Definition at line 95 of file elxWeightedCombinationTransform.h.

◆ Superclass2

template<class TElastix >

typedef elx::TransformBase< TElastix > elastix::WeightedCombinationTransformElastix< TElastix >::Superclass2

Definition at line 97 of file elxWeightedCombinationTransform.h.

◆ TransformContainerType

template<class TElastix >

typedef WeightedCombinationTransformType::TransformContainerType elastix::WeightedCombinationTransformElastix< TElastix >::TransformContainerType

Definition at line 156 of file elxWeightedCombinationTransform.h.

◆ WeightedCombinationTransformPointer

template<class TElastix >

typedef WeightedCombinationTransformType::Pointer elastix::WeightedCombinationTransformElastix< TElastix >::WeightedCombinationTransformPointer

Extra typedefs

Definition at line 154 of file elxWeightedCombinationTransform.h.

◆ WeightedCombinationTransformType

template<class TElastix >

typedef itk::WeightedCombinationTransform< typename elx::TransformBase< TElastix >::CoordRepType, elx::TransformBase< TElastix >::FixedImageDimension, elx::TransformBase< TElastix >::MovingImageDimension > elastix::WeightedCombinationTransformElastix< TElastix >::WeightedCombinationTransformType

The ITK-class that provides most of the functionality, and that is set as the "CurrentTransform" in the CombinationTransform

Definition at line 104 of file elxWeightedCombinationTransform.h.

Constructor & Destructor Documentation

◆ WeightedCombinationTransformElastix() [1/2]

template<class TElastix >

elastix::WeightedCombinationTransformElastix< TElastix >::WeightedCombinationTransformElastix ( )

protected

The constructor.

◆ ~WeightedCombinationTransformElastix()

template<class TElastix >

elastix::WeightedCombinationTransformElastix< TElastix >::~WeightedCombinationTransformElastix ( )

inlineoverrideprotected

The destructor.

Definition at line 211 of file elxWeightedCombinationTransform.h.

◆ WeightedCombinationTransformElastix() [2/2]

template<class TElastix >

elastix::WeightedCombinationTransformElastix< TElastix >::WeightedCombinationTransformElastix ( const Self & )

private

The private constructor.

Member Function Documentation

◆ BeforeRegistration()

template<class TElastix >

void elastix::WeightedCombinationTransformElastix< TElastix >::BeforeRegistration ( void )

overridevirtual

Execute stuff before the actual registration:

Read some parameters
Call InitializeTransform.
Set the scales.

Reimplemented from elastix::BaseComponent.

◆ elxClassNameMacro()

template<class TElastix >

elastix::WeightedCombinationTransformElastix< TElastix >::elxClassNameMacro ( "WeightedCombinationTransform" )

Name of this class. Use this name in the parameter file to select this specific transform.
example: (Transform "WeightedCombinationTransform")

◆ GetClassName()

template<class TElastix >

virtual const char * elastix::WeightedCombinationTransformElastix< TElastix >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from elastix::TransformBase< TElastix >.

◆ InitializeTransform()

template<class TElastix >

virtual void elastix::WeightedCombinationTransformElastix< TElastix >::InitializeTransform ( void )

virtual

Initialize Transform.

Load subtransforms
Set all parameters to 1/NrOfSubTransforms (if NormalizeCombinationWeights=true) or 0, (if NormalizeCombinationWeights=false)
Set the initial parameters in the Registration object This function is called by BeforeRegistration().

◆ itkStaticConstMacro()

template<class TElastix >

elastix::WeightedCombinationTransformElastix< TElastix >::itkStaticConstMacro	(	SpaceDimension	,
		unsigned int	,
		Superclass2::FixedImageDimension
	)

Dimension of the domain space.

◆ LoadSubTransforms()

template<class TElastix >

virtual void elastix::WeightedCombinationTransformElastix< TElastix >::LoadSubTransforms ( void )

virtual

Load from the parameter file a list of subtransforms. The filenames are stored in the m_SubTransformFileNames list

◆ New()

template<class TElastix >

static Pointer elastix::WeightedCombinationTransformElastix< TElastix >::New ( )

static

Method for creation through the object factory.

◆ operator=()

template<class TElastix >

void elastix::WeightedCombinationTransformElastix< TElastix >::operator= ( const Self & )

private

The private copy constructor.

◆ ReadFromFile()

template<class TElastix >

void elastix::WeightedCombinationTransformElastix< TElastix >::ReadFromFile ( void )

overridevirtual

Function to read transform-parameters from a file.

It loads the subtransforms, the NormalizeWeights option, and calls the superclass' implementation.

Reimplemented from elastix::TransformBase< TElastix >.

◆ SetScales()

template<class TElastix >

virtual void elastix::WeightedCombinationTransformElastix< TElastix >::SetScales ( void )

virtual

Set the scales

If AutomaticScalesEstimation is "true" estimate scales
If scales are provided by the user use those,
Otherwise use some default value: 1. This function is called by BeforeRegistration, after the InitializeTransform function is called

◆ WriteToFile()

template<class TElastix >

void elastix::WeightedCombinationTransformElastix< TElastix >::WriteToFile ( const ParametersType & param ) const

overridevirtual

Function to write transform-parameters to a file. It writes the names of the subTransform parameterFiles. and the NormalizeWeights option, and calls the superclass' implementation.

Reimplemented from elastix::TransformBase< TElastix >.

Field Documentation

◆ m_SubTransformFileNames

template<class TElastix >

std::vector< std::string > elastix::WeightedCombinationTransformElastix< TElastix >::m_SubTransformFileNames

protected

Definition at line 214 of file elxWeightedCombinationTransform.h.

◆ m_WeightedCombinationTransform

template<class TElastix >

WeightedCombinationTransformPointer elastix::WeightedCombinationTransformElastix< TElastix >::m_WeightedCombinationTransform

protected

Definition at line 213 of file elxWeightedCombinationTransform.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Member Typedef Documentation

◆ CombinationTransformType

◆ CommandLineArgumentMapType

◆ CommandLineEntryType

◆ ConfigurationPointer

◆ ConfigurationType

◆ ConstPointer

◆ CoordRepType

◆ ElastixPointer

◆ ElastixType

◆ FixedImageType

◆ InputCovariantVectorType

◆ InputPointType

◆ InputVectorType

◆ InputVnlVectorType

◆ ITKBaseType

◆ JacobianType

◆ MovingImageType

◆ NumberOfParametersType

◆ OutputCovariantVectorType

◆ OutputPointType

◆ OutputVectorType

◆ OutputVnlVectorType

◆ ParametersType

◆ Pointer

◆ RegistrationPointer

◆ RegistrationType

◆ ScalarType

◆ ScalesType

◆ Self

◆ SubTransformPointer

◆ SubTransformType

◆ Superclass1

◆ Superclass2

◆ TransformContainerType

◆ WeightedCombinationTransformPointer

◆ WeightedCombinationTransformType

Constructor & Destructor Documentation

◆ WeightedCombinationTransformElastix() [1/2]

◆ ~WeightedCombinationTransformElastix()

◆ WeightedCombinationTransformElastix() [2/2]

Member Function Documentation

◆ BeforeRegistration()

◆ elxClassNameMacro()

◆ GetClassName()

◆ InitializeTransform()

◆ itkStaticConstMacro()

◆ LoadSubTransforms()

◆ New()

◆ operator=()

◆ ReadFromFile()

◆ SetScales()

◆ WriteToFile()

Field Documentation

◆ m_SubTransformFileNames

◆ m_WeightedCombinationTransform