Extract a region of interest from the input image. More...

#include <sitkRegionOfInterestImageFilter.h>

Inheritance diagram for itk::simple::RegionOfInterestImageFilter:

Collaboration diagram for itk::simple::RegionOfInterestImageFilter:

Public Types
typedef NonLabelPixelIDTypeList	PixelIDTypeList

typedef RegionOfInterestImageFilter	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
Image	Execute (const Image &image1)

Image	Execute (const Image &image1, const std::vector< unsigned int > &size, const std::vector< int > &index)

std::vector< int >	GetIndex () const

std::string	GetName () const

std::vector< unsigned int >	GetSize () const

	RegionOfInterestImageFilter ()

Self &	SetIndex (const std::vector< int > &Index)
	Set the inclusive starting index of the region extracted. More...

void	SetRegionOfInterest (const std::vector< unsigned int > &Region)

Self &	SetSize (const std::vector< unsigned int > &Size)
	Size in pixels of the region extracted. More...

std::string	ToString () const

virtual	~RegionOfInterestImageFilter ()

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< int >	m_Index

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

std::vector< unsigned int >	m_Size

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

Extract a region of interest from the input image.

This filter produces an output image of the same dimension as the input image. The user specifies the region of the input image that will be contained in the output image. The origin coordinates of the output images will be computed in such a way that if mapped to physical space, the output image will overlay the input image with perfect registration. In other words, a registration process between the output image and the input image will return an identity transform.

If you are interested in changing the dimension of the image, you may want to consider the ExtractImageFilter . For example for extracting a 2D image from a slice of a 3D image.

The region to extract is set using the method SetRegionOfInterest.

See also: ExtractImageFilter; itk::simple::RegionOfInterest for the procedural interface; itk::RegionOfInterestImageFilter for the Doxygen on the original ITK class.

Definition at line 48 of file sitkRegionOfInterestImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 103 of file sitkRegionOfInterestImageFilter.h.

typedef NonLabelPixelIDTypeList itk::simple::RegionOfInterestImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 60 of file sitkRegionOfInterestImageFilter.h.

typedef RegionOfInterestImageFilter itk::simple::RegionOfInterestImageFilter::Self

Definition at line 50 of file sitkRegionOfInterestImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::RegionOfInterestImageFilter::~RegionOfInterestImageFilter ( )

virtual

Destructor

itk::simple::RegionOfInterestImageFilter::RegionOfInterestImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::RegionOfInterestImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

Image itk::simple::RegionOfInterestImageFilter::Execute	(	const Image &	image1,
		const std::vector< unsigned int > &	size,
		const std::vector< int > &	index
	)