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

#include <itkImageSamplerBase.h>

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

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
Superclass::DataObjectPointer 
DataObjectPointer
typedef VectorDataContainer
< unsigned long,
ImageSampleType
ImageSampleContainerType
typedef ImageSample
< InputImageType
ImageSampleType
typedef ImageSampleType::RealType ImageSampleValueType
typedef
Superclass::InputImageConstPointer 
InputImageConstPointer
typedef InputImageType::IndexType InputImageIndexType
typedef
Superclass::InputImagePixelType 
InputImagePixelType
typedef
Superclass::InputImagePointer 
InputImagePointer
typedef InputImageType::PointType InputImagePointType
typedef
InputImagePointType::ValueType 
InputImagePointValueType
typedef
Superclass::InputImageRegionType 
InputImageRegionType
typedef std::vector
< InputImageRegionType
InputImageRegionVectorType
typedef InputImageType::SizeType InputImageSizeType
typedef Superclass::InputImageType InputImageType
typedef MaskType::ConstPointer MaskConstPointer
typedef MaskType::Pointer MaskPointer
typedef SpatialObject
< itkGetStaticConstMacro(InputImageDimension) > 
MaskType
typedef std::vector
< MaskConstPointer
MaskVectorType
typedef
Superclass::OutputVectorContainerPointer 
OutputVectorContainerPointer
typedef
Superclass::OutputVectorContainerType 
OutputVectorContainerType
typedef SmartPointer< SelfPointer
typedef ImageSamplerBase Self
typedef
ImageToVectorContainerFilter
< TInputImage,
VectorDataContainer< unsigned
long, ImageSample< TInputImage > > > 
Superclass

Public Member Functions

virtual const char * GetClassName () const
virtual const
InputImageRegionType
GetCroppedInputImageRegion ()
virtual const
InputImageRegionType
GetInputImageRegion (unsigned int pos) const
virtual const
InputImageRegionType
GetInputImageRegion (void) const
virtual const MaskTypeGetMask (unsigned int pos) const
virtual const MaskTypeGetMask (void) const
virtual unsigned int GetNumberOfInputImageRegions () const
virtual unsigned int GetNumberOfMasks () const
 itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)
virtual bool SelectingNewSamplesOnUpdateSupported (void) const
virtual bool SelectNewSamplesOnUpdate (void)
virtual void SetInputImageRegion (const InputImageRegionType _arg, unsigned int pos)
virtual void SetInputImageRegion (const InputImageRegionType _arg)
virtual void SetMask (const MaskType *_arg, unsigned int pos)
virtual void SetMask (const MaskType *_arg)
virtual void SetNumberOfInputImageRegions (const unsigned int _arg)
virtual void SetNumberOfMasks (const unsigned int _arg)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual bool CheckInputImageRegions (void)
void CropInputImageRegion (void)
virtual void GenerateInputRequestedRegion (void)
 ImageSamplerBase ()
virtual bool IsInsideAllMasks (const InputImagePointType &point) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void UpdateAllMasks (void)
virtual ~ImageSamplerBase ()

Private Member Functions

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

Private Attributes

InputImageRegionType m_CroppedInputImageRegion
InputImageRegionType m_DummyInputImageRegion
InputImageRegionType m_InputImageRegion
InputImageRegionVectorType m_InputImageRegionVector
MaskConstPointer m_Mask
MaskVectorType m_MaskVector
unsigned int m_NumberOfInputImageRegions
unsigned int m_NumberOfMasks

Detailed Description

template<class TInputImage>
class itk::ImageSamplerBase< TInputImage >

This class is a base class for any image sampler.

Parameters:
ImageSampler: The way samples are taken from the fixed image in order to compute the metric value and its derivative in each iteration. Can be given for each resolution. Select one of {Random, Full, Grid, RandomCoordinate}.
example: (ImageSampler "Random")
The default is Random.

Definition at line 41 of file itkImageSamplerBase.h.


Member Typedef Documentation

template<class TInputImage>
typedef SmartPointer<const Self> itk::ImageSamplerBase< TInputImage >::ConstPointer
template<class TInputImage>
typedef Superclass::DataObjectPointer itk::ImageSamplerBase< TInputImage >::DataObjectPointer
template<class TInputImage>
typedef VectorDataContainer< unsigned long, ImageSampleType > itk::ImageSamplerBase< TInputImage >::ImageSampleContainerType
template<class TInputImage>
typedef ImageSample< InputImageType > itk::ImageSamplerBase< TInputImage >::ImageSampleType
template<class TInputImage>
typedef ImageSampleType::RealType itk::ImageSamplerBase< TInputImage >::ImageSampleValueType
template<class TInputImage>
typedef Superclass::InputImageConstPointer itk::ImageSamplerBase< TInputImage >::InputImageConstPointer
template<class TInputImage>
typedef InputImageType::IndexType itk::ImageSamplerBase< TInputImage >::InputImageIndexType
template<class TInputImage>
typedef Superclass::InputImagePixelType itk::ImageSamplerBase< TInputImage >::InputImagePixelType
template<class TInputImage>
typedef Superclass::InputImagePointer itk::ImageSamplerBase< TInputImage >::InputImagePointer
template<class TInputImage>
typedef InputImageType::PointType itk::ImageSamplerBase< TInputImage >::InputImagePointType
template<class TInputImage>
typedef InputImagePointType::ValueType itk::ImageSamplerBase< TInputImage >::InputImagePointValueType
template<class TInputImage>
typedef Superclass::InputImageRegionType itk::ImageSamplerBase< TInputImage >::InputImageRegionType
template<class TInputImage>
typedef std::vector< InputImageRegionType > itk::ImageSamplerBase< TInputImage >::InputImageRegionVectorType

Definition at line 91 of file itkImageSamplerBase.h.

template<class TInputImage>
typedef InputImageType::SizeType itk::ImageSamplerBase< TInputImage >::InputImageSizeType
template<class TInputImage>
typedef Superclass::InputImageType itk::ImageSamplerBase< TInputImage >::InputImageType
template<class TInputImage>
typedef MaskType::ConstPointer itk::ImageSamplerBase< TInputImage >::MaskConstPointer

Definition at line 89 of file itkImageSamplerBase.h.

template<class TInputImage>
typedef MaskType::Pointer itk::ImageSamplerBase< TInputImage >::MaskPointer

Definition at line 88 of file itkImageSamplerBase.h.

template<class TInputImage>
typedef SpatialObject< itkGetStaticConstMacro( InputImageDimension ) > itk::ImageSamplerBase< TInputImage >::MaskType
template<class TInputImage>
typedef std::vector< MaskConstPointer > itk::ImageSamplerBase< TInputImage >::MaskVectorType

Definition at line 90 of file itkImageSamplerBase.h.

template<class TInputImage>
typedef Superclass::OutputVectorContainerType itk::ImageSamplerBase< TInputImage >::OutputVectorContainerType
template<class TInputImage>
typedef SmartPointer<Self> itk::ImageSamplerBase< TInputImage >::Pointer
template<class TInputImage>
typedef ImageSamplerBase itk::ImageSamplerBase< TInputImage >::Self
template<class TInputImage>
typedef ImageToVectorContainerFilter< TInputImage, VectorDataContainer< unsigned long, ImageSample< TInputImage > > > itk::ImageSamplerBase< TInputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage>
itk::ImageSamplerBase< TInputImage >::ImageSamplerBase ( ) [protected]

The constructor.

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

The destructor.

Definition at line 168 of file itkImageSamplerBase.h.

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

The private constructor.


Member Function Documentation

template<class TInputImage>
virtual bool itk::ImageSamplerBase< TInputImage >::CheckInputImageRegions ( void  ) [protected, virtual]

Checks if the InputImageRegions are a subregion of the LargestPossibleRegions.

template<class TInputImage>
void itk::ImageSamplerBase< TInputImage >::CropInputImageRegion ( void  ) [protected]

Compute the intersection of the InputImageRegion and the bounding box of the mask.

template<class TInputImage>
virtual void itk::ImageSamplerBase< TInputImage >::GenerateInputRequestedRegion ( void  ) [protected, virtual]
template<class TInputImage>
virtual const char* itk::ImageSamplerBase< TInputImage >::GetClassName ( ) const [virtual]
template<class TInputImage>
virtual const InputImageRegionType& itk::ImageSamplerBase< TInputImage >::GetCroppedInputImageRegion ( ) [virtual]

Get a handle to the cropped InputImageregion.

template<class TInputImage>
virtual const InputImageRegionType& itk::ImageSamplerBase< TInputImage >::GetInputImageRegion ( unsigned int  pos) const [virtual]

Get the input image regions.

template<class TInputImage>
virtual const InputImageRegionType& itk::ImageSamplerBase< TInputImage >::GetInputImageRegion ( void  ) const [inline, virtual]

Get the first input image region.

Definition at line 135 of file itkImageSamplerBase.h.

template<class TInputImage>
virtual const MaskType* itk::ImageSamplerBase< TInputImage >::GetMask ( unsigned int  pos) const [virtual]

Get the masks.

template<class TInputImage>
virtual const MaskType* itk::ImageSamplerBase< TInputImage >::GetMask ( void  ) const [inline, virtual]

Get the first mask.

Definition at line 109 of file itkImageSamplerBase.h.

template<class TInputImage>
virtual unsigned int itk::ImageSamplerBase< TInputImage >::GetNumberOfInputImageRegions ( ) const [virtual]

Get the number of input image regions.

template<class TInputImage>
virtual unsigned int itk::ImageSamplerBase< TInputImage >::GetNumberOfMasks ( ) const [virtual]

Get the number of masks.

template<class TInputImage>
virtual bool itk::ImageSamplerBase< TInputImage >::IsInsideAllMasks ( const InputImagePointType point) const [protected, virtual]

IsInsideAllMasks.

template<class TInputImage>
itk::ImageSamplerBase< TInputImage >::itkStaticConstMacro ( InputImageDimension  ,
unsigned  int,
InputImageType::ImageDimension   
)

The input image dimension.

template<class TInputImage>
static Pointer itk::ImageSamplerBase< TInputImage >::New ( ) [static]
template<class TInputImage>
void itk::ImageSamplerBase< TInputImage >::operator= ( const Self ) [private]

The private copy constructor.

template<class TInputImage>
void itk::ImageSamplerBase< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected]
template<class TInputImage>
virtual bool itk::ImageSamplerBase< TInputImage >::SelectingNewSamplesOnUpdateSupported ( void  ) const [inline, virtual]
template<class TInputImage>
virtual bool itk::ImageSamplerBase< TInputImage >::SelectNewSamplesOnUpdate ( void  ) [virtual]

******************** Other ******************** SelectNewSamplesOnUpdate. When this function is called, the sampler will generate a new sample set after calling Update(). The return bool is false when this feature is not supported by the sampler.

Reimplemented in itk::ImageGridSampler< TInputImage >, itk::ImageGridSampler< elx::ImageSamplerBase< TElastix >::InputImageType >, itk::ImageFullSampler< TInputImage >, and itk::ImageFullSampler< elx::ImageSamplerBase< TElastix >::InputImageType >.

template<class TInputImage>
virtual void itk::ImageSamplerBase< TInputImage >::SetInputImageRegion ( const InputImageRegionType  _arg,
unsigned int  pos 
) [virtual]

******************** Regions ******************** Set the region over which the samples will be taken.

template<class TInputImage>
virtual void itk::ImageSamplerBase< TInputImage >::SetInputImageRegion ( const InputImageRegionType  _arg) [inline, virtual]

Set the region over which the samples will be taken.

Definition at line 126 of file itkImageSamplerBase.h.

template<class TInputImage>
virtual void itk::ImageSamplerBase< TInputImage >::SetMask ( const MaskType _arg,
unsigned int  pos 
) [virtual]

******************** Masks ******************** Set the masks.

template<class TInputImage>
virtual void itk::ImageSamplerBase< TInputImage >::SetMask ( const MaskType _arg) [inline, virtual]

Set the first mask. NB: the first mask is used to compute a bounding box in which samples are considered.

Definition at line 100 of file itkImageSamplerBase.h.

template<class TInputImage>
virtual void itk::ImageSamplerBase< TInputImage >::SetNumberOfInputImageRegions ( const unsigned int  _arg) [virtual]

Set the number of input image regions.

template<class TInputImage>
virtual void itk::ImageSamplerBase< TInputImage >::SetNumberOfMasks ( const unsigned int  _arg) [virtual]

Set the number of masks.

template<class TInputImage>
virtual void itk::ImageSamplerBase< TInputImage >::UpdateAllMasks ( void  ) [protected, virtual]

UpdateAllMasks.


Field Documentation

template<class TInputImage>
InputImageRegionType itk::ImageSamplerBase< TInputImage >::m_CroppedInputImageRegion [private]

Definition at line 205 of file itkImageSamplerBase.h.

template<class TInputImage>
InputImageRegionType itk::ImageSamplerBase< TInputImage >::m_DummyInputImageRegion [private]

Definition at line 206 of file itkImageSamplerBase.h.

template<class TInputImage>
InputImageRegionType itk::ImageSamplerBase< TInputImage >::m_InputImageRegion [private]

Definition at line 201 of file itkImageSamplerBase.h.

template<class TInputImage>
InputImageRegionVectorType itk::ImageSamplerBase< TInputImage >::m_InputImageRegionVector [private]

Definition at line 202 of file itkImageSamplerBase.h.

template<class TInputImage>
MaskConstPointer itk::ImageSamplerBase< TInputImage >::m_Mask [private]

Member variables.

Definition at line 198 of file itkImageSamplerBase.h.

template<class TInputImage>
MaskVectorType itk::ImageSamplerBase< TInputImage >::m_MaskVector [private]

Definition at line 199 of file itkImageSamplerBase.h.

template<class TInputImage>
unsigned int itk::ImageSamplerBase< TInputImage >::m_NumberOfInputImageRegions [private]

Definition at line 203 of file itkImageSamplerBase.h.

template<class TInputImage>
unsigned int itk::ImageSamplerBase< TInputImage >::m_NumberOfMasks [private]

Definition at line 200 of file itkImageSamplerBase.h.



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