#include <elxResamplerBase.h>

Detailed Description

template<typename TElastix>
class elastix::ResamplerBase< TElastix >

Definition at line 80 of file elxResamplerBase.h.

Inheritance diagram for elastix::ResamplerBase< TElastix >:

Public Types
using	CoordinateType = ElastixBase::CoordinateType
using	DirectionType = typename ITKBaseType::DirectionType
using	ElastixType
using	IndexType = typename ITKBaseType::IndexType
using	InputImageType = typename ElastixType::MovingImageType
using	InterpolatorType = typename ITKBaseType::InterpolatorType
using	ITKBaseType = itk::ResampleImageFilter<InputImageType, OutputImageType, CoordinateType>
using	OriginPointType = typename ITKBaseType::OriginPointType
using	OutputImageType = typename ElastixType::MovingImageType
using	OutputPixelType = typename ITKBaseType::PixelType
using	ParameterMapType = typename ElastixType::ParameterMapType
using	RegistrationType
using	Self = ResamplerBase
using	SizeType = typename ITKBaseType::SizeType
using	SpacingType = typename ITKBaseType::SpacingType
using	Superclass = BaseComponentSE<TElastix>
using	TransformType = typename ITKBaseType::TransformType
Public Types inherited from elastix::BaseComponentSE< TElastix >
using	ElastixType = TElastix
using	RegistrationType = typename ElastixType::RegistrationBaseType
using	Self = BaseComponentSE
using	Superclass = BaseComponent

Public Member Functions
void	AfterEachIterationBase () override
void	AfterEachResolutionBase () override
void	AfterRegistrationBase () override
virtual int	BeforeAllTransformix ()
void	BeforeRegistrationBase () override
virtual void	CreateItkResultImage ()
void	CreateTransformParameterMap (ParameterMapType &parameterMap) const
ITKBaseType *	GetAsITKBaseType ()
const ITKBaseType *	GetAsITKBaseType () const
	ITK_DISALLOW_COPY_AND_MOVE (ResamplerBase)
	itkOverrideGetNameOfClassMacro (ResamplerBase)
	itkStaticConstMacro (ImageDimension, unsigned int, OutputImageType::ImageDimension)
virtual void	ReadFromFile ()
void	ResampleAndWriteResultImage (const std::string &filename, const bool showProgress)
void	WriteToFile (std::ostream &transformationParameterInfo) const
Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
void	AddTargetCellToIterationInfo (const char *const name)
const Configuration *	GetConfiguration () const
ElastixType *	GetElastix () const
auto &	GetIterationInfoAt (const char *const name)
itk::Statistics::MersenneTwisterRandomVariateGenerator &	GetRandomVariateGenerator ()
RegistrationType *	GetRegistration () const
	ITK_DISALLOW_COPY_AND_MOVE (BaseComponentSE)
void	RemoveTargetCellFromIterationInfo (const char *const name)
void	SetConfiguration (const Configuration *_arg)
void	SetElastix (ElastixType *_arg)
Public Member Functions inherited from elastix::BaseComponent
virtual void	AfterEachIteration ()
virtual void	AfterEachResolution ()
virtual void	AfterRegistration ()
virtual int	BeforeAll ()
virtual int	BeforeAllBase ()
virtual void	BeforeEachResolution ()
virtual void	BeforeEachResolutionBase ()
virtual void	BeforeRegistration ()
virtual const char *	elxGetClassName () const
const char *	GetComponentLabel () const
	ITK_DISALLOW_COPY_AND_MOVE (BaseComponent)
	itkVirtualGetNameOfClassMacro (BaseComponent)
void	SetComponentLabel (const char *label, unsigned int idx)

Protected Member Functions
	ResamplerBase ()=default
virtual void	SetComponents ()
	~ResamplerBase () 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

Private Member Functions
template<typename TResultPixel>
itk::SmartPointer< itk::ImageBase< ImageDimension > >	CastImage (const InputImageType &inputImage) const
template<typename... TResultPixel>
itk::SmartPointer< itk::ImageBase< ImageDimension > >	CastImageAsSpecifiedByFixedWidthPixelType (const std::string_view resultImagePixelType, const InputImageType &inputImage) const
template<typename TResultPixel>
bool	CastImageIfPixelTypesMatch (const std::string_view resultImagePixelType, const InputImageType &inputImage, itk::SmartPointer< itk::ImageBase< ImageDimension > > &outputImage) const
virtual ParameterMapType	CreateDerivedTransformParameterMap () const
	elxDeclarePureVirtualGetSelfMacro (ITKBaseType)
void	ReleaseMemory ()
void	WriteResultImage (OutputImageType *imageimage, const std::string &filename, const bool showProgress)

Additional Inherited Members
Static Public Member Functions inherited from elastix::BaseComponent
template<typename TBaseComponent>
static auto	AsITKBaseType (TBaseComponent *const baseComponent) -> decltype(baseComponent->GetAsITKBaseType())
static void	InitializeElastixExecutable ()
static bool	IsElastixLibrary ()
Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
Configuration::ConstPointer	m_Configuration {}
itk::WeakPointer< TElastix >	m_Elastix {}
RegistrationType *	m_Registration {}

Member Typedef Documentation

◆ CoordinateType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::CoordinateType = ElastixBase::CoordinateType

Definition at line 101 of file elxResamplerBase.h.

◆ DirectionType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::DirectionType = typename ITKBaseType::DirectionType

Definition at line 112 of file elxResamplerBase.h.

◆ ElastixType

template<typename TElastix>

using elastix::BaseComponentSE< TElastix >::ElastixType

Elastix typedef.

Definition at line 58 of file elxBaseComponentSE.h.

◆ IndexType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::IndexType = typename ITKBaseType::IndexType

Definition at line 110 of file elxResamplerBase.h.

◆ InputImageType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::InputImageType = typename ElastixType::MovingImageType

Typedef's from elastix. NB: it is assumed that fixed and moving image dimension are equal!

Definition at line 98 of file elxResamplerBase.h.

◆ InterpolatorType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::InterpolatorType = typename ITKBaseType::InterpolatorType

Definition at line 108 of file elxResamplerBase.h.

◆ ITKBaseType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::ITKBaseType = itk::ResampleImageFilter<InputImageType, OutputImageType, CoordinateType>

Other typedef's.

Definition at line 104 of file elxResamplerBase.h.

◆ OriginPointType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::OriginPointType = typename ITKBaseType::OriginPointType

Definition at line 113 of file elxResamplerBase.h.

◆ OutputImageType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::OutputImageType = typename ElastixType::MovingImageType

Definition at line 99 of file elxResamplerBase.h.

◆ OutputPixelType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::OutputPixelType = typename ITKBaseType::PixelType

Definition at line 114 of file elxResamplerBase.h.

◆ ParameterMapType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::ParameterMapType = typename ElastixType::ParameterMapType

Typedef that is used in the elastix dll version.

Definition at line 117 of file elxResamplerBase.h.

◆ RegistrationType

template<typename TElastix>

using elastix::BaseComponentSE< TElastix >::RegistrationType

RegistrationType; NB: this is the elx::RegistrationBase not an itk::Object or something like that.

Definition at line 63 of file elxBaseComponentSE.h.

◆ Self

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::Self = ResamplerBase

Standard ITK stuff.

Definition at line 86 of file elxResamplerBase.h.

◆ SizeType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::SizeType = typename ITKBaseType::SizeType

Definition at line 109 of file elxResamplerBase.h.

◆ SpacingType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::SpacingType = typename ITKBaseType::SpacingType

Definition at line 111 of file elxResamplerBase.h.

◆ Superclass

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::Superclass = BaseComponentSE<TElastix>

Definition at line 87 of file elxResamplerBase.h.

◆ TransformType

template<typename TElastix>

using elastix::ResamplerBase< TElastix >::TransformType = typename ITKBaseType::TransformType

Typedef's from ResampleImageFiler.

Definition at line 107 of file elxResamplerBase.h.

Constructor & Destructor Documentation

◆ ResamplerBase()

template<typename TElastix>

elastix::ResamplerBase< TElastix >::ResamplerBase ( )

protecteddefault

The constructor.

◆ ~ResamplerBase()

template<typename TElastix>

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

overrideprotecteddefault

The destructor.

Member Function Documentation

◆ AfterEachIterationBase()

template<typename TElastix>

void elastix::ResamplerBase< TElastix >::AfterEachIterationBase ( )

overridevirtual

Execute stuff after each iteration:

Write the resulting output image.

Reimplemented from elastix::BaseComponent.

◆ AfterEachResolutionBase()

template<typename TElastix>

void elastix::ResamplerBase< TElastix >::AfterEachResolutionBase ( )

overridevirtual

Execute stuff after each resolution:

Write the resulting output image.

Reimplemented from elastix::BaseComponent.

◆ AfterRegistrationBase()

template<typename TElastix>

void elastix::ResamplerBase< TElastix >::AfterRegistrationBase ( )

overridevirtual

Execute stuff after the registration:

Write the resulting output image.

Reimplemented from elastix::BaseComponent.

◆ BeforeAllTransformix()

template<typename TElastix>

virtual int elastix::ResamplerBase< TElastix >::BeforeAllTransformix ( )

inlinevirtual

Execute stuff before the actual transformation:

nothing here

Definition at line 142 of file elxResamplerBase.h.

◆ BeforeRegistrationBase()

template<typename TElastix>

void elastix::ResamplerBase< TElastix >::BeforeRegistrationBase ( )

overridevirtual

Execute stuff before the actual registration:

Set all components into the resampler, such as the transform interpolator, input.
Set output image information, such as size, spacing, etc.
Set the default pixel value.

Reimplemented from elastix::BaseComponent.

◆ CastImage()

template<typename TElastix>

template<typename TResultPixel>

itk::SmartPointer< itk::ImageBase< ImageDimension > > elastix::ResamplerBase< TElastix >::CastImage ( const InputImageType & inputImage ) const

inlineprivate

Casts the specified input image to the image type with the pixel type specified by the template argument.

Definition at line 224 of file elxResamplerBase.h.

◆ CastImageAsSpecifiedByFixedWidthPixelType()

template<typename TElastix>

template<typename... TResultPixel>

itk::SmartPointer< itk::ImageBase< ImageDimension > > elastix::ResamplerBase< TElastix >::CastImageAsSpecifiedByFixedWidthPixelType	(	const std::string_view	resultImagePixelType,
		const InputImageType &	inputImage ) const

inlineprivate

Casts the specified input image to the image type with the specified fixed width pixel type.

Definition at line 253 of file elxResamplerBase.h.

◆ CastImageIfPixelTypesMatch()

template<typename TElastix>

template<typename TResultPixel>

bool elastix::ResamplerBase< TElastix >::CastImageIfPixelTypesMatch	(	const std::string_view	resultImagePixelType,
		const InputImageType &	inputImage,
		itk::SmartPointer< itk::ImageBase< ImageDimension > > &	outputImage ) const

inlineprivate

Casts the specified input image to the image type with the specified pixel type, if the function argument resultImagePixelType matches the template argument TResultPixel. The function argument resultImagePixelType should be of the fixed width form: "intN", "uintN", or "floatN", with 'N' specifying the number of bits.

Definition at line 238 of file elxResamplerBase.h.

◆ CreateDerivedTransformParameterMap()

template<typename TElastix>

virtual ParameterMapType elastix::ResamplerBase< TElastix >::CreateDerivedTransformParameterMap ( ) const

inlineprivatevirtual

Reimplemented in elastix::OpenCLResampler< TElastix >.

Definition at line 208 of file elxResamplerBase.h.

◆ CreateItkResultImage()

template<typename TElastix>

virtual void elastix::ResamplerBase< TElastix >::CreateItkResultImage ( )

virtual

Function to create the result image in the format of an itk::Image.

◆ CreateTransformParameterMap()

template<typename TElastix>

void elastix::ResamplerBase< TElastix >::CreateTransformParameterMap ( ParameterMapType & parameterMap ) const

Function to create transform-parameters map.

◆ elxDeclarePureVirtualGetSelfMacro()

template<typename TElastix>

elastix::ResamplerBase< TElastix >::elxDeclarePureVirtualGetSelfMacro ( ITKBaseType )

private

◆ GetAsITKBaseType() [1/2]

template<typename TElastix>

ITKBaseType * elastix::ResamplerBase< TElastix >::GetAsITKBaseType ( )

inline

Retrieves this object as ITKBaseType.

Definition at line 124 of file elxResamplerBase.h.

◆ GetAsITKBaseType() [2/2]

template<typename TElastix>

const ITKBaseType * elastix::ResamplerBase< TElastix >::GetAsITKBaseType ( ) const

inline

Retrieves this object as ITKBaseType, to use in const functions.

Definition at line 132 of file elxResamplerBase.h.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<typename TElastix>

elastix::ResamplerBase< TElastix >::ITK_DISALLOW_COPY_AND_MOVE ( ResamplerBase< TElastix > )

◆ itkOverrideGetNameOfClassMacro()

template<typename TElastix>

elastix::ResamplerBase< TElastix >::itkOverrideGetNameOfClassMacro ( ResamplerBase< TElastix > )

Run-time type information (and related methods).

◆ itkStaticConstMacro()

template<typename TElastix>

elastix::ResamplerBase< TElastix >::itkStaticConstMacro	(	ImageDimension	,
		unsigned int	,
		OutputImageType::ImageDimension	)

Get the ImageDimension.

◆ ReadFromFile()

template<typename TElastix>

virtual void elastix::ResamplerBase< TElastix >::ReadFromFile ( )

virtual

Function to read transform-parameters from a file.

Reimplemented in elastix::OpenCLResampler< TElastix >.

◆ ReleaseMemory()

template<typename TElastix>

void elastix::ResamplerBase< TElastix >::ReleaseMemory ( )

private

Release memory.

◆ ResampleAndWriteResultImage()

template<typename TElastix>

void elastix::ResamplerBase< TElastix >::ResampleAndWriteResultImage	(	const std::string &	filename,
		const bool	showProgress )

Function to perform resample and write the result output image to a file.

◆ SetComponents()

template<typename TElastix>

virtual void elastix::ResamplerBase< TElastix >::SetComponents ( )

protectedvirtual

Method that sets the transform, the interpolator and the inputImage.

◆ WriteResultImage()

template<typename TElastix>

void elastix::ResamplerBase< TElastix >::WriteResultImage	(	OutputImageType *	imageimage,
		const std::string &	filename,
		const bool	showProgress )

private

Function to write the result output image to a file.

◆ WriteToFile()

template<typename TElastix>

void elastix::ResamplerBase< TElastix >::WriteToFile ( std::ostream & transformationParameterInfo ) const

Function to write transform-parameters to a file.

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ CoordinateType

◆ DirectionType

◆ ElastixType

◆ IndexType

◆ InputImageType

◆ InterpolatorType

◆ ITKBaseType

◆ OriginPointType

◆ OutputImageType

◆ OutputPixelType

◆ ParameterMapType

◆ RegistrationType

◆ Self

◆ SizeType

◆ SpacingType

◆ Superclass

◆ TransformType

Constructor & Destructor Documentation

◆ ResamplerBase()

◆ ~ResamplerBase()

Member Function Documentation

◆ AfterEachIterationBase()

◆ AfterEachResolutionBase()

◆ AfterRegistrationBase()

◆ BeforeAllTransformix()

◆ BeforeRegistrationBase()

◆ CastImage()

◆ CastImageAsSpecifiedByFixedWidthPixelType()

◆ CastImageIfPixelTypesMatch()

◆ CreateDerivedTransformParameterMap()

◆ CreateItkResultImage()

◆ CreateTransformParameterMap()

◆ elxDeclarePureVirtualGetSelfMacro()

◆ GetAsITKBaseType() [1/2]

◆ GetAsITKBaseType() [2/2]

◆ ITK_DISALLOW_COPY_AND_MOVE()

◆ itkOverrideGetNameOfClassMacro()

◆ itkStaticConstMacro()

◆ ReadFromFile()

◆ ReleaseMemory()

◆ ResampleAndWriteResultImage()

◆ SetComponents()

◆ WriteResultImage()

◆ WriteToFile()