ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::BSplineResampleImageFunction< TImageType, TCoordRep > Class Template Reference

#include <itkBSplineResampleImageFunction.h>

Detailed Description

template<typename TImageType, typename TCoordRep = float>
class itk::BSplineResampleImageFunction< TImageType, TCoordRep >

Resample image intensity from a BSpline coefficient image.

This class resample the image intensity at a non-integer position from the input BSpline coefficient image.

Spline order may be from 0 to 5.

In ITK, BSpline coefficient can be generated using a BSplineDecompositionImageFilter. Using this image function in conjunction with ResampleImageFunction allows the reconstruction of the original image at different resolution and size.

See also
BSplineInterpolateImageFunction
BSplineDecompositionImageFilter
ResampleImageFilter
Examples
Examples/RegistrationITKv4/DeformableRegistration15.cxx.

Definition at line 57 of file itkBSplineResampleImageFunction.h.

+ Inheritance diagram for itk::BSplineResampleImageFunction< TImageType, TCoordRep >:
+ Collaboration diagram for itk::BSplineResampleImageFunction< TImageType, TCoordRep >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = BSplineResampleImageFunction
 
using Superclass = BSplineInterpolateImageFunction< TImageType, TCoordRep, typename TImageType::PixelType >
 
- Public Types inherited from itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >
using CoefficientDataType = TImageType::PixelType
 
using CoefficientFilter = BSplineDecompositionImageFilter< TImageType, CoefficientImageType >
 
using CoefficientFilterPointer = typename CoefficientFilter::Pointer
 
using CoefficientImageType = Image< CoefficientDataType, Self::ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using CovariantVectorType = CovariantVector< OutputType, Self::ImageDimension >
 
using Iterator = ImageLinearIteratorWithIndex< TImageType >
 
using Pointer = SmartPointer< Self >
 
using Self = BSplineInterpolateImageFunction
 
using Superclass = InterpolateImageFunction< TImageType, TCoordRep >
 
- Public Types inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< typename TImageType ::PixelType >::RealType
 
using Self = InterpolateImageFunction
 
using SizeType = typename InputImageType::SizeType
 
using Superclass = ImageFunction< TImageType, typename NumericTraits< typename TImageType ::PixelType >::RealType, TCoordRep >
 
- Public Types inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordRep, Self::ImageDimension >
 
using CoordRepType = TCoordRep
 
using IndexType = typename InputImageType::IndexType
 
using IndexValueType = typename InputImageType::IndexValueType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImageType = TImageType
 
using InputPixelType = typename InputImageType::PixelType
 
using OutputType = NumericTraits< TImageType ::PixelType >::RealType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< TCoordRep, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, NumericTraits< TImageType ::PixelType >::RealType >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TImageType ::ImageDimension >, NumericTraits< TImageType ::PixelType >::RealType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordRep, TImageType ::ImageDimension >
 
using OutputType = NumericTraits< TImageType ::PixelType >::RealType
 
using Pointer = SmartPointer< Self >
 
using Self = FunctionBase
 
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
 
void SetInputImage (const TImageType *inputData) override
 
- Public Member Functions inherited from itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >
virtual OutputType Evaluate (const PointType &point, ThreadIdType threadId) const
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
 
virtual OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &x, ThreadIdType threadId) const
 
CovariantVectorType EvaluateDerivative (const PointType &point) const
 
CovariantVectorType EvaluateDerivative (const PointType &point, ThreadIdType threadId) const
 
CovariantVectorType EvaluateDerivativeAtContinuousIndex (const ContinuousIndexType &x) const
 
CovariantVectorType EvaluateDerivativeAtContinuousIndex (const ContinuousIndexType &x, ThreadIdType threadId) const
 
void EvaluateValueAndDerivative (const PointType &point, OutputType &value, CovariantVectorType &deriv) const
 
void EvaluateValueAndDerivative (const PointType &point, OutputType &value, CovariantVectorType &deriv, ThreadIdType threadId) const
 
void EvaluateValueAndDerivativeAtContinuousIndex (const ContinuousIndexType &x, OutputType &value, CovariantVectorType &deriv) const
 
void EvaluateValueAndDerivativeAtContinuousIndex (const ContinuousIndexType &x, OutputType &value, CovariantVectorType &derivativeValue, ThreadIdType threadId) const
 
const char * GetNameOfClass () const override
 
virtual ThreadIdType GetNumberOfWorkUnits () const
 
SizeType GetRadius () const override
 
virtual unsigned int GetSplineOrder () const
 
void SetInputImage (const TImageType *inputData) override
 
void SetNumberOfWorkUnits (ThreadIdType numThreads)
 
void SetSplineOrder (unsigned int SplineOrder)
 
OutputType Evaluate (const PointType &point) const override
 
virtual void SetUseImageDirection (bool _arg)
 
virtual bool GetUseImageDirection () const
 
virtual void UseImageDirectionOn ()
 
- Public Member Functions inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
OutputType EvaluateAtIndex (const IndexType &index) const override
 
const char * GetNameOfClass () const override
 
OutputType Evaluate (const PointType &point) const override
 
- Public Member Functions inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () const
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >
static Pointer New ()
 
- 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 ()
 

Protected Member Functions

 BSplineResampleImageFunction ()=default
 
 ~BSplineResampleImageFunction () override=default
 
- Protected Member Functions inherited from itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >
 BSplineInterpolateImageFunction ()
 
virtual OutputType EvaluateAtContinuousIndexInternal (const ContinuousIndexType &x, vnl_matrix< long > &evaluateIndex, vnl_matrix< double > &weights) const
 
virtual CovariantVectorType EvaluateDerivativeAtContinuousIndexInternal (const ContinuousIndexType &x, vnl_matrix< long > &evaluateIndex, vnl_matrix< double > &weights, vnl_matrix< double > &weightsDerivative) const
 
virtual void EvaluateValueAndDerivativeAtContinuousIndexInternal (const ContinuousIndexType &x, OutputType &value, CovariantVectorType &derivativeValue, vnl_matrix< long > &evaluateIndex, vnl_matrix< double > &weights, vnl_matrix< double > &weightsDerivative) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BSplineInterpolateImageFunction () override=default
 
- Protected Member Functions inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
 InterpolateImageFunction ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~InterpolateImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >
 ImageFunction ()
 
 ~ImageFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TImageType ::ImageDimension >, NumericTraits< TImageType ::PixelType >::RealType >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- 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 ()
 

Additional Inherited Members

- Static Public Attributes inherited from itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >
static constexpr unsigned int ImageDimension
 
- Protected Attributes inherited from itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >
CoefficientImageType::ConstPointer m_Coefficients
 
TImageType::SizeType m_DataLength
 
std::vector< CoefficientDataTypem_Scratch
 
unsigned int m_SplineOrder
 
- Protected Attributes inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TImageType , typename TCoordRep = float>
using itk::BSplineResampleImageFunction< TImageType, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 68 of file itkBSplineResampleImageFunction.h.

◆ Pointer

template<typename TImageType , typename TCoordRep = float>
using itk::BSplineResampleImageFunction< TImageType, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 67 of file itkBSplineResampleImageFunction.h.

◆ Self

template<typename TImageType , typename TCoordRep = float>
using itk::BSplineResampleImageFunction< TImageType, TCoordRep >::Self = BSplineResampleImageFunction

Standard class type aliases.

Definition at line 64 of file itkBSplineResampleImageFunction.h.

◆ Superclass

template<typename TImageType , typename TCoordRep = float>
using itk::BSplineResampleImageFunction< TImageType, TCoordRep >::Superclass = BSplineInterpolateImageFunction<TImageType, TCoordRep, typename TImageType::PixelType>

Definition at line 65 of file itkBSplineResampleImageFunction.h.

Constructor & Destructor Documentation

◆ BSplineResampleImageFunction()

template<typename TImageType , typename TCoordRep = float>
itk::BSplineResampleImageFunction< TImageType, TCoordRep >::BSplineResampleImageFunction ( )
protecteddefault

◆ ~BSplineResampleImageFunction()

template<typename TImageType , typename TCoordRep = float>
itk::BSplineResampleImageFunction< TImageType, TCoordRep >::~BSplineResampleImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ GetNameOfClass()

template<typename TImageType , typename TCoordRep = float>
const char* itk::BSplineResampleImageFunction< TImageType, TCoordRep >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ New()

template<typename TImageType , typename TCoordRep = float>
static Pointer itk::BSplineResampleImageFunction< TImageType, TCoordRep >::New ( )
static

New macro for creation of through a Smart Pointer

◆ SetInputImage()

template<typename TImageType , typename TCoordRep = float>
void itk::BSplineResampleImageFunction< TImageType, TCoordRep >::SetInputImage ( const TImageType *  inputData)
inlineoverridevirtual

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