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

Decrease the image size by cropping the image by an itk::Size at both the upper and lower bounds of the largest possible region. More...

#include <itkCropImageFilter.h>

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

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

[legend]List of all members.

Public Types
typedef CropImageFilter	Self
typedef ExtractImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::InputImageRegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::InputImagePixelType	InputImagePixelType
typedef Superclass::OutputImageIndexType	OutputImageIndexType
typedef Superclass::InputImageIndexType	InputImageIndexType
typedef Superclass::OutputImageSizeType	OutputImageSizeType
typedef Superclass::InputImageSizeType	InputImageSizeType
typedef InputImageSizeType	SizeType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (InputImageDimension, unsigned int, Superclass::InputImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, Superclass::OutputImageDimension)
virtual void	SetUpperBoundaryCropSize (SizeType _arg)
virtual SizeType	GetUpperBoundaryCropSize ()
virtual void	SetLowerBoundaryCropSize (SizeType _arg)
virtual SizeType	GetLowerBoundaryCropSize ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	CropImageFilter ()
	~CropImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateOutputInformation ()

---

Detailed Description

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

Decrease the image size by cropping the image by an itk::Size at both the upper and lower bounds of the largest possible region.

CropImageFilter changes the image boundary of an image by removing pixels outside the target region. The target region is not specified in advance, but calculated in BeforeThreadedGenerateData().

This filter uses ExtractImageFilter to perform the cropping.

Definition at line 38 of file itkCropImageFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 46 of file itkCropImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImageIndexType itk::CropImageFilter< TInputImage, TOutputImage >::InputImageIndexType

Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 64 of file itkCropImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImagePixelType itk::CropImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 60 of file itkCropImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImageRegionType itk::CropImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 56 of file itkCropImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::InputImageSizeType itk::CropImageFilter< TInputImage, TOutputImage >::InputImageSizeType

Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 66 of file itkCropImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImageIndexType itk::CropImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types. Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 63 of file itkCropImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImagePixelType itk::CropImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel. Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 59 of file itkCropImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImageRegionType itk::CropImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output and input image region types. Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 55 of file itkCropImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImageSizeType itk::CropImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 65 of file itkCropImageFilter.h.

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

Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 45 of file itkCropImageFilter.h.

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

Standard class typedefs. Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 43 of file itkCropImageFilter.h. Referenced by itk::CropImageFilter< TInputImage, TOutputImage >::~CropImageFilter().

template<class TInputImage, class TOutputImage> typedef InputImageSizeType itk::CropImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 67 of file itkCropImageFilter.h. Referenced by itk::CropImageFilter< TInputImage, TOutputImage >::~CropImageFilter().

template<class TInputImage, class TOutputImage> typedef ExtractImageFilter<TInputImage,TOutputImage> itk::CropImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >. Definition at line 44 of file itkCropImageFilter.h.

---

Constructor & Destructor Documentation

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

Definition at line 85 of file itkCropImageFilter.h.

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

Definition at line 90 of file itkCropImageFilter.h. References itk::CropImageFilter< TInputImage, TOutputImage >::Self, and itk::CropImageFilter< TInputImage, TOutputImage >::SizeType.

---

Member Function Documentation

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

ExtractImageFilter can produce an image which is a different resolution than its input image. As such, ExtractImageFilter 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::ExtractImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual SizeType itk::CropImageFilter< TInputImage, TOutputImage >::GetLowerBoundaryCropSize (   )  [virtual]

Set/Get the cropping sizes for the upper and lower boundaries.

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

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

template<class TInputImage, class TOutputImage> virtual SizeType itk::CropImageFilter< TInputImage, TOutputImage >::GetUpperBoundaryCropSize (   )  [virtual]

Set/Get the cropping sizes for the upper and lower boundaries.

template<class TInputImage, class TOutputImage> itk::CropImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  OutputImageDimension  , unsigned  int, Superclass::OutputImageDimension  )

ImageDimension constants

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

ImageDimension constants

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

Method for creation through the object factory. Reimplemented from itk::ExtractImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> void itk::CropImageFilter< 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::ExtractImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::CropImageFilter< TInputImage, TOutputImage >::SetLowerBoundaryCropSize (  SizeType  _arg  )  [virtual]

Set/Get the cropping sizes for the upper and lower boundaries.

template<class TInputImage, class TOutputImage> virtual void itk::CropImageFilter< TInputImage, TOutputImage >::SetUpperBoundaryCropSize (  SizeType  _arg  )  [virtual]

Set/Get the cropping sizes for the upper and lower boundaries.

---

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

• itkCropImageFilter.h

---