itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType > Class Template Reference

#include <itkResampleImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>
class itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >

Resample an image via a coordinate transform.

ResampleImageFilter resamples an existing image through some coordinate transform, interpolating via some image function. The class is templated over the types of the input and output images.

Note that the choice of interpolator function can be important. This function is set via SetInterpolator(). The default is LinearInterpolateImageFunction<InputImageType, TInterpolatorPrecisionType>, which is reasonable for ordinary medical images. However, some synthetic images have pixels drawn from a finite prescribed set. An example would be a mask indicating the segmentation of a brain into a small number of tissue types. For such an image, one does not want to interpolate between different pixel values, and so NearestNeighborInterpolateImageFunction< InputImageType, TCoordinate > would be a better choice.

If an sample is taken from outside the image domain, the default behavior is to use a default pixel value. If different behavior is desired, an extrapolator function can be set with SetExtrapolator().

Output information (spacing, size and direction) for the output image should be set. This information has the normal defaults of unit spacing, zero origin and identity direction. Optionally, the output information can be obtained from a reference image. If the reference image is provided and UseReferenceImage is On, then the spacing, origin and direction of the reference image will be used.

Since this filter produces an image which is a different size than its input, it needs to override several of the methods defined in ProcessObject in order to properly manage the pipeline execution model. In particular, this filter overrides ProcessObject::GenerateInputRequestedRegion() and ProcessObject::GenerateOutputInformation().

This filter is implemented as a multithreaded filter. It provides a DynamicThreadedGenerateData() method for its implementation.

Warning

For multithreading, the TransformPoint method of the user-designated coordinate transform must be threadsafe.

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Translate Image

• Upsampling An Image

• Resample An Image

Examples

Examples/Filtering/DigitallyReconstructedRadiograph1.cxx, Examples/Filtering/FFTDirectInverse.cxx, Examples/Filtering/ResampleImageFilter.cxx, Examples/Filtering/ResampleImageFilter2.cxx, Examples/Filtering/ResampleImageFilter3.cxx, Examples/Filtering/ResampleImageFilter4.cxx, Examples/Filtering/ResampleImageFilter5.cxx, Examples/Filtering/ResampleImageFilter6.cxx, Examples/Filtering/ResampleImageFilter7.cxx, Examples/Filtering/ResampleImageFilter8.cxx, Examples/Filtering/ResampleImageFilter9.cxx, Examples/Filtering/ResampleVolumesToBeIsotropic.cxx, Examples/Filtering/SubsampleVolume.cxx, Examples/RegistrationITKv4/BSplineWarping1.cxx, Examples/RegistrationITKv4/BSplineWarping2.cxx, Examples/RegistrationITKv4/DeformableRegistration10.cxx, Examples/RegistrationITKv4/DeformableRegistration12.cxx, Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/DeformableRegistration16.cxx, Examples/RegistrationITKv4/DeformableRegistration17.cxx, Examples/RegistrationITKv4/DeformableRegistration2.cxx, Examples/RegistrationITKv4/DeformableRegistration3.cxx, Examples/RegistrationITKv4/DeformableRegistration4.cxx, Examples/RegistrationITKv4/DeformableRegistration5.cxx, Examples/RegistrationITKv4/DeformableRegistration6.cxx, Examples/RegistrationITKv4/DeformableRegistration7.cxx, Examples/RegistrationITKv4/DeformableRegistration8.cxx, Examples/RegistrationITKv4/DeformableRegistration9.cxx, Examples/RegistrationITKv4/ImageRegistration1.cxx, Examples/RegistrationITKv4/ImageRegistration10.cxx, Examples/RegistrationITKv4/ImageRegistration11.cxx, Examples/RegistrationITKv4/ImageRegistration12.cxx, Examples/RegistrationITKv4/ImageRegistration13.cxx, Examples/RegistrationITKv4/ImageRegistration14.cxx, Examples/RegistrationITKv4/ImageRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration16.cxx, Examples/RegistrationITKv4/ImageRegistration17.cxx, Examples/RegistrationITKv4/ImageRegistration18.cxx, Examples/RegistrationITKv4/ImageRegistration19.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, Examples/RegistrationITKv4/ImageRegistration20.cxx, Examples/RegistrationITKv4/ImageRegistration3.cxx, Examples/RegistrationITKv4/ImageRegistration4.cxx, Examples/RegistrationITKv4/ImageRegistration5.cxx, Examples/RegistrationITKv4/ImageRegistration6.cxx, Examples/RegistrationITKv4/ImageRegistration7.cxx, Examples/RegistrationITKv4/ImageRegistration8.cxx, Examples/RegistrationITKv4/ImageRegistration9.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/LandmarkWarping2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration1.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration3.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, Examples/RegistrationITKv4/ThinPlateSplineWarp.cxx, SphinxExamples/src/Core/ImageFunction/ResampleSegmentedImage/Code.cxx, SphinxExamples/src/Core/Transform/ApplyAffineTransformFromHomogeneousMatrixAndResample/Code.cxx, SphinxExamples/src/Core/Transform/DeformAVolumeWithAThinPlateSpline/Code.cxx, SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesAffine/Code.cxx, SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesBSpline/Code.cxx, SphinxExamples/src/Core/Transform/MutualInformationAffine/Code.cxx, SphinxExamples/src/Core/Transform/ScaleAnImage/Code.cxx, SphinxExamples/src/Core/Transform/TranslateAVectorImage/Code.cxx, SphinxExamples/src/Core/Transform/TranslateImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/ResampleAnImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/ResampleAScalarImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/ResampleAVectorImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/UpsampleAnImage/Code.cxx, SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx, SphinxExamples/src/Registration/Common/GlobalRegistrationOfTwoImages/Code.cxx, SphinxExamples/src/Registration/Common/MutualInformation/Code.cxx, SphinxExamples/src/Registration/Common/Perform2DTranslationRegistrationWithMeanSquares/Code.cxx, SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx, SphinxExamples/src/Registration/Common/RegisterImageToAnotherUsingLandmarks/Code.cxx, SphinxExamples/src/Registration/Common/WatchRegistration/Code.cxx, and SphinxExamples/src/Registration/Metricsv4/PerformRegistrationOnVectorImages/Code.cxx.

Definition at line 90 of file itkResampleImageFilter.h.

Inheritance diagram for itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >:

Collaboration diagram for itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >:

Public Types
using	ComponentType = typename InterpolatorConvertType::ComponentType
using	ConstPointer = SmartPointer< const Self >
using	ContinuousInputIndexType = ContinuousIndex< TInterpolatorPrecisionType, InputImageDimension >
using	DecoratedTransformPointer = typename DecoratedTransformType::Pointer
using	DecoratedTransformType = DataObjectDecorator< TransformType >
using	DirectionType = typename TOutputImage::DirectionType
using	ExtrapolatorPointerType = typename ExtrapolatorType::Pointer
using	ExtrapolatorType = ExtrapolateImageFunction< InputImageType, TInterpolatorPrecisionType >
using	ImageBaseType = ImageBase< Self::OutputImageDimension >
using	IndexType = typename TOutputImage::IndexType
using	InputImageConstPointer = typename InputImageType::ConstPointer
using	InputImagePointer = typename InputImageType::Pointer
using	InputImageRegionType = typename InputImageType::RegionType
using	InputImageType = TInputImage
using	InputPixelType = typename TInputImage::PixelType
using	InputPointType = typename InterpolatorType::PointType
using	InterpolatorConvertType = DefaultConvertPixelTraits< InterpolatorOutputType >
using	InterpolatorOutputType = typename InterpolatorType::OutputType
using	InterpolatorPointerType = typename InterpolatorType::Pointer
using	InterpolatorType = InterpolateImageFunction< InputImageType, TInterpolatorPrecisionType >
using	LinearInterpolatorPointerType = typename LinearInterpolatorType::Pointer
using	LinearInterpolatorType = LinearInterpolateImageFunction< InputImageType, TInterpolatorPrecisionType >
using	OriginPointType = typename TOutputImage::PointType
using	OutputImagePointer = typename OutputImageType::Pointer
using	OutputImageRegionType = typename TOutputImage::RegionType
using	OutputImageType = TOutputImage
using	OutputPointType = typename TOutputImage::PointType
using	PixelComponentType = typename PixelConvertType::ComponentType
using	PixelConvertType = DefaultConvertPixelTraits< PixelType >
using	PixelType = typename TOutputImage::PixelType
using	Pointer = SmartPointer< Self >
using	ReferenceImageBaseType = ImageBase< OutputImageDimension >
using	Self = ResampleImageFilter
using	SizeType = Size< Self::OutputImageDimension >
using	SpacingType = typename TOutputImage::SpacingType
using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >
using	TransformPointerType = typename TransformType::ConstPointer
using	TransformType = Transform< TTransformPrecisionType, Self::OutputImageDimension, Self::InputImageDimension >
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >
using	InputImageConstPointer = typename InputImageType::ConstPointer
using	InputImagePixelType = typename InputImageType::PixelType
using	InputImagePointer = typename InputImageType::Pointer
using	InputImageRegionType = typename InputImageType::RegionType
using	InputImageType = TInputImage
using	Pointer = SmartPointer< Self >
using	Self = ImageToImageFilter
using	Superclass = ImageSource< TOutputImage >
Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >
using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType
using	DataObjectPointer = DataObject::Pointer
using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
using	OutputImagePixelType = typename OutputImageType::PixelType
using	OutputImagePointer = typename OutputImageType::Pointer
using	OutputImageRegionType = typename OutputImageType::RegionType
using	OutputImageType = TOutputImage
using	Pointer = SmartPointer< Self >
using	Self = ImageSource
using	Superclass = ProcessObject
Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >
using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType
using	DataObjectPointer = DataObject::Pointer
using	DataObjectPointerArray = std::vector< DataObjectPointer >
using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
using	MultiThreaderType = MultiThreaderBase
using	NameArray = std::vector< DataObjectIdentifierType >
using	Pointer = SmartPointer< Self >
using	Self = ProcessObject
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override
virtual const OriginPointType &	GetOutputOrigin () const
virtual const SpacingType &	GetOutputSpacing () const
virtual const IndexType &	GetOutputStartIndex () const
virtual const ReferenceImageBaseType *	GetReferenceImage () const
void	SetOutputParametersFromImage (const ImageBaseType *image)
virtual void	SetOutputStartIndex (IndexType _arg)
virtual void	SetReferenceImage (const ReferenceImageBaseType *input)
virtual void	SetTransformInput (const DataObjectDecorator< TransformType > *_arg)
void	VerifyPreconditions () const override
virtual void	SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorType *	GetModifiableInterpolator ()
virtual void	SetExtrapolator (ExtrapolatorType *_arg)
virtual ExtrapolatorType *	GetModifiableExtrapolator ()
virtual void	SetSize (SizeType _arg)
virtual const SizeType &	GetSize () const
virtual void	SetDefaultPixelValue (PixelType _arg)
virtual const PixelType &	GetDefaultPixelValue () const
virtual void	SetOutputSpacing (SpacingType _arg)
virtual void	SetOutputSpacing (const double *spacing)
virtual void	SetOutputOrigin (OriginPointType _arg)
virtual void	SetOutputOrigin (const double *origin)
virtual void	SetOutputDirection (DirectionType _arg)
virtual const DirectionType &	GetOutputDirection () const
virtual void	SetUseReferenceImage (bool _arg)
virtual void	UseReferenceImageOn ()
virtual bool	GetUseReferenceImage () const
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
void	PopBackInput () override
void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *input)
virtual void	PushFrontInput (const InputImageType *input)
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetInput (const InputImageType *input)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *graft)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)
ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual float	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
void	IncrementProgress (float increment)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetMultiThreader (MultiThreaderType *threader)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
virtual void	SetReleaseDataFlag (bool val)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfWorkUnits () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag) const
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()
static double	GetGlobalDefaultDirectionTolerance ()
static void	SetGlobalDefaultCoordinateTolerance (double)
static void	SetGlobalDefaultDirectionTolerance (double)
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	AfterThreadedGenerateData () override
void	BeforeThreadedGenerateData () override
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
void	GenerateInputRequestedRegion () override
void	GenerateOutputInformation () override
ModifiedTimeType	GetMTime () const override
void	InitializeTransform ()
virtual void	LinearThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual void	NonlinearThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
void	PrintSelf (std::ostream &os, Indent indent) const override
	ResampleImageFilter ()
void	VerifyInputInformation () const override
	~ResampleImageFilter () override=default
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
	~ImageToImageFilter () override=default
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AllocateOutputs ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
void	GenerateData () override
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
	~ImageSource () override=default
virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)
virtual void	SetPrimaryInput (DataObject *object)
virtual void	SetPrimaryOutput (DataObject *object)
void	SetRequiredInputNames (const NameArray &)
	~ProcessObject () override
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName () const
DataObject *	GetOutput (DataObjectPointerArraySizeType i)
const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual bool	GetThreaderUpdateProgress () const
virtual void	ThreaderUpdateProgressOn ()
virtual void	SetThreaderUpdateProgress (bool arg)
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Static Protected Member Functions
static PixelType	CastPixelWithBoundsChecking (const ComponentType value)
template<typename TPixel >
static PixelType	CastPixelWithBoundsChecking (const TPixel value)
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)
Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
static constexpr float	progressFixedToFloat (uint32_t fixed)
static uint32_t	progressFloatToFixed (float f)

Protected Attributes
PixelType	m_DefaultPixelValue {}
ExtrapolatorPointerType	m_Extrapolator {}
InterpolatorPointerType	m_Interpolator {}
DirectionType	m_OutputDirection {}
OriginPointType	m_OutputOrigin {}
SpacingType	m_OutputSpacing {}
IndexType	m_OutputStartIndex {}
SizeType	m_Size {}
bool	m_UseReferenceImage { false }
Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}
bool	m_Updating {}
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Member Typedef Documentation

ComponentType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::ComponentType = typename InterpolatorConvertType::ComponentType

Definition at line 145 of file itkResampleImageFilter.h.

ConstPointer

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::ConstPointer = SmartPointer<const Self>

Definition at line 100 of file itkResampleImageFilter.h.

ContinuousInputIndexType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::ContinuousInputIndexType = ContinuousIndex<TInterpolatorPrecisionType, InputImageDimension>

Input pixel continuous index typedef

Definition at line 173 of file itkResampleImageFilter.h.

DecoratedTransformPointer

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::DecoratedTransformPointer = typename DecoratedTransformType::Pointer

Definition at line 134 of file itkResampleImageFilter.h.

DecoratedTransformType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::DecoratedTransformType = DataObjectDecorator<TransformType>

Definition at line 133 of file itkResampleImageFilter.h.

DirectionType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::DirectionType = typename TOutputImage::DirectionType

Definition at line 181 of file itkResampleImageFilter.h.

ExtrapolatorPointerType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::ExtrapolatorPointerType = typename ExtrapolatorType::Pointer

Definition at line 152 of file itkResampleImageFilter.h.

ExtrapolatorType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::ExtrapolatorType = ExtrapolateImageFunction<InputImageType, TInterpolatorPrecisionType>

Extrapolator type alias.

Definition at line 151 of file itkResampleImageFilter.h.

ImageBaseType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::ImageBaseType = ImageBase<Self::OutputImageDimension>

base type for images of the current OutputImageDimension

Definition at line 126 of file itkResampleImageFilter.h.

IndexType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::IndexType = typename TOutputImage::IndexType

Image index type alias.

Definition at line 158 of file itkResampleImageFilter.h.

InputImageConstPointer

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 105 of file itkResampleImageFilter.h.

InputImagePointer

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InputImagePointer = typename InputImageType::Pointer

Definition at line 104 of file itkResampleImageFilter.h.

InputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 107 of file itkResampleImageFilter.h.

InputImageType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InputImageType = TInputImage

Definition at line 102 of file itkResampleImageFilter.h.

InputPixelType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InputPixelType = typename TInputImage::PixelType

Definition at line 166 of file itkResampleImageFilter.h.

InputPointType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InputPointType = typename InterpolatorType::PointType

Image point type alias.

Definition at line 161 of file itkResampleImageFilter.h.

InterpolatorConvertType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InterpolatorConvertType = DefaultConvertPixelTraits<InterpolatorOutputType>

Definition at line 143 of file itkResampleImageFilter.h.

InterpolatorOutputType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InterpolatorOutputType = typename InterpolatorType::OutputType

Definition at line 141 of file itkResampleImageFilter.h.

InterpolatorPointerType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InterpolatorPointerType = typename InterpolatorType::Pointer

Definition at line 139 of file itkResampleImageFilter.h.

InterpolatorType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InterpolatorType = InterpolateImageFunction<InputImageType, TInterpolatorPrecisionType>

Interpolator type alias.

Definition at line 138 of file itkResampleImageFilter.h.

LinearInterpolatorPointerType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::LinearInterpolatorPointerType = typename LinearInterpolatorType::Pointer

Definition at line 148 of file itkResampleImageFilter.h.

LinearInterpolatorType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::LinearInterpolatorType = LinearInterpolateImageFunction<InputImageType, TInterpolatorPrecisionType>

Definition at line 147 of file itkResampleImageFilter.h.

OriginPointType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::OriginPointType = typename TOutputImage::PointType

Definition at line 180 of file itkResampleImageFilter.h.

OutputImagePointer

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 106 of file itkResampleImageFilter.h.

OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::OutputImageRegionType = typename TOutputImage::RegionType

Typedef to describe the output image region type.

Definition at line 176 of file itkResampleImageFilter.h.

OutputImageType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::OutputImageType = TOutputImage

Definition at line 103 of file itkResampleImageFilter.h.

OutputPointType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::OutputPointType = typename TOutputImage::PointType

Definition at line 162 of file itkResampleImageFilter.h.

PixelComponentType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::PixelComponentType = typename PixelConvertType::ComponentType

Definition at line 170 of file itkResampleImageFilter.h.

PixelConvertType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::PixelConvertType = DefaultConvertPixelTraits<PixelType>

Definition at line 168 of file itkResampleImageFilter.h.

PixelType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::PixelType = typename TOutputImage::PixelType

Image pixel value type alias.

Definition at line 165 of file itkResampleImageFilter.h.

Pointer

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::Pointer = SmartPointer<Self>

Definition at line 99 of file itkResampleImageFilter.h.

ReferenceImageBaseType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::ReferenceImageBaseType = ImageBase<OutputImageDimension>

Typedef the reference image type to be the ImageBase of the OutputImageType

Definition at line 184 of file itkResampleImageFilter.h.

Self

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::Self = ResampleImageFilter

Standard class type aliases.

Definition at line 97 of file itkResampleImageFilter.h.

SizeType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SizeType = Size<Self::OutputImageDimension>

Image size type alias.

Definition at line 155 of file itkResampleImageFilter.h.

SpacingType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SpacingType = typename TOutputImage::SpacingType

Image spacing,origin and direction type alias

Definition at line 179 of file itkResampleImageFilter.h.

Superclass

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 98 of file itkResampleImageFilter.h.

TransformPointerType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::TransformPointerType = typename TransformType::ConstPointer

Definition at line 132 of file itkResampleImageFilter.h.

TransformType

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

using itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::TransformType = Transform<TTransformPrecisionType, Self::OutputImageDimension, Self::InputImageDimension>

Transform type alias.

Definition at line 131 of file itkResampleImageFilter.h.

Constructor & Destructor Documentation

ResampleImageFilter()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::ResampleImageFilter ( )

protected

~ResampleImageFilter()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::~ResampleImageFilter ( )

overrideprotecteddefault

Member Function Documentation

AfterThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::AfterThreadedGenerateData ( )

overrideprotectedvirtual

Set the state of the filter after multi-threading.

Reimplemented from itk::ImageSource< TOutputImage >.

BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

Set up state of filter before multi-threading. InterpolatorType::SetInputImage is not thread-safe and hence has to be set up before DynamicThreadedGenerateData

Reimplemented from itk::ImageSource< TOutputImage >.

CastPixelWithBoundsChecking() [1/2]

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

static PixelType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::CastPixelWithBoundsChecking ( const ComponentType  value )

staticprotected

CastPixelWithBoundsChecking() [2/2]

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

template<typename TPixel >

static PixelType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::CastPixelWithBoundsChecking ( const TPixel  value )

staticprotected

DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::DynamicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread )

overrideprotectedvirtual

ResampleImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a DynamicThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling DynamicThreadedGenerateData(). DynamicThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also

ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

ResampleImageFilter needs a different input requested region than the output requested region. As such, ResampleImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also

ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GenerateOutputInformation ( )

overrideprotectedvirtual

ResampleImageFilter produces an image which is a different size than its input. As such, it needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also

ProcessObject::GenerateOutputInformaton()

Reimplemented from itk::ProcessObject.

GetDefaultPixelValue()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual const PixelType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetDefaultPixelValue ( ) const

virtual

Get/Set the pixel value when a transformed pixel is outside of the image. The default default pixel value is 0.

GetModifiableExtrapolator()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual ExtrapolatorType* itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetModifiableExtrapolator ( )

virtual

Get/Set the extrapolator function. The default behavior when sampling outside of the input image is to use the DefaultPixelValue. Some other options include NearestNeighborExtrapolateImageFunction.

GetModifiableInterpolator()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual InterpolatorType* itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetModifiableInterpolator ( )

virtual

Get/Set the interpolator function. The default is LinearInterpolateImageFunction<InputImageType, TInterpolatorPrecisionType>. Some other options are NearestNeighborInterpolateImageFunction (useful for binary masks and other images with a small number of possible pixel values), and BSplineInterpolateImageFunction (which provides a higher order of interpolation).

GetMTime()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

ModifiedTimeType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetMTime ( ) const

overrideprotectedvirtual

Compute the Modified Time based on the changed components.

Reimplemented from itk::Object.

GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

const char* itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

GetOutputDirection()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual const DirectionType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetOutputDirection ( ) const

virtual

Set the output direction cosine matrix.

GetOutputOrigin()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual const OriginPointType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetOutputOrigin ( ) const

virtual

Get the output image origin.

GetOutputSpacing()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual const SpacingType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetOutputSpacing ( ) const

virtual

Get the output image spacing.

GetOutputStartIndex()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual const IndexType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetOutputStartIndex ( ) const

virtual

Get the start index of the output largest possible region.

GetReferenceImage()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual const ReferenceImageBaseType* itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetReferenceImage ( ) const

virtual

Get the reference image that is defining the output information.

GetSize()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual const SizeType& itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetSize ( ) const

virtual

Get/Set the size of the output image.

GetUseReferenceImage()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual bool itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetUseReferenceImage ( ) const

virtual

Turn on/off whether a specified reference image should be used to define the output information.

InitializeTransform()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InitializeTransform ( )

protected

LinearThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::LinearThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread )

protectedvirtual

Implementation for resampling that works for with linear transformation types.

New()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

static Pointer itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::New ( )

static

Method for creation through the object factory.

NonlinearThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::NonlinearThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread )

protectedvirtual

Default implementation for resampling that works for any transformation type.

PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

SetDefaultPixelValue()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetDefaultPixelValue ( PixelType  _arg )

virtual

Get/Set the pixel value when a transformed pixel is outside of the image. The default default pixel value is 0.

SetExtrapolator()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetExtrapolator ( ExtrapolatorType *  _arg )

virtual

Get/Set the extrapolator function. The default behavior when sampling outside of the input image is to use the DefaultPixelValue. Some other options include NearestNeighborExtrapolateImageFunction.

SetInterpolator()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetInterpolator ( InterpolatorType *  _arg )

virtual

Get/Set the interpolator function. The default is LinearInterpolateImageFunction<InputImageType, TInterpolatorPrecisionType>. Some other options are NearestNeighborInterpolateImageFunction (useful for binary masks and other images with a small number of possible pixel values), and BSplineInterpolateImageFunction (which provides a higher order of interpolation).

SetOutputDirection()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetOutputDirection ( DirectionType  _arg )

virtual

Set the output direction cosine matrix.

SetOutputOrigin() [1/2]

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetOutputOrigin ( const double *  origin )

virtual

Set the output image origin.

SetOutputOrigin() [2/2]

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetOutputOrigin ( OriginPointType  _arg )

virtual

Set the output image origin.

SetOutputParametersFromImage()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetOutputParametersFromImage

(

const ImageBaseType *

image

)

Helper method to set the output parameters based on this image.

SetOutputSpacing() [1/2]

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetOutputSpacing ( const double *  spacing )

virtual

Set the output image spacing.

SetOutputSpacing() [2/2]

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetOutputSpacing ( SpacingType  _arg )

virtual

Set the output image spacing.

SetOutputStartIndex()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetOutputStartIndex ( IndexType  _arg )

virtual

Set the start index of the output largest possible region. The default is an index of all zeros.

SetReferenceImage()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetReferenceImage ( const ReferenceImageBaseType *  input )

virtual

Set a reference image to use to define the output information. By default, output information is specified through the SetOutputSpacing, SetOutputOrigin, and SetOutputDirection or SetOutputParametersFromImage methods. Alternatively, this method can be used to specify an image from which to copy the pixel information. UseReferenceImageOn must be set to utilize the reference image.

SetSize()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetSize ( SizeType  _arg )

virtual

Get/Set the size of the output image.

SetTransformInput()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetTransformInput ( const DataObjectDecorator< TransformType > *  _arg )

virtual

Get/Set the coordinate transformation. Set the coordinate transform to use for resampling. Note that this must be in physical coordinates and it is the output-to-input transform, NOT the input-to-output transform that you might naively expect. By default the filter uses an Identity transform. You must provide a different transform here, before attempting to run the filter, if you do not want to use the default Identity transform.

SetUseReferenceImage()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::SetUseReferenceImage ( bool  _arg )

virtual

Turn on/off whether a specified reference image should be used to define the output information.

UseReferenceImageOn()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

virtual void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::UseReferenceImageOn ( )

virtual

Turn on/off whether a specified reference image should be used to define the output information.

VerifyInputInformation()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::VerifyInputInformation ( ) const

inlineoverrideprotectedvirtual

Override VerifyInputInformation() since this filter's inputs do not need to occupy the same physical space.

See also

ProcessObject::VerifyInputInformation

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 300 of file itkResampleImageFilter.h.

VerifyPreconditions()

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

void itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::VerifyPreconditions ( ) const

overridevirtual

Verifies that the process object has been configured correctly, that all required inputs are set, and needed parameters are set appropriately. If not valid an exceptions will be thrown.

This method is called before UpdateOutputInformation() is propagated to the inputs.

The ProcessObject's implementation verifies that the m_NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

Member Data Documentation

InputImageDimension

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

constexpr unsigned int itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

Number of dimensions of input image.

Definition at line 119 of file itkResampleImageFilter.h.

m_DefaultPixelValue

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

PixelType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::m_DefaultPixelValue {}

protected

Definition at line 384 of file itkResampleImageFilter.h.

m_Extrapolator

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

ExtrapolatorPointerType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::m_Extrapolator {}

protected

Definition at line 382 of file itkResampleImageFilter.h.

m_Interpolator

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

InterpolatorPointerType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::m_Interpolator {}

protected

Definition at line 380 of file itkResampleImageFilter.h.

m_OutputDirection

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

DirectionType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::m_OutputDirection {}

protected

Definition at line 389 of file itkResampleImageFilter.h.

m_OutputOrigin

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

OriginPointType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::m_OutputOrigin {}

protected

Definition at line 388 of file itkResampleImageFilter.h.

m_OutputSpacing

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

SpacingType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::m_OutputSpacing {}

protected

Definition at line 387 of file itkResampleImageFilter.h.

m_OutputStartIndex

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

IndexType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::m_OutputStartIndex {}

protected

Definition at line 390 of file itkResampleImageFilter.h.

m_Size

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

SizeType itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::m_Size {}

protected

Definition at line 379 of file itkResampleImageFilter.h.

m_UseReferenceImage

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

bool itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::m_UseReferenceImage { false }

protected

Definition at line 391 of file itkResampleImageFilter.h.

OutputImageDimension

template<typename TInputImage , typename TOutputImage , typename TInterpolatorPrecisionType = double, typename TTransformPrecisionType = TInterpolatorPrecisionType>

constexpr unsigned int itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Number of dimensions of output image.

Definition at line 116 of file itkResampleImageFilter.h.

---

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

• itkResampleImageFilter.h