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 | Protected Attributes | Private Member Functions
itk::ImageGridSampler< TInputImage > Class Template Reference

#include <itkImageGridSampler.h>

Inheritance diagram for itk::ImageGridSampler< TInputImage >:
Inheritance graph
[legend]
Collaboration diagram for itk::ImageGridSampler< TInputImage >:
Collaboration graph
[legend]

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
Superclass::DataObjectPointer 
DataObjectPointer
typedef
Superclass::ImageSampleContainerType 
ImageSampleContainerType
typedef Superclass::ImageSampleType ImageSampleType
typedef
Superclass::InputImageConstPointer 
InputImageConstPointer
typedef InputImageType::IndexType InputImageIndexType
typedef
Superclass::InputImagePixelType 
InputImagePixelType
typedef
Superclass::InputImagePointer 
InputImagePointer
typedef InputImageType::PointType InputImagePointType
typedef
Superclass::InputImageRegionType 
InputImageRegionType
typedef InputImageType::SizeType InputImageSizeType
typedef Superclass::InputImageType InputImageType
typedef Superclass::MaskType MaskType
typedef
Superclass::OutputVectorContainerPointer 
OutputVectorContainerPointer
typedef
Superclass::OutputVectorContainerType 
OutputVectorContainerType
typedef SmartPointer< SelfPointer
typedef InputImageIndexType SampleGridIndexType
typedef InputImageType::SizeType SampleGridSizeType
typedef InputImageType::OffsetType SampleGridSpacingType
typedef
SampleGridSpacingType::OffsetValueType 
SampleGridSpacingValueType
typedef ImageGridSampler Self
typedef ImageSamplerBase
< TInputImage > 
Superclass

Public Member Functions

virtual const char * GetClassName () const
virtual SampleGridSpacingType GetSampleGridSpacing () const
 itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
virtual bool SelectingNewSamplesOnUpdateSupported (void) const
virtual bool SelectNewSamplesOnUpdate (void)
virtual void SetNumberOfSamples (unsigned long nrofsamples)
void SetSampleGridSpacing (SampleGridSpacingType arg)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual void GenerateData (void)
 ImageGridSampler ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~ImageGridSampler ()

Protected Attributes

unsigned long m_RequestedNumberOfSamples
SampleGridSpacingType m_SampleGridSpacing

Private Member Functions

 ImageGridSampler (const Self &)
void operator= (const Self &)

Detailed Description

template<class TInputImage>
class itk::ImageGridSampler< TInputImage >

Samples image voxels on a regular grid.

This ImageSampler samples voxels that lie on a regular grid. The grid can be specified by an integer downsampling factor for each dimension.

Parameters:
SampleGridSpacing: This parameter controls the spacing of the uniform grid in all dimensions. This should be given in index coordinates.
example: (SampleGridSpacing 4 4 4)
Default is 2 in each dimension.

Definition at line 42 of file itkImageGridSampler.h.


Member Typedef Documentation

template<class TInputImage>
typedef SmartPointer<const Self> itk::ImageGridSampler< TInputImage >::ConstPointer

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 51 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::DataObjectPointer itk::ImageGridSampler< TInputImage >::DataObjectPointer

Typedefs inherited from the superclass.

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 57 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::ImageSampleContainerType itk::ImageGridSampler< TInputImage >::ImageSampleContainerType

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 69 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::ImageSampleType itk::ImageGridSampler< TInputImage >::ImageSampleType

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 68 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::InputImageConstPointer itk::ImageGridSampler< TInputImage >::InputImageConstPointer

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 65 of file itkImageGridSampler.h.

template<class TInputImage>
typedef InputImageType::IndexType itk::ImageGridSampler< TInputImage >::InputImageIndexType

Other typdefs.

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 77 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::InputImagePixelType itk::ImageGridSampler< TInputImage >::InputImagePixelType

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 67 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::InputImagePointer itk::ImageGridSampler< TInputImage >::InputImagePointer

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 64 of file itkImageGridSampler.h.

template<class TInputImage>
typedef InputImageType::PointType itk::ImageGridSampler< TInputImage >::InputImagePointType

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 78 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::InputImageRegionType itk::ImageGridSampler< TInputImage >::InputImageRegionType

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 66 of file itkImageGridSampler.h.

template<class TInputImage>
typedef InputImageType::SizeType itk::ImageGridSampler< TInputImage >::InputImageSizeType

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Definition at line 85 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::InputImageType itk::ImageGridSampler< TInputImage >::InputImageType

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 63 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::MaskType itk::ImageGridSampler< TInputImage >::MaskType

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 70 of file itkImageGridSampler.h.

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 62 of file itkImageGridSampler.h.

template<class TInputImage>
typedef Superclass::OutputVectorContainerType itk::ImageGridSampler< TInputImage >::OutputVectorContainerType

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 61 of file itkImageGridSampler.h.

template<class TInputImage>
typedef SmartPointer<Self> itk::ImageGridSampler< TInputImage >::Pointer

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 50 of file itkImageGridSampler.h.

template<class TInputImage>
typedef InputImageIndexType itk::ImageGridSampler< TInputImage >::SampleGridIndexType

Definition at line 84 of file itkImageGridSampler.h.

template<class TInputImage>
typedef InputImageType::SizeType itk::ImageGridSampler< TInputImage >::SampleGridSizeType

Definition at line 83 of file itkImageGridSampler.h.

template<class TInputImage>
typedef InputImageType::OffsetType itk::ImageGridSampler< TInputImage >::SampleGridSpacingType

Typedefs for support of user defined grid spacing for the spatial samples.

Definition at line 81 of file itkImageGridSampler.h.

template<class TInputImage>
typedef SampleGridSpacingType::OffsetValueType itk::ImageGridSampler< TInputImage >::SampleGridSpacingValueType

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 82 of file itkImageGridSampler.h.

template<class TInputImage>
typedef ImageGridSampler itk::ImageGridSampler< TInputImage >::Self

Standard ITK-stuff.

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

Definition at line 48 of file itkImageGridSampler.h.

template<class TInputImage>
typedef ImageSamplerBase< TInputImage > itk::ImageGridSampler< TInputImage >::Superclass

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Definition at line 49 of file itkImageGridSampler.h.


Constructor & Destructor Documentation

template<class TInputImage>
itk::ImageGridSampler< TInputImage >::ImageGridSampler ( ) [inline, protected]

The constructor.

Definition at line 137 of file itkImageGridSampler.h.

template<class TInputImage>
virtual itk::ImageGridSampler< TInputImage >::~ImageGridSampler ( ) [inline, protected, virtual]

The destructor.

Definition at line 143 of file itkImageGridSampler.h.

template<class TInputImage>
itk::ImageGridSampler< TInputImage >::ImageGridSampler ( const Self ) [private]

The private constructor.


Member Function Documentation

template<class TInputImage>
virtual void itk::ImageGridSampler< TInputImage >::GenerateData ( void  ) [protected, virtual]

Function that does the work.

template<class TInputImage>
virtual const char* itk::ImageGridSampler< TInputImage >::GetClassName ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

template<class TInputImage>
virtual SampleGridSpacingType itk::ImageGridSampler< TInputImage >::GetSampleGridSpacing ( ) const [virtual]
template<class TInputImage>
itk::ImageGridSampler< TInputImage >::itkStaticConstMacro ( InputImageDimension  ,
unsigned  int,
Superclass::InputImageDimension   
)

The input image dimension.

template<class TInputImage>
static Pointer itk::ImageGridSampler< TInputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::GridSampler< TElastix >.

template<class TInputImage>
void itk::ImageGridSampler< TInputImage >::operator= ( const Self ) [private]

The private copy constructor.

template<class TInputImage>
void itk::ImageGridSampler< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected]

PrintSelf.

Reimplemented from itk::ImageSamplerBase< TInputImage >.

template<class TInputImage>
virtual bool itk::ImageGridSampler< TInputImage >::SelectingNewSamplesOnUpdateSupported ( void  ) const [inline, virtual]

Returns whether the sampler supports SelectNewSamplesOnUpdate()

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Definition at line 129 of file itkImageGridSampler.h.

template<class TInputImage>
virtual bool itk::ImageGridSampler< TInputImage >::SelectNewSamplesOnUpdate ( void  ) [inline, virtual]

Selecting new samples makes no sense if nothing changed. The same samples would be selected anyway.

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Definition at line 123 of file itkImageGridSampler.h.

template<class TInputImage>
virtual void itk::ImageGridSampler< TInputImage >::SetNumberOfSamples ( unsigned long  nrofsamples) [virtual]

Define an isotropic SampleGridSpacing such that the desired number of samples is approximately realised. The following formula is used:

spacing = max[ 1, round( (availablevoxels/nrofsamples)^(1/dimension) ) ], with availablevoxels = nr of voxels in input image region.

The InputImageRegion needs to be specified beforehand. A mask is ignored, so the realised number of samples could be significantly lower than expected. However, the sample grid spacing is recomputed in the update phase, when the bounding box of the mask is known. Supplying nrofsamples=0 turns off the (re)computation of the SampleGridSpacing. Once nrofsamples=0 has been given, the last computed SampleGridSpacing is simply considered as a user parameter, which is not modified automatically anymore.

This function overrules any previous calls to SetSampleGridSpacing.

template<class TInputImage>
void itk::ImageGridSampler< TInputImage >::SetSampleGridSpacing ( SampleGridSpacingType  arg) [inline]

Set/Get the sample grid spacing for each dimension (only integer factors) This function overrules previous calls to SetNumberOfSamples. Moreover, it calls SetNumberOfSamples(0) (see below), to make sure that the user-set sample grid spacing is never overruled.

Definition at line 91 of file itkImageGridSampler.h.


Field Documentation

template<class TInputImage>
unsigned long itk::ImageGridSampler< TInputImage >::m_RequestedNumberOfSamples [protected]

The number of samples entered in the SetNumberOfSamples method

Definition at line 155 of file itkImageGridSampler.h.

template<class TInputImage>
SampleGridSpacingType itk::ImageGridSampler< TInputImage >::m_SampleGridSpacing [protected]

An array of integer spacing factors

Definition at line 152 of file itkImageGridSampler.h.



Generated on 24-05-2012 for elastix by doxygen 1.7.6.1 elastix logo