go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes
elastix::GridSampler< TElastix > Class Template Reference

#include <elxGridSampler.h>

Detailed Description

template<class TElastix>
class elastix::GridSampler< TElastix >

An interpolator based on the itk::ImageGridSampler.

This image sampler samples voxels on a uniform grid. This sampler is in most cases not recommended.

This sampler does not react on the NewSamplesEveryIteration parameter.

The parameters used in this class are:

Parameters:

ImageSampler: Select this image sampler as follows:
(ImageSampler "Grid")

SampleGridSpacing: Defines the sampling grid in case of a Grid ImageSampler.
An integer downsampling factor must be specified for each dimension, for each resolution.
example: (SampleGridSpacing 4 4 2 2)
Default is 2 for each dimension for each resolution.

Definition at line 49 of file elxGridSampler.h.

Inheritance diagram for elastix::GridSampler< TElastix >:
Inheritance graph
[legend]

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using GridSpacingType = typename Superclass1::SampleGridSpacingType
 
using ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType >
 
using ImageSampleType = ImageSample< InputImageType >
 
using InputImageIndexType = typename InputImageType::IndexType
 
using InputImagePointType = typename InputImageType::PointType
 
using ITKBaseType = typename Superclass2::ITKBaseType
 
using MaskType = SpatialObject< Self::InputImageDimension >
 
using Pointer = itk::SmartPointer< Self >
 
using SampleGridSpacingValueType = typename SampleGridSpacingType::OffsetValueType
 
using Self = GridSampler
 
using Superclass1 = itk::ImageGridSampler< typename elx::ImageSamplerBase< TElastix >::InputImageType >
 
using Superclass2 = elx::ImageSamplerBase< TElastix >
 
- Public Types inherited from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
using ConstPointer = SmartPointer< const Self >
 
using ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer
 
using ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType >
 
using ImageSampleType = ImageSample< InputImageType >
 
using InputImageIndexType = typename InputImageType::IndexType
 
using InputImagePointType = typename InputImageType::PointType
 
using InputImageSizeType = typename InputImageType::SizeType
 
using MaskType = SpatialObject< Self::InputImageDimension >
 
using Pointer = SmartPointer< Self >
 
using SampleGridIndexType = InputImageIndexType
 
using SampleGridSizeType = typename InputImageType::SizeType
 
using SampleGridSpacingType = typename InputImageType::OffsetType
 
using SampleGridSpacingValueType = typename SampleGridSpacingType::OffsetValueType
 
using Self = ImageGridSampler
 
using Superclass = ImageSamplerBase< elx::ImageSamplerBase< TElastix >::InputImageType >
 
- Public Types inherited from itk::ImageSamplerBase< TInputImage >
using ConstPointer = SmartPointer< const Self >
 
using ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer
 
using ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType >
 
using ImageSampleType = ImageSample< InputImageType >
 
using ImageSampleValueType = typename ImageSampleType::RealType
 
using InputImageIndexType = typename InputImageType::IndexType
 
using InputImagePointType = typename InputImageType::PointType
 
using InputImagePointValueType = typename InputImagePointType::ValueType
 
using InputImageRegionVectorType = std::vector< InputImageRegionType >
 
using InputImageSizeType = typename InputImageType::SizeType
 
using MaskConstPointer = typename MaskType::ConstPointer
 
using MaskPointer = typename MaskType::Pointer
 
using MaskType = SpatialObject< Self::InputImageDimension >
 
using MaskVectorType = std::vector< MaskConstPointer >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSamplerBase
 
using Superclass = ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
 
- Public Types inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
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 OutputVectorContainerPointer = typename OutputVectorContainerType::Pointer
 
using OutputVectorContainerType = VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToVectorContainerFilter
 
using Superclass = VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
 
- Public Types inherited from itk::VectorContainerSource< TOutputVectorContainer >
using ConstPointer = SmartPointer< const Self >
 
using OutputVectorContainerPointer = typename OutputVectorContainerType::Pointer
 
using OutputVectorContainerType = TOutputVectorContainer
 
using Pointer = SmartPointer< Self >
 
using Self = VectorContainerSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ImageSamplerBase< TElastix >
using ConstPointer = SmartPointer< const Self >
 
using ImageSampleContainerPointer = typename ImageSampleContainerType::Pointer
 
using ImageSampleContainerType = VectorDataContainer< std::vcl_size_t, ImageSampleType >
 
using ImageSampleType = ImageSample< InputImageType >
 
using ImageSampleValueType = typename ImageSampleType::RealType
 
using InputImageIndexType = typename InputImageType::IndexType
 
using InputImagePointType = typename InputImageType::PointType
 
using InputImagePointValueType = typename InputImagePointType::ValueType
 
using InputImageRegionVectorType = std::vector< InputImageRegionType >
 
using InputImageSizeType = typename InputImageType::SizeType
 
using MaskConstPointer = typename MaskType::ConstPointer
 
using MaskPointer = typename MaskType::Pointer
 
using MaskType = SpatialObject< Self::InputImageDimension >
 
using MaskVectorType = std::vector< MaskConstPointer >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSamplerBase
 
using Superclass = ImageToVectorContainerFilter< TElastix, VectorDataContainer< std::vcl_size_t, ImageSample< TElastix > > >
 
- Public Types inherited from itk::ImageToVectorContainerFilter< TInputImage, TOutputVectorContainer >
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 OutputVectorContainerPointer = typename OutputVectorContainerType::Pointer
 
using OutputVectorContainerType = TOutputVectorContainer
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToVectorContainerFilter
 
using Superclass = VectorContainerSource< TOutputVectorContainer >
 

Public Member Functions

void BeforeEachResolution () override
 
 elxClassNameMacro ("Grid")
 
virtual const char * GetClassName () const
 
 ITK_DISALLOW_COPY_AND_MOVE (GridSampler)
 
 itkStaticConstMacro (InputImageDimension, unsigned int, Superclass1::InputImageDimension)
 
- Public Member Functions inherited from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
virtual const char * GetClassName () const
 
virtual const SampleGridSpacingTypeGetSampleGridSpacing ()
 
 ITK_DISALLOW_COPY_AND_MOVE (ImageGridSampler)
 
 itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
 
bool SelectingNewSamplesOnUpdateSupported () const override
 
bool SelectNewSamplesOnUpdate () override
 
void SetNumberOfSamples (unsigned long nrofsamples) override
 
void SetSampleGridSpacing (const SampleGridSpacingType &arg)
 
- Public Member Functions inherited from itk::ImageSamplerBase< TInputImage >
virtual const char * GetClassName () const
 
virtual const InputImageRegionTypeGetCroppedInputImageRegion ()
 
virtual const InputImageRegionTypeGetInputImageRegion () const
 
virtual const InputImageRegionTypeGetInputImageRegion (unsigned int pos) const
 
virtual const MaskTypeGetMask () const
 
virtual const MaskTypeGetMask (unsigned int pos) const
 
virtual unsigned int GetNumberOfInputImageRegions () const
 
virtual unsigned int GetNumberOfMasks () const
 
virtual unsigned long GetNumberOfSamples () const
 
 ITK_DISALLOW_COPY_AND_MOVE (ImageSamplerBase)
 
 itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)
 
virtual bool SelectingNewSamplesOnUpdateSupported () const
 
virtual bool SelectNewSamplesOnUpdate ()
 
virtual void SetInputImageRegion (const InputImageRegionType _arg)
 
virtual void SetInputImageRegion (const InputImageRegionType _arg, unsigned int pos)
 
virtual void SetMask (const MaskType *_arg)
 
virtual void SetMask (const MaskType *_arg, unsigned int pos)
 
virtual void SetNumberOfInputImageRegions (const unsigned int _arg)
 
virtual void SetNumberOfMasks (const unsigned int _arg)
 
virtual void SetNumberOfSamples (unsigned long _arg)
 
virtual void SetUseMultiThread (bool _arg)
 
- Public Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
void GenerateData () override
 
virtual const char * GetClassName () const
 
const InputImageTypeGetInput ()
 
const InputImageTypeGetInput (unsigned int idx)
 
OutputVectorContainerTypeGetOutput ()
 
 ITK_DISALLOW_COPY_AND_MOVE (ImageToVectorContainerFilter)
 
DataObject::Pointer MakeOutput (unsigned int idx) override
 
void SetInput (const InputImageType *input)
 
void SetInput (unsigned int idx, const InputImageType *input)
 
virtual unsigned int SplitRequestedRegion (const ThreadIdType &threadId, const ThreadIdType &numberOfSplits, InputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId)
 
- Public Member Functions inherited from itk::VectorContainerSource< TOutputVectorContainer >
virtual const char * GetClassName () const
 
OutputVectorContainerTypeGetOutput ()
 
OutputVectorContainerTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
 ITK_DISALLOW_COPY_AND_MOVE (VectorContainerSource)
 
virtual DataObjectPointer MakeOutput (unsigned int idx)
 
- Public Member Functions inherited from itk::ImageSamplerBase< TElastix >
virtual const char * GetClassName () const
 
virtual const InputImageRegionTypeGetCroppedInputImageRegion ()
 
virtual const InputImageRegionTypeGetInputImageRegion () const
 
virtual const InputImageRegionTypeGetInputImageRegion (unsigned int pos) const
 
virtual const MaskTypeGetMask () const
 
virtual const MaskTypeGetMask (unsigned int pos) const
 
virtual unsigned int GetNumberOfInputImageRegions () const
 
virtual unsigned int GetNumberOfMasks () const
 
virtual unsigned long GetNumberOfSamples () const
 
 ITK_DISALLOW_COPY_AND_MOVE (ImageSamplerBase)
 
 itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)
 
virtual bool SelectingNewSamplesOnUpdateSupported () const
 
virtual bool SelectNewSamplesOnUpdate ()
 
virtual void SetInputImageRegion (const InputImageRegionType _arg)
 
virtual void SetInputImageRegion (const InputImageRegionType _arg, unsigned int pos)
 
virtual void SetMask (const MaskType *_arg)
 
virtual void SetMask (const MaskType *_arg, unsigned int pos)
 
virtual void SetNumberOfInputImageRegions (const unsigned int _arg)
 
virtual void SetNumberOfMasks (const unsigned int _arg)
 
virtual void SetNumberOfSamples (unsigned long _arg)
 
virtual void SetUseMultiThread (bool _arg)
 
- Public Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, TOutputVectorContainer >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
void GenerateData () override
 
virtual const char * GetClassName () const
 
const InputImageTypeGetInput ()
 
const InputImageTypeGetInput (unsigned int idx)
 
OutputVectorContainerTypeGetOutput ()
 
 ITK_DISALLOW_COPY_AND_MOVE (ImageToVectorContainerFilter)
 
DataObject::Pointer MakeOutput (unsigned int idx) override
 
void SetInput (const InputImageType *input)
 
void SetInput (unsigned int idx, const InputImageType *input)
 
virtual unsigned int SplitRequestedRegion (const ThreadIdType &threadId, const ThreadIdType &numberOfSplits, InputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSamplerBase< TInputImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
static Pointer New ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Public Member Functions inherited from itk::VectorContainerSource< TOutputVectorContainer >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSamplerBase< TElastix >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, TOutputVectorContainer >
static Pointer New ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 

Protected Member Functions

 GridSampler ()=default
 
 ~GridSampler () override=default
 
- Protected Member Functions inherited from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
void GenerateData () override
 
 ImageGridSampler ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageGridSampler () override=default
 
- Protected Member Functions inherited from itk::ImageSamplerBase< TInputImage >
void AfterThreadedGenerateData () override
 
void BeforeThreadedGenerateData () override
 
virtual bool CheckInputImageRegions ()
 
void CropInputImageRegion ()
 
void GenerateInputRequestedRegion () override
 
 ImageSamplerBase ()=default
 
virtual bool IsInsideAllMasks (const InputImagePointType &point) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void UpdateAllMasks ()
 
 ~ImageSamplerBase () override=default
 
- Protected Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
 ImageToVectorContainerFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageToVectorContainerFilter () override=default
 
- Protected Member Functions inherited from itk::VectorContainerSource< TOutputVectorContainer >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VectorContainerSource ()
 
 ~VectorContainerSource () override=default
 
- Protected Member Functions inherited from itk::ImageSamplerBase< TElastix >
void AfterThreadedGenerateData () override
 
void BeforeThreadedGenerateData () override
 
virtual bool CheckInputImageRegions ()
 
void CropInputImageRegion ()
 
void GenerateInputRequestedRegion () override
 
 ImageSamplerBase ()=default
 
virtual bool IsInsideAllMasks (const InputImagePointType &point) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void UpdateAllMasks ()
 
 ~ImageSamplerBase () override=default
 
- Protected Member Functions inherited from itk::ImageToVectorContainerFilter< TInputImage, TOutputVectorContainer >
 ImageToVectorContainerFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageToVectorContainerFilter () override=default
 

Private Attributes

 elxOverrideGetSelfMacro
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >
unsigned long m_RequestedNumberOfSamples
 
SampleGridSpacingType m_SampleGridSpacing
 
- Protected Attributes inherited from itk::ImageSamplerBase< TInputImage >
unsigned long m_NumberOfSamples { 0 }
 
std::vector< ImageSampleContainerPointerm_ThreaderSampleContainer
 
bool m_UseMultiThread { false }
 
- Protected Attributes inherited from itk::ImageSamplerBase< TElastix >
unsigned long m_NumberOfSamples
 
std::vector< ImageSampleContainerPointerm_ThreaderSampleContainer
 
bool m_UseMultiThread
 

Member Typedef Documentation

◆ ConstPointer

template<class TElastix >
using elastix::GridSampler< TElastix >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 61 of file elxGridSampler.h.

◆ GridSpacingType

template<class TElastix >
using elastix::GridSampler< TElastix >::GridSpacingType = typename Superclass1::SampleGridSpacingType

Definition at line 89 of file elxGridSampler.h.

◆ ImageSampleContainerType

template<class TElastix >
using itk::ImageSamplerBase< TInputImage >::ImageSampleContainerType = VectorDataContainer<std::vcl_size_t, ImageSampleType>

Definition at line 71 of file itkImageSamplerBase.h.

◆ ImageSampleType

template<class TElastix >
using itk::ImageSamplerBase< TInputImage >::ImageSampleType = ImageSample<InputImageType>

Other typdefs.

Definition at line 70 of file itkImageSamplerBase.h.

◆ InputImageIndexType

template<class TElastix >
using itk::ImageSamplerBase< TInputImage >::InputImageIndexType = typename InputImageType::IndexType

Definition at line 79 of file itkImageSamplerBase.h.

◆ InputImagePointType

template<class TElastix >
using itk::ImageSamplerBase< TInputImage >::InputImagePointType = typename InputImageType::PointType

Definition at line 81 of file itkImageSamplerBase.h.

◆ ITKBaseType

template<class TElastix >
using elastix::GridSampler< TElastix >::ITKBaseType = typename Superclass2::ITKBaseType

Definition at line 98 of file elxGridSampler.h.

◆ MaskType

template<class TElastix >
using itk::ImageSamplerBase< TInputImage >::MaskType = SpatialObject<Self::InputImageDimension>

Definition at line 73 of file itkImageSamplerBase.h.

◆ Pointer

template<class TElastix >
using elastix::GridSampler< TElastix >::Pointer = itk::SmartPointer<Self>

Definition at line 60 of file elxGridSampler.h.

◆ SampleGridSpacingValueType

template<class TElastix >
using itk::ImageGridSampler< TInputImage >::SampleGridSpacingValueType = typename SampleGridSpacingType::OffsetValueType

Definition at line 85 of file itkImageGridSampler.h.

◆ Self

template<class TElastix >
using elastix::GridSampler< TElastix >::Self = GridSampler

Standard ITK-stuff.

Definition at line 57 of file elxGridSampler.h.

◆ Superclass1

template<class TElastix >
using elastix::GridSampler< TElastix >::Superclass1 = itk::ImageGridSampler<typename elx::ImageSamplerBase<TElastix>::InputImageType>

Definition at line 58 of file elxGridSampler.h.

◆ Superclass2

template<class TElastix >
using elastix::GridSampler< TElastix >::Superclass2 = elx::ImageSamplerBase<TElastix>

Definition at line 59 of file elxGridSampler.h.

Constructor & Destructor Documentation

◆ GridSampler()

template<class TElastix >
elastix::GridSampler< TElastix >::GridSampler ( )
protecteddefault

The constructor.

◆ ~GridSampler()

template<class TElastix >
elastix::GridSampler< TElastix >::~GridSampler ( )
overrideprotecteddefault

The destructor.

Member Function Documentation

◆ BeforeEachResolution()

template<class TElastix >
void elastix::GridSampler< TElastix >::BeforeEachResolution ( )
override

Execute stuff before each resolution:

  • Set the sampling grid size.

◆ elxClassNameMacro()

template<class TElastix >
elastix::GridSampler< TElastix >::elxClassNameMacro ( "Grid"  )

Name of this class. Use this name in the parameter file to select this specific interpolator.
example: (ImageSampler "Grid")

◆ GetClassName()

template<class TElastix >
virtual const char * elastix::GridSampler< TElastix >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<class TElastix >
elastix::GridSampler< TElastix >::ITK_DISALLOW_COPY_AND_MOVE ( GridSampler< TElastix >  )

◆ itkStaticConstMacro()

template<class TElastix >
elastix::GridSampler< TElastix >::itkStaticConstMacro ( InputImageDimension  ,
unsigned int  ,
Superclass1::InputImageDimension   
)

The input image dimension.

◆ New()

template<class TElastix >
static Pointer elastix::GridSampler< TElastix >::New ( )
static

Method for creation through the object factory.

Field Documentation

◆ elxOverrideGetSelfMacro

template<class TElastix >
elastix::GridSampler< TElastix >::elxOverrideGetSelfMacro
private

Definition at line 113 of file elxGridSampler.h.



Generated on 2023-01-13 for elastix by doxygen 1.9.6 elastix logo