ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::BSplineControlPointImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkBSplineControlPointImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >

Process a given a B-spline grid of control points.

The output of the class itkBSplineScatteredDataPointSetToImageFilter
is a control point grid defining a B-spline object. This class is used to hold various routines meant to operate on that control point grid. In addition to specifying the control point grid as the input, the user must also supply the spline order and the parametric domain (i.e. size, domain, origin, direction, spacing). The output of the filter is the sampled B-spline object.

This code was contributed in the Insight Journal paper: "N-D C^k B-Spline Scattered Data Approximation" by Nicholas J. Tustison, James C. Gee https://www.insight-journal.org/browse/publication/57

Author
Nicholas J. Tustison

Definition at line 59 of file itkBSplineControlPointImageFilter.h.

+ Inheritance diagram for itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >:

Public Types

using ArrayType = FixedArray< unsigned int, Self::ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using ControlPointLatticeType = TInputImage
 
using DirectionType = typename OutputImageType::DirectionType
 
using IndexType = typename OutputImageType::IndexType
 
using KernelOrder0Type = BSplineKernelFunction< 0 >
 
using KernelOrder1Type = BSplineKernelFunction< 1 >
 
using KernelOrder2Type = BSplineKernelFunction< 2 >
 
using KernelOrder3Type = BSplineKernelFunction< 3 >
 
using KernelType = CoxDeBoorBSplineKernelFunction< 3 >
 
using OriginType = typename OutputImageType::PointType
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using PixelType = typename OutputImageType::PixelType
 
using PointDataContainerType = typename PointSetType::PointDataContainer
 
using PointDataImagePointer = typename PointDataImageType::Pointer
 
using PointDataImageType = Image< PointDataType, Self::ImageDimension >
 
using PointDataType = typename PointSetType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointSetType = PointSet< PixelType, Self::ImageDimension >
 
using PointType = typename OutputImageType::PointType
 
using RealArrayType = FixedArray< RealType, Self::ImageDimension >
 
using RealImagePointer = typename RealImageType::Pointer
 
using RealImageType = Image< RealType, Self::ImageDimension >
 
using RealType = float
 
using RegionType = typename OutputImageType::RegionType
 
using Self = BSplineControlPointImageFilter
 
using SizeType = typename OutputImageType::SizeType
 
using SpacingType = typename OutputImageType::SpacingType
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- 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

virtual DirectionType GetDirection () const
 
virtual const ArrayTypeGetSplineOrder () const
 
 itkOverrideGetNameOfClassMacro (BSplineControlPointImageFilter)
 
ControlPointLatticeType::Pointer RefineControlPointLattice (ArrayType)
 
virtual void SetDirection (DirectionType _arg)
 
void SetSplineOrder (ArrayType)
 
void SetSplineOrder (unsigned int)
 
virtual void SetCloseDimension (ArrayType _arg)
 
virtual const ArrayTypeGetCloseDimension () const
 
virtual void SetSpacing (SpacingType _arg)
 
virtual SpacingType GetSpacing () const
 
virtual void SetOrigin (OriginType _arg)
 
virtual OriginType GetOrigin () const
 
virtual void SetSize (SizeType _arg)
 
virtual SizeType GetSize () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
 itkOverrideGetNameOfClassMacro (ImageToImageFilter)
 
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 >
OutputImageTypeGetOutput (unsigned int idx)
 
 itkOverrideGetNameOfClassMacro (ImageSource)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () 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 ()
 
MultiThreaderTypeGetMultiThreader () 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)
 
 itkOverrideGetNameOfClassMacro (ProcessObject)
 
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 ThreadIdTypeGetNumberOfWorkUnits () 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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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 ImageDimension = TInputImage::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

 BSplineControlPointImageFilter ()
 
void DynamicThreadedGenerateData (const OutputImageRegionType &) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BSplineControlPointImageFilter () 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)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~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 AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
 ~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 GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () 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 ()
 

Private Member Functions

void BeforeThreadedGenerateData () override
 
void CollapsePhiLattice (PointDataImageType *, PointDataImageType *, const RealType, const unsigned int)
 
RealImageType::IndexType NumberToIndex (unsigned int number, typename RealImageType::SizeType size)
 
void SetNumberOfLevels (ArrayType)
 
unsigned int SplitRequestedRegion (unsigned int, unsigned int, OutputImageRegionType &) override
 

Private Attributes

RealType m_BSplineEpsilon { static_cast<RealType>(1e-3) }
 
ArrayType m_CloseDimension {}
 
DirectionType m_Direction {}
 
bool m_DoMultilevel { false }
 
KernelType::Pointer m_Kernel [ImageDimension] {}
 
KernelOrder0Type::Pointer m_KernelOrder0 {}
 
KernelOrder1Type::Pointer m_KernelOrder1 {}
 
KernelOrder2Type::Pointer m_KernelOrder2 {}
 
KernelOrder3Type::Pointer m_KernelOrder3 {}
 
unsigned int m_MaximumNumberOfLevels { 1 }
 
ArrayType m_NumberOfControlPoints {}
 
ArrayType m_NumberOfLevels {}
 
OriginType m_Origin {}
 
vnl_matrix< RealTypem_RefinedLatticeCoefficients [ImageDimension] {}
 
SizeType m_Size {}
 
SpacingType m_Spacing {}
 
ArrayType m_SplineOrder {}
 

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 >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading {}
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ArrayType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::ArrayType = FixedArray<unsigned int, Self::ImageDimension>

Definition at line 98 of file itkBSplineControlPointImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 67 of file itkBSplineControlPointImageFilter.h.

◆ ControlPointLatticeType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::ControlPointLatticeType = TInputImage

Definition at line 78 of file itkBSplineControlPointImageFilter.h.

◆ DirectionType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::DirectionType = typename OutputImageType::DirectionType

Definition at line 91 of file itkBSplineControlPointImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::IndexType = typename OutputImageType::IndexType

Definition at line 84 of file itkBSplineControlPointImageFilter.h.

◆ KernelOrder0Type

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::KernelOrder0Type = BSplineKernelFunction<0>

Definition at line 110 of file itkBSplineControlPointImageFilter.h.

◆ KernelOrder1Type

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::KernelOrder1Type = BSplineKernelFunction<1>

Definition at line 111 of file itkBSplineControlPointImageFilter.h.

◆ KernelOrder2Type

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::KernelOrder2Type = BSplineKernelFunction<2>

Definition at line 112 of file itkBSplineControlPointImageFilter.h.

◆ KernelOrder3Type

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::KernelOrder3Type = BSplineKernelFunction<3>

Definition at line 113 of file itkBSplineControlPointImageFilter.h.

◆ KernelType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::KernelType = CoxDeBoorBSplineKernelFunction<3>

Interpolation kernel type (default spline order = 3)

Definition at line 109 of file itkBSplineControlPointImageFilter.h.

◆ OriginType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::OriginType = typename OutputImageType::PointType

Definition at line 89 of file itkBSplineControlPointImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 86 of file itkBSplineControlPointImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 79 of file itkBSplineControlPointImageFilter.h.

◆ PixelType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::PixelType = typename OutputImageType::PixelType

Image type alias support

Definition at line 82 of file itkBSplineControlPointImageFilter.h.

◆ PointDataContainerType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::PointDataContainerType = typename PointSetType::PointDataContainer

Definition at line 104 of file itkBSplineControlPointImageFilter.h.

◆ PointDataImagePointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::PointDataImagePointer = typename PointDataImageType::Pointer

Definition at line 106 of file itkBSplineControlPointImageFilter.h.

◆ PointDataImageType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::PointDataImageType = Image<PointDataType, Self::ImageDimension>

Definition at line 105 of file itkBSplineControlPointImageFilter.h.

◆ PointDataType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::PointDataType = typename PointSetType::PixelType

Definition at line 103 of file itkBSplineControlPointImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 66 of file itkBSplineControlPointImageFilter.h.

◆ PointSetType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::PointSetType = PointSet<PixelType, Self::ImageDimension>

PointSet type alias support

Definition at line 102 of file itkBSplineControlPointImageFilter.h.

◆ PointType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::PointType = typename OutputImageType::PointType

Definition at line 85 of file itkBSplineControlPointImageFilter.h.

◆ RealArrayType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::RealArrayType = FixedArray<RealType, Self::ImageDimension>

Definition at line 99 of file itkBSplineControlPointImageFilter.h.

◆ RealImagePointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::RealImagePointer = typename RealImageType::Pointer

Definition at line 96 of file itkBSplineControlPointImageFilter.h.

◆ RealImageType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::RealImageType = Image<RealType, Self::ImageDimension>

Definition at line 95 of file itkBSplineControlPointImageFilter.h.

◆ RealType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::RealType = float

Other type alias

Definition at line 94 of file itkBSplineControlPointImageFilter.h.

◆ RegionType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::RegionType = typename OutputImageType::RegionType

Definition at line 83 of file itkBSplineControlPointImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::Self = BSplineControlPointImageFilter

Definition at line 64 of file itkBSplineControlPointImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SizeType = typename OutputImageType::SizeType

Definition at line 90 of file itkBSplineControlPointImageFilter.h.

◆ SpacingType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SpacingType = typename OutputImageType::SpacingType

Definition at line 88 of file itkBSplineControlPointImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 65 of file itkBSplineControlPointImageFilter.h.

Constructor & Destructor Documentation

◆ BSplineControlPointImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::BSplineControlPointImageFilter ( )
protected

◆ ~BSplineControlPointImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::~BSplineControlPointImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )
overrideprivatevirtual

Before splitting, we need to allocate memory for the output sampled B-spline object based on the multi-threading functionality

Reimplemented from itk::ImageSource< TOutputImage >.

◆ CollapsePhiLattice()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::CollapsePhiLattice ( PointDataImageType ,
PointDataImageType ,
const  RealType,
const unsigned int   
)
private

Sub-function used by GenerateOutputImageFast() to generate the sampled B-spline object quickly.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType )
overrideprotectedvirtual

Multi-threaded function which generates the output sampled B-spline object.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetCloseDimension()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual const ArrayType& itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::GetCloseDimension ( ) const
virtual

Set/Get the boolean array indicating the periodicity of the B-spline object. This array of 0/1 values defines whether a particular dimension of the parametric space is to be considered periodic or not. For example, if you are using interpolating along a 1D closed curve, the array type will have size 1, and you should set the first element of this array to the value "1". In the case that you were interpolating in a planar surface with cylindrical topology, the array type will have two components, and you should set to "1" the component that goes around the cylinder, and set to "0" the component that goes from the top of the cylinder to the bottom. This will indicate the periodicity of that parameter to the filter. Internally, in order to make periodic the domain of the parameter, the filter will reuse some of the points at the beginning of the domain as if they were also located at the end of the domain. The number of points to be reused will depend on the spline order. As a user, you don't need to replicate the points, the filter will do this for you.

◆ GetDirection()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual DirectionType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::GetDirection ( ) const
virtual

Get the sampled B-spline object direction.

◆ GetOrigin()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual OriginType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::GetOrigin ( ) const
virtual

Set/Get the parametric origin of the B-spline object domain.

◆ GetSize()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual SizeType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::GetSize ( ) const
virtual

Set/Get the parametric size of the B-spline object domain.

◆ GetSpacing()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual SpacingType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::GetSpacing ( ) const
virtual

Set/Get the parametric spacing of the B-spline object domain.

◆ GetSplineOrder()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual const ArrayType& itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::GetSplineOrder ( ) const
virtual

Get the spline order array of the B-spline object. Default = 3.

◆ itkOverrideGetNameOfClassMacro()

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::itkOverrideGetNameOfClassMacro ( BSplineControlPointImageFilter< TInputImage, TOutputImage >  )

Run-time type information (and related methods).

◆ New()

template<typename TInputImage , typename TOutputImage = TInputImage>
static Pointer itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ NumberToIndex()

template<typename TInputImage , typename TOutputImage = TInputImage>
RealImageType::IndexType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::NumberToIndex ( unsigned int  number,
typename RealImageType::SizeType  size 
)
inlineprivate

Definition at line 266 of file itkBSplineControlPointImageFilter.h.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::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 >.

◆ RefineControlPointLattice()

template<typename TInputImage , typename TOutputImage = TInputImage>
ControlPointLatticeType::Pointer itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::RefineControlPointLattice ( ArrayType  )

Generate a refined control point lattice from the input control point lattice such that the resolution is doubled for each level. This is further described in the references. Note that if one sets the number of refinement levels to all 1's, the control point lattice is not increased in resolution. Doubling the resolution starts at 2 refinement levels.

◆ SetCloseDimension()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SetCloseDimension ( ArrayType  _arg)
virtual

Set/Get the boolean array indicating the periodicity of the B-spline object. This array of 0/1 values defines whether a particular dimension of the parametric space is to be considered periodic or not. For example, if you are using interpolating along a 1D closed curve, the array type will have size 1, and you should set the first element of this array to the value "1". In the case that you were interpolating in a planar surface with cylindrical topology, the array type will have two components, and you should set to "1" the component that goes around the cylinder, and set to "0" the component that goes from the top of the cylinder to the bottom. This will indicate the periodicity of that parameter to the filter. Internally, in order to make periodic the domain of the parameter, the filter will reuse some of the points at the beginning of the domain as if they were also located at the end of the domain. The number of points to be reused will depend on the spline order. As a user, you don't need to replicate the points, the filter will do this for you.

◆ SetDirection()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SetDirection ( DirectionType  _arg)
virtual

Set the sampled object direction. Note that this is not used in any of the calculations in this class. The only reason why it is included is due to the fact that we use the image class to represent the B-spline parametric domain (due to the maturity of the image class and the wealth of helper functions associated with it). This is where the incongruence between the B-spline parametric domain and the concept of an image is most obvious. An ITK image is a representation of a physical object thus it also exists in physical space which includes orientation. However, it can be argued that the parametric domain, per se, does not exist in physical space and it is only a parametric mapping which allows us to go from the parametric space to the physical space. Therefore, the direction is not used.

◆ SetNumberOfLevels()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SetNumberOfLevels ( ArrayType  )
private

Private function to handle the internal ivars.

◆ SetOrigin()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SetOrigin ( OriginType  _arg)
virtual

Set/Get the parametric origin of the B-spline object domain.

◆ SetSize()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SetSize ( SizeType  _arg)
virtual

Set/Get the parametric size of the B-spline object domain.

◆ SetSpacing()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SetSpacing ( SpacingType  _arg)
virtual

Set/Get the parametric spacing of the B-spline object domain.

◆ SetSplineOrder() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SetSplineOrder ( ArrayType  )

Set the spline order array where each element of the array corresponds to a single parametric dimension of the B-spline object. Default = 3.

◆ SetSplineOrder() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SetSplineOrder ( unsigned int  )

Set the spline order of the B-spline object for all parametric dimensions. Default = 3.

◆ SplitRequestedRegion()

template<typename TInputImage , typename TOutputImage = TInputImage>
unsigned int itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::SplitRequestedRegion ( unsigned int  ,
unsigned int  ,
OutputImageRegionType  
)
overrideprivatevirtual

Based on the way CollapsePhiLattice() is written, we want to split on the the last dimension.

Reimplemented from itk::ImageSource< TOutputImage >.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage = TInputImage>
constexpr unsigned int itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Extract dimension from input image.

Definition at line 76 of file itkBSplineControlPointImageFilter.h.

◆ m_BSplineEpsilon

template<typename TInputImage , typename TOutputImage = TInputImage>
RealType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_BSplineEpsilon { static_cast<RealType>(1e-3) }
private

Definition at line 263 of file itkBSplineControlPointImageFilter.h.

◆ m_CloseDimension

template<typename TInputImage , typename TOutputImage = TInputImage>
ArrayType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_CloseDimension {}
private

Definition at line 251 of file itkBSplineControlPointImageFilter.h.

◆ m_Direction

template<typename TInputImage , typename TOutputImage = TInputImage>
DirectionType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_Direction {}
private

Definition at line 246 of file itkBSplineControlPointImageFilter.h.

◆ m_DoMultilevel

template<typename TInputImage , typename TOutputImage = TInputImage>
bool itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_DoMultilevel { false }
private

Definition at line 248 of file itkBSplineControlPointImageFilter.h.

◆ m_Kernel

template<typename TInputImage , typename TOutputImage = TInputImage>
KernelType::Pointer itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_Kernel[ImageDimension] {}
private

Definition at line 257 of file itkBSplineControlPointImageFilter.h.

◆ m_KernelOrder0

template<typename TInputImage , typename TOutputImage = TInputImage>
KernelOrder0Type::Pointer itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_KernelOrder0 {}
private

Definition at line 258 of file itkBSplineControlPointImageFilter.h.

◆ m_KernelOrder1

template<typename TInputImage , typename TOutputImage = TInputImage>
KernelOrder1Type::Pointer itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_KernelOrder1 {}
private

Definition at line 259 of file itkBSplineControlPointImageFilter.h.

◆ m_KernelOrder2

template<typename TInputImage , typename TOutputImage = TInputImage>
KernelOrder2Type::Pointer itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_KernelOrder2 {}
private

Definition at line 260 of file itkBSplineControlPointImageFilter.h.

◆ m_KernelOrder3

template<typename TInputImage , typename TOutputImage = TInputImage>
KernelOrder3Type::Pointer itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_KernelOrder3 {}
private

Definition at line 261 of file itkBSplineControlPointImageFilter.h.

◆ m_MaximumNumberOfLevels

template<typename TInputImage , typename TOutputImage = TInputImage>
unsigned int itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_MaximumNumberOfLevels { 1 }
private

Definition at line 249 of file itkBSplineControlPointImageFilter.h.

◆ m_NumberOfControlPoints

template<typename TInputImage , typename TOutputImage = TInputImage>
ArrayType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_NumberOfControlPoints {}
private

Definition at line 250 of file itkBSplineControlPointImageFilter.h.

◆ m_NumberOfLevels

template<typename TInputImage , typename TOutputImage = TInputImage>
ArrayType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_NumberOfLevels {}
private

Definition at line 253 of file itkBSplineControlPointImageFilter.h.

◆ m_Origin

template<typename TInputImage , typename TOutputImage = TInputImage>
OriginType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_Origin {}
private

Definition at line 245 of file itkBSplineControlPointImageFilter.h.

◆ m_RefinedLatticeCoefficients

template<typename TInputImage , typename TOutputImage = TInputImage>
vnl_matrix<RealType> itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_RefinedLatticeCoefficients[ImageDimension] {}
private

Definition at line 255 of file itkBSplineControlPointImageFilter.h.

◆ m_Size

template<typename TInputImage , typename TOutputImage = TInputImage>
SizeType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_Size {}
private

Parameters for the output image.

Definition at line 243 of file itkBSplineControlPointImageFilter.h.

◆ m_Spacing

template<typename TInputImage , typename TOutputImage = TInputImage>
SpacingType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_Spacing {}
private

Definition at line 244 of file itkBSplineControlPointImageFilter.h.

◆ m_SplineOrder

template<typename TInputImage , typename TOutputImage = TInputImage>
ArrayType itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >::m_SplineOrder {}
private

Definition at line 252 of file itkBSplineControlPointImageFilter.h.


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