SimpleITK  2.1.0.dev79
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::BSplineDecompositionImageFilter Class Reference

Calculates the B-Spline coefficients of an image. Spline order may be from 0 to 5. More...

#include <sitkBSplineDecompositionImageFilter.h>

+ Inheritance diagram for itk::simple::BSplineDecompositionImageFilter:
+ Collaboration diagram for itk::simple::BSplineDecompositionImageFilter:

Public Types

using PixelIDTypeList = RealPixelIDTypeList
 
using Self = BSplineDecompositionImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

 BSplineDecompositionImageFilter ()
 
Image Execute (const Image &image1)
 
std::string GetName () const
 
uint32_t GetSplineOrder () const
 
std::vector< double > GetSplinePoles () const
 
SelfSetSplineOrder (uint32_t SplineOrder)
 
std::string ToString () const
 
virtual ~BSplineDecompositionImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
uint32_t m_SplineOrder {3u}
 
std::vector< double > m_SplinePoles {std::vector<double>()}
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

Calculates the B-Spline coefficients of an image. Spline order may be from 0 to 5.

This class defines N-Dimension B-Spline transformation. It is based on: [1] M. Unser, "Splines: A Perfect Fit for Signal and Image Processing," IEEE Signal Processing Magazine, vol. 16, no. 6, pp. 22-38, November 1999. [2] M. Unser, A. Aldroubi and M. Eden, "B-Spline Signal Processing: Part I--Theory," IEEE Transactions on Signal Processing, vol. 41, no. 2, pp. 821-832, February 1993. [3] M. Unser, A. Aldroubi and M. Eden, "B-Spline Signal Processing: Part II--Efficient Design and Applications," IEEE Transactions on Signal Processing, vol. 41, no. 2, pp. 834-848, February 1993. And code obtained from bigwww.epfl.ch by Philippe Thevenaz

Limitations: Spline order must be between 0 and 5. Spline order must be set before setting the image. Uses mirror boundary conditions. Requires the same order of Spline for each dimension. Can only process LargestPossibleRegion

See also
BSplineResampleImageFunction
itk::simple::BSplineDecomposition for the procedural interface
itk::BSplineDecompositionImageFilter for the Doxygen on the original ITK class.

Definition at line 46 of file sitkBSplineDecompositionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 93 of file sitkBSplineDecompositionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkBSplineDecompositionImageFilter.h.

◆ Self

Definition at line 48 of file sitkBSplineDecompositionImageFilter.h.

Constructor & Destructor Documentation

◆ ~BSplineDecompositionImageFilter()

virtual itk::simple::BSplineDecompositionImageFilter::~BSplineDecompositionImageFilter ( )
virtual

Destructor

◆ BSplineDecompositionImageFilter()

itk::simple::BSplineDecompositionImageFilter::BSplineDecompositionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::BSplineDecompositionImageFilter::Execute ( const Image image1)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::BSplineDecompositionImageFilter::ExecuteInternal ( const Image image1)
private

◆ GetName()

std::string itk::simple::BSplineDecompositionImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 79 of file sitkBSplineDecompositionImageFilter.h.

◆ GetSplineOrder()

uint32_t itk::simple::BSplineDecompositionImageFilter::GetSplineOrder ( ) const
inline

Definition at line 68 of file sitkBSplineDecompositionImageFilter.h.

◆ GetSplinePoles()

std::vector<double> itk::simple::BSplineDecompositionImageFilter::GetSplinePoles ( ) const
inline

Get the poles calculated for a given spline order.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 75 of file sitkBSplineDecompositionImageFilter.h.

◆ SetSplineOrder()

Self& itk::simple::BSplineDecompositionImageFilter::SetSplineOrder ( uint32_t  SplineOrder)
inline

Get/Sets the Spline Order, supports 0th - 5th order splines. The default is a 3rd order spline.

Definition at line 64 of file sitkBSplineDecompositionImageFilter.h.

◆ ToString()

std::string itk::simple::BSplineDecompositionImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 97 of file sitkBSplineDecompositionImageFilter.h.

Member Data Documentation

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::BSplineDecompositionImageFilter::m_MemberFactory
private

Definition at line 99 of file sitkBSplineDecompositionImageFilter.h.

◆ m_SplineOrder

uint32_t itk::simple::BSplineDecompositionImageFilter::m_SplineOrder {3u}
private

Definition at line 103 of file sitkBSplineDecompositionImageFilter.h.

◆ m_SplinePoles

std::vector<double> itk::simple::BSplineDecompositionImageFilter::m_SplinePoles {std::vector<double>()}
private

Definition at line 106 of file sitkBSplineDecompositionImageFilter.h.


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