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::CropImageFilter< TInputImage, TOutputImage > Class Template Reference
Geometric Transformation Filters | Module ITKImageGrid

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 >:
Collaboration diagram for itk::CropImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef
Superclass::InputImageIndexType 		InputImageIndexType
typedef
Superclass::InputImagePixelType 		InputImagePixelType
typedef
Superclass::InputImageRegionType 		InputImageRegionType
typedef
Superclass::InputImageSizeType 		InputImageSizeType
typedef
Superclass::OutputImageIndexType 		OutputImageIndexType
typedef
Superclass::OutputImagePixelType 		OutputImagePixelType
typedef
Superclass::OutputImageRegionType 		OutputImageRegionType
typedef
Superclass::OutputImageSizeType 		OutputImageSizeType
typedef SmartPointer< Self > Pointer
typedef CropImageFilter Self
typedef InputImageSizeType SizeType
typedef ExtractImageFilter
< TInputImage, TOutputImage > 		Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
void SetBoundaryCropSize (const SizeType &s)
 typedef (Concept::Convertible< InputImagePixelType, OutputImagePixelType >) InputConvertibleToOutputCheck
 typedef (Concept::SameDimension< InputImageDimension, OutputImageDimension >) SameDimensionCheck
virtual void SetUpperBoundaryCropSize (SizeType _arg)
virtual SizeType GetUpperBoundaryCropSize () const
virtual void SetLowerBoundaryCropSize (SizeType _arg)
virtual SizeType GetLowerBoundaryCropSize () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = Superclass::InputImageDimension
static const unsigned int OutputImageDimension = Superclass::OutputImageDimension

Protected Member Functions

void GenerateOutputInformation ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~CropImageFilter ()
 CropImageFilter ()

Private Member Functions

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

Private Attributes

SizeType m_LowerBoundaryCropSize
SizeType m_UpperBoundaryCropSize

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.

Wiki Examples:

Definition at line 43 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 51 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 69 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 65 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 61 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 71 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 68 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 64 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 57 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 70 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 50 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 48 of file itkCropImageFilter.h.

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

Definition at line 72 of file itkCropImageFilter.h.

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

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

Definition at line 49 of file itkCropImageFilter.h.

Constructor & Destructor Documentation

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

End concept checking

Definition at line 104 of file itkCropImageFilter.h.

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

Definition at line 112 of file itkCropImageFilter.h.

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

Member Function Documentation

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

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 ( ) const [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 ( ) const [virtual]

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

template<class TInputImage , class TOutputImage >
static 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 >::operator= ( const Self &  ) [private]

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]

End concept checking

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

template<class TInputImage , class TOutputImage >
void itk::CropImageFilter< TInputImage, TOutputImage >::SetBoundaryCropSize ( const SizeType &  s) [inline]

Definition at line 88 of file itkCropImageFilter.h.

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.

template<class TInputImage , class TOutputImage >
itk::CropImageFilter< TInputImage, TOutputImage >::typedef ( Concept::SameDimension< InputImageDimension, OutputImageDimension >  )

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

template<class TInputImage , class TOutputImage >
itk::CropImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< InputImagePixelType, OutputImagePixelType >  )

Begin concept checking This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > )

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

Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::CropImageFilter< TInputImage, TOutputImage >::InputImageDimension = Superclass::InputImageDimension [static]

ImageDimension constants

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

Definition at line 76 of file itkCropImageFilter.h.

template<class TInputImage , class TOutputImage >
SizeType itk::CropImageFilter< TInputImage, TOutputImage >::m_LowerBoundaryCropSize [private]

Definition at line 122 of file itkCropImageFilter.h.

template<class TInputImage , class TOutputImage >
SizeType itk::CropImageFilter< TInputImage, TOutputImage >::m_UpperBoundaryCropSize [private]

Definition at line 121 of file itkCropImageFilter.h.

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

ImageDimension constants

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

Definition at line 78 of file itkCropImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Sun Dec 18 2011 23:48:18 for ITK by doxygen 1.7.4