itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage > Class Template Reference
[Geometric Transformation Filters]

Reduce the size of an image by an integer factor. More...

#include <itkNonThreadedShrinkImageFilter.h>

Inheritance diagram for itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >:

[legend]Collaboration diagram for itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef NonThreadedShrinkImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TOutputImage	OutputImageType
typedef TInputImage	InputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef TOutputImage::RegionType	OutputImageRegionType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
const unsigned int *	GetShrinkFactors () const
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()
void	SetShrinkFactors (unsigned int factors[])
void	SetShrinkFactors (unsigned int factor)
void	SetShrinkFactor (unsigned int i, unsigned int factor)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	NonThreadedShrinkImageFilter ()
	~NonThreadedShrinkImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData ()

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >

Reduce the size of an image by an integer factor.

NonThreadedShrinkImageFilter reduces the size of an image by an integer factor. The algorithm implemented is a simple subsample. Since this filter produces an image which is a different resolution and with different pixel spacing than its input image, it needs to override several of the methods defined in ProcessObject in order to properly manage the pipeline execution model. In particular, this filter overrides ProcessObject::GenerateInputRequestedRegion() and ProcessObject::GenerateOutputInformation().

Definition at line 41 of file itkNonThreadedShrinkImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage> typedef SmartPointer<const Self> itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 49 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::ConstPointer itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 62 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::Pointer itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 61 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 59 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::Pointer itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 60 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::RegionType itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output image region type. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 65 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::OutputImageType

Typedef to images Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 58 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> typedef SmartPointer<Self> itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 48 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> typedef NonThreadedShrinkImageFilter itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 46 of file itkNonThreadedShrinkImageFilter.h. Referenced by itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::~NonThreadedShrinkImageFilter().

template<class TInputImage, class TOutputImage> typedef ImageToImageFilter<TInputImage,TOutputImage> itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 47 of file itkNonThreadedShrinkImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::NonThreadedShrinkImageFilter (   )  [protected]

template<class TInputImage, class TOutputImage> itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::~NonThreadedShrinkImageFilter (   )  [inline, protected]

Definition at line 104 of file itkNonThreadedShrinkImageFilter.h. References itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::Self.

---

Member Function Documentation

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

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead. See also: ThreadedGenerateData() Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (   )  [virtual]

NonThreadedShrinkImageFilter needs a larger input requested region than the output requested region. As such, NonThreadedShrinkImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model. * See also: ProcessObject::GenerateInputRequestedRegion() Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation (   )  [virtual]

NonThreadedShrinkImageFilter produces an image which is a different resolution and with a different pixel spacing than its input image. As such, NonThreadedShrinkImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below. See also: ProcessObject::GenerateOutputInformaton() Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage> virtual const char* itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> const unsigned int* itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::GetShrinkFactors (   )  const [inline]

Get the shrink factors. Definition at line 82 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TInputImage::ImageDimension  )

ImageDimension enumeration.

template<class TInputImage, class TOutputImage> Pointer itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

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

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 >.

template<class TInputImage, class TOutputImage> void itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactor (  unsigned int  i, unsigned int  factor )  [inline]

Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions. Definition at line 75 of file itkNonThreadedShrinkImageFilter.h.

template<class TInputImage, class TOutputImage> void itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactors (  unsigned int  factor  )

Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions.

template<class TInputImage, class TOutputImage> void itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactors (  unsigned int  factors[]  )

Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions.

---

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

• itkNonThreadedShrinkImageFilter.h

---