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
itk::ImageFullSampler< TInputImage > Class Template Reference

#include <itkImageFullSampler.h>

Detailed Description

template<class TInputImage>
class itk::ImageFullSampler< TInputImage >

Samples all voxels in the InputImageRegion.

This ImageSampler samples all voxels in the InputImageRegion. If a mask is given: only those voxels within the mask AND the InputImageRegion.

Definition at line 37 of file itkImageFullSampler.h.

+ Inheritance diagram for itk::ImageFullSampler< TInputImage >:

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef Superclass::DataObjectPointer DataObjectPointer
 
typedef Superclass::ImageSampleContainerPointer ImageSampleContainerPointer
 
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 Superclass::InputImageType InputImageType
 
typedef Superclass::MaskType MaskType
 
typedef Superclass::OutputVectorContainerPointer OutputVectorContainerPointer
 
typedef Superclass::OutputVectorContainerType OutputVectorContainerType
 
typedef SmartPointer< Self > Pointer
 
typedef ImageFullSampler Self
 
typedef ImageSamplerBase< TInputImage > Superclass
 
- Public Types inherited from itk::ImageSamplerBase< TInputImage >
typedef SmartPointer< const Self > ConstPointer
 
typedef Superclass::DataObjectPointer DataObjectPointer
 
typedef ImageSampleContainerType::Pointer ImageSampleContainerPointer
 
typedef VectorDataContainer< std::vcl_size_t, 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< Self::InputImageDimension > MaskType
 
typedef std::vector< MaskConstPointer > MaskVectorType
 
typedef Superclass::OutputVectorContainerPointer OutputVectorContainerPointer
 
typedef Superclass::OutputVectorContainerType OutputVectorContainerType
 
typedef SmartPointer< Self > Pointer
 
typedef ImageSamplerBase Self
 
typedef ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > > Superclass
 
- Public Types inherited from itk::ImageToVectorContainerFilter< TInputImage, VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
typedef SmartPointer< const Self > ConstPointer
 
typedef Superclass::DataObjectPointer DataObjectPointer
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef Superclass::OutputVectorContainerPointer OutputVectorContainerPointer
 
typedef Superclass::OutputVectorContainerType OutputVectorContainerType
 
typedef SmartPointer< Self > Pointer
 
typedef ImageToVectorContainerFilter Self
 
typedef VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > > Superclass
 
- Public Types inherited from itk::VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
typedef SmartPointer< const Self > ConstPointer
 
typedef Superclass::DataObjectPointer DataObjectPointer
 
typedef OutputVectorContainerType::Pointer OutputVectorContainerPointer
 
typedef VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > OutputVectorContainerType
 
typedef SmartPointer< Self > Pointer
 
typedef VectorContainerSource Self
 
typedef ProcessObject Superclass
 

Public Member Functions

virtual const char * GetClassName () const
 
 itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
 
bool SelectingNewSamplesOnUpdateSupported (void) const override
 
bool SelectNewSamplesOnUpdate (void) override
 
- Public Member Functions inherited from itk::ImageSamplerBase< TInputImage >
virtual const InputImageRegionType & GetCroppedInputImageRegion ()
 
virtual const InputImageRegionType & GetInputImageRegion (unsigned int pos) const
 
virtual const InputImageRegionType & GetInputImageRegion (void) const
 
virtual const MaskType * GetMask (unsigned int pos) const
 
virtual const MaskType * GetMask (void) const
 
virtual unsigned int GetNumberOfInputImageRegions () const
 
virtual unsigned int GetNumberOfMasks () const
 
virtual unsigned long GetNumberOfSamples () const
 
 itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)
 
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 > > >
void GenerateData (void) override
 
const InputImageType * GetInput (unsigned int idx)
 
const InputImageType * GetInput (void)
 
OutputVectorContainerType * GetOutput (void)
 
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< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
OutputVectorContainerType * GetOutput (unsigned int idx)
 
OutputVectorContainerType * GetOutput (void)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 

Static Public Member Functions

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< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
static Pointer New ()
 

Protected Member Functions

void GenerateData (void) override
 
 ImageFullSampler ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, ThreadIdType threadId) override
 
 ~ImageFullSampler () override
 
- Protected Member Functions inherited from itk::ImageSamplerBase< TInputImage >
void AfterThreadedGenerateData (void) override
 
void BeforeThreadedGenerateData (void) override
 
virtual bool CheckInputImageRegions (void)
 
void CropInputImageRegion (void)
 
void GenerateInputRequestedRegion (void) override
 
 ImageSamplerBase ()
 
virtual bool IsInsideAllMasks (const InputImagePointType &point) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void UpdateAllMasks (void)
 
 ~ImageSamplerBase () override
 
- 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
 
- Protected Member Functions inherited from itk::VectorContainerSource< VectorDataContainer< std::vcl_size_t, ImageSample< TInputImage > > >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VectorContainerSource ()
 
 ~VectorContainerSource () override
 

Private Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from itk::ImageSamplerBase< TInputImage >
unsigned long m_NumberOfSamples
 
std::vector< ImageSampleContainerPointer > m_ThreaderSampleContainer
 
bool m_UseMultiThread
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 46 of file itkImageFullSampler.h.

◆ DataObjectPointer

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

Typedefs inherited from the superclass.

Definition at line 55 of file itkImageFullSampler.h.

◆ ImageSampleContainerPointer

Definition at line 65 of file itkImageFullSampler.h.

◆ ImageSampleContainerType

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

Definition at line 64 of file itkImageFullSampler.h.

◆ ImageSampleType

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

Definition at line 63 of file itkImageFullSampler.h.

◆ InputImageConstPointer

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

Definition at line 60 of file itkImageFullSampler.h.

◆ InputImageIndexType

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

Other typdefs.

Definition at line 73 of file itkImageFullSampler.h.

◆ InputImagePixelType

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

Definition at line 62 of file itkImageFullSampler.h.

◆ InputImagePointer

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

Definition at line 59 of file itkImageFullSampler.h.

◆ InputImagePointType

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

Definition at line 74 of file itkImageFullSampler.h.

◆ InputImageRegionType

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

Definition at line 61 of file itkImageFullSampler.h.

◆ InputImageType

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

Definition at line 58 of file itkImageFullSampler.h.

◆ MaskType

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

Definition at line 66 of file itkImageFullSampler.h.

◆ OutputVectorContainerPointer

Definition at line 57 of file itkImageFullSampler.h.

◆ OutputVectorContainerType

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

Definition at line 56 of file itkImageFullSampler.h.

◆ Pointer

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

Definition at line 45 of file itkImageFullSampler.h.

◆ Self

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

Standard ITK-stuff.

Definition at line 43 of file itkImageFullSampler.h.

◆ Superclass

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

Definition at line 44 of file itkImageFullSampler.h.

Constructor & Destructor Documentation

◆ ImageFullSampler() [1/2]

template<class TInputImage >
itk::ImageFullSampler< TInputImage >::ImageFullSampler ( )
inlineprotected

The constructor.

Definition at line 95 of file itkImageFullSampler.h.

◆ ~ImageFullSampler()

template<class TInputImage >
itk::ImageFullSampler< TInputImage >::~ImageFullSampler ( )
inlineoverrideprotected

The destructor.

Definition at line 97 of file itkImageFullSampler.h.

◆ ImageFullSampler() [2/2]

template<class TInputImage >
itk::ImageFullSampler< TInputImage >::ImageFullSampler ( const Self &  )
private

The private constructor.

Member Function Documentation

◆ GenerateData()

template<class TInputImage >
void itk::ImageFullSampler< TInputImage >::GenerateData ( void  )
overrideprotected

Function that does the work.

◆ GetClassName()

template<class TInputImage >
virtual const char* itk::ImageFullSampler< TInputImage >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Reimplemented in elastix::FullSampler< TElastix >.

◆ itkStaticConstMacro()

template<class TInputImage >
itk::ImageFullSampler< TInputImage >::itkStaticConstMacro ( InputImageDimension  ,
unsigned int  ,
Superclass::InputImageDimension   
)

The input image dimension.

◆ New()

template<class TInputImage >
static Pointer itk::ImageFullSampler< TInputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage >
void itk::ImageFullSampler< TInputImage >::operator= ( const Self &  )
private

The private copy constructor.

◆ PrintSelf()

template<class TInputImage >
void itk::ImageFullSampler< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotected

PrintSelf.

◆ SelectingNewSamplesOnUpdateSupported()

template<class TInputImage >
bool itk::ImageFullSampler< TInputImage >::SelectingNewSamplesOnUpdateSupported ( void  ) const
inlineoverridevirtual

Returns whether the sampler supports SelectNewSamplesOnUpdate().

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Definition at line 86 of file itkImageFullSampler.h.

◆ SelectNewSamplesOnUpdate()

template<class TInputImage >
bool itk::ImageFullSampler< TInputImage >::SelectNewSamplesOnUpdate ( void  )
inlineoverridevirtual

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

Reimplemented from itk::ImageSamplerBase< TInputImage >.

Definition at line 79 of file itkImageFullSampler.h.

◆ ThreadedGenerateData()

template<class TInputImage >
void itk::ImageFullSampler< TInputImage >::ThreadedGenerateData ( const InputImageRegionType &  inputRegionForThread,
ThreadIdType  threadId 
)
overrideprotected

Multi-threaded function that does the work.



Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.9.1 elastix logo