itk::simple::CropImageFilter Class Reference

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

Inheritance diagram for itk::simple::CropImageFilter:

Collaboration diagram for itk::simple::CropImageFilter:

Public Types
typedef NonLabelPixelIDTypeList	PixelIDTypeList
typedef CropImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
	CropImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, const std::vector< unsigned int > &lowerBoundaryCropSize, const std::vector< unsigned int > &upperBoundaryCropSize)
std::vector< unsigned int >	GetLowerBoundaryCropSize () const
std::string	GetName () const
std::vector< unsigned int >	GetUpperBoundaryCropSize () const
Self &	SetLowerBoundaryCropSize (const std::vector< unsigned int > &LowerBoundaryCropSize)
Self &	SetUpperBoundaryCropSize (const std::vector< unsigned int > &UpperBoundaryCropSize)
std::string	ToString () const
virtual	~CropImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...
virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands. More...
virtual	~ProcessObject ()
virtual void	DebugOn ()
virtual void	DebugOff ()
virtual bool	GetDebug () const
virtual void	SetDebug (bool debugFlag)
virtual void	SetNumberOfThreads (unsigned int n)
virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
std::vector< unsigned int >	m_LowerBoundaryCropSize
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
std::vector< unsigned int >	m_UpperBoundaryCropSize

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()
static void	GlobalDefaultDebugOff ()
static void	GlobalDefaultDebugOn ()
static void	SetGlobalDefaultDebug (bool debugFlag)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()
Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void	FixNonZeroIndex (TImageType *img)
Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)
template<class TImageType >
static Image	CastITKToImage (TImageType *img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
static const itk::EventObject &	GetITKEventObject (EventEnum e)
template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)
static std::ostream &	ToStringHelper (std::ostream &os, const char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

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.

See also

itk::simple::Crop for the procedural interface

itk::CropImageFilter for the Doxygen on the original ITK class.

Definition at line 44 of file sitkCropImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::CropImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 97 of file sitkCropImageFilter.h.

typedef NonLabelPixelIDTypeList itk::simple::CropImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 56 of file sitkCropImageFilter.h.

typedef CropImageFilter itk::simple::CropImageFilter::Self

Definition at line 46 of file sitkCropImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::CropImageFilter::~CropImageFilter ( )

virtual

Destructor

itk::simple::CropImageFilter::CropImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::CropImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::CropImageFilter::Execute	(	const Image &	image1,
		const std::vector< unsigned int > &	lowerBoundaryCropSize,
		const std::vector< unsigned int > &	upperBoundaryCropSize
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::CropImageFilter::ExecuteInternal ( const Image &  image1 )

private

std::vector<unsigned int> itk::simple::CropImageFilter::GetLowerBoundaryCropSize ( ) const

inline

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

Definition at line 68 of file sitkCropImageFilter.h.

std::string itk::simple::CropImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 80 of file sitkCropImageFilter.h.

std::vector<unsigned int> itk::simple::CropImageFilter::GetUpperBoundaryCropSize ( ) const

inline

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

Definition at line 78 of file sitkCropImageFilter.h.

Self& itk::simple::CropImageFilter::SetLowerBoundaryCropSize ( const std::vector< unsigned int > &  LowerBoundaryCropSize )

inline

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

Definition at line 63 of file sitkCropImageFilter.h.

Self& itk::simple::CropImageFilter::SetUpperBoundaryCropSize ( const std::vector< unsigned int > &  UpperBoundaryCropSize )

inline

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

Definition at line 73 of file sitkCropImageFilter.h.

std::string itk::simple::CropImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 101 of file sitkCropImageFilter.h.

Member Data Documentation

std::vector<unsigned int> itk::simple::CropImageFilter::m_LowerBoundaryCropSize

private

Definition at line 107 of file sitkCropImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::CropImageFilter::m_MemberFactory

private

Definition at line 103 of file sitkCropImageFilter.h.

std::vector<unsigned int> itk::simple::CropImageFilter::m_UpperBoundaryCropSize

private

Definition at line 109 of file sitkCropImageFilter.h.

---

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

• sitkCropImageFilter.h