ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::ShrinkImageFilter< TInputImage, TOutputImage > Class Template Reference

Reduce the size of an image by an integer factor in each dimension. More...

#include <itkShrinkImageFilter.h>

Inheritance diagram for itk::ShrinkImageFilter< TInputImage, TOutputImage >:
Collaboration diagram for itk::ShrinkImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::Pointer InputImagePointer
typedef TInputImage InputImageType
typedef TInputImage::IndexType InputIndexType
typedef OutputImageType::Pointer OutputImagePointer
typedef TOutputImage::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef TOutputImage::IndexType OutputIndexType
typedef TOutputImage::OffsetType OutputOffsetType
typedef SmartPointer< SelfPointer
typedef ShrinkImageFilter Self
typedef FixedArray< unsigned
int, ImageDimension
ShrinkFactorsType
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()
virtual const char * GetNameOfClass () const
virtual const ShrinkFactorsTypeGetShrinkFactors ()
 typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck
 typedef (Concept::SameDimension< ImageDimension, OutputImageDimension >) SameDimensionCheck
virtual void SetShrinkFactors (ShrinkFactorsType _arg)
void SetShrinkFactors (unsigned int factor)
void SetShrinkFactor (unsigned int i, unsigned int factor)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 ShrinkImageFilter ()
 ~ShrinkImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const

Private Member Functions

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

Private Attributes

ShrinkFactorsType m_ShrinkFactors

Detailed Description

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

Reduce the size of an image by an integer factor in each dimension.

ShrinkImageFilter reduces the size of an image by an integer factor in each dimension. The algorithm implemented is a simple subsample. The output image size in each dimension is given by:

outputSize[j] = max( vcl_floor(inputSize[j]/shrinkFactor[j]), 1 );

NOTE: The physical centers of the input and output will be the same. Because of this, the Origin of the output may not be the same as the Origin of the input. Since this filter produces an image which is a different resolution, origin 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().

This filter is implemented as a multithreaded filter. It provides a ThreadedGenerateData() method for its implementation.

Wiki Examples:

Definition at line 67 of file itkShrinkImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::ShrinkImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::ConstPointer itk::ShrinkImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 88 of file itkShrinkImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 87 of file itkShrinkImageFilter.h.

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

Some convenient typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 85 of file itkShrinkImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage::IndexType itk::ShrinkImageFilter< TInputImage, TOutputImage >::InputIndexType

Definition at line 91 of file itkShrinkImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 86 of file itkShrinkImageFilter.h.

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

Typedef to describe the output image region type.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 95 of file itkShrinkImageFilter.h.

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

Typedef to images

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 81 of file itkShrinkImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::IndexType itk::ShrinkImageFilter< TInputImage, TOutputImage >::OutputIndexType

Definition at line 90 of file itkShrinkImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::OffsetType itk::ShrinkImageFilter< TInputImage, TOutputImage >::OutputOffsetType

Definition at line 92 of file itkShrinkImageFilter.h.

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

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >.

Definition at line 72 of file itkShrinkImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef FixedArray< unsigned int, ImageDimension > itk::ShrinkImageFilter< TInputImage, TOutputImage >::ShrinkFactorsType

Definition at line 104 of file itkShrinkImageFilter.h.

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

Constructor & Destructor Documentation

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

End concept checking

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

End concept checking

Definition at line 146 of file itkShrinkImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::ShrinkImageFilter< TInputImage, TOutputImage >::ShrinkImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::ShrinkImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >.

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

ShrinkImageFilter needs a larger input requested region than the output requested region. As such, ShrinkImageFilter 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::ShrinkImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( ) [virtual]

ShrinkImageFilter produces an image which is a different resolution and with a different pixel spacing than its input image. As such, ShrinkImageFilter 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::ShrinkImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual const ShrinkFactorsType& itk::ShrinkImageFilter< TInputImage, TOutputImage >::GetShrinkFactors ( ) [virtual]

Get the shrink factors.

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

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >.

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

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >.

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

End concept checking

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::ShrinkImageFilter< 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 110 of file itkShrinkImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual void itk::ShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactors ( ShrinkFactorsType  _arg) [virtual]

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::ShrinkImageFilter< 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::ShrinkImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
) [protected, virtual]

ShrinkImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >
itk::ShrinkImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >  )

Begin concept checking This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > )

template<class TInputImage , class TOutputImage >
itk::ShrinkImageFilter< TInputImage, TOutputImage >::typedef ( Concept::SameDimension< ImageDimension, OutputImageDimension )

This class requires SameDimensionCheck in the form of ( Concept::SameDimension< ImageDimension, OutputImageDimension > )


Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::ShrinkImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static]

ImageDimension enumeration.

Definition at line 99 of file itkShrinkImageFilter.h.

template<class TInputImage , class TOutputImage >
ShrinkFactorsType itk::ShrinkImageFilter< TInputImage, TOutputImage >::m_ShrinkFactors [private]

Definition at line 167 of file itkShrinkImageFilter.h.

template<class TInputImage , class TOutputImage >
const unsigned int itk::ShrinkImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension enumeration.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 101 of file itkShrinkImageFilter.h.


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