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:

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 43 of file sitkCropImageFilter.h.

Public Types
using	PixelIDTypeList = NonLabelPixelIDTypeList

using	Self = CropImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	CropImageFilter ()

Image	Execute (const Image &image1)

Image	Execute (Image &&image1)

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

std::string	GetName () const

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

Self &	SetLowerBoundaryCropSize (std::vector< unsigned int > LowerBoundaryCropSize)

Self &	SetUpperBoundaryCropSize (std::vector< unsigned int > UpperBoundaryCropSize)

std::string	ToString () const

virtual	~CropImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event. More...

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

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

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

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

Private Attributes
bool	m_InPlace {false}

std::vector< unsigned int >	m_LowerBoundaryCropSize {std::vector<unsigned int>(3, 0)}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

std::vector< unsigned int >	m_UpperBoundaryCropSize {std::vector<unsigned int>(3, 0)}

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

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

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) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *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)

Member Typedef Documentation

◆ MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 95 of file sitkCropImageFilter.h.

◆ PixelIDTypeList

using itk::simple::CropImageFilter::PixelIDTypeList = NonLabelPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 55 of file sitkCropImageFilter.h.

◆ Self

using itk::simple::CropImageFilter::Self = CropImageFilter

Definition at line 45 of file sitkCropImageFilter.h.

Constructor & Destructor Documentation

◆ ~CropImageFilter()

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

virtual

Destructor

◆ CropImageFilter()

itk::simple::CropImageFilter::CropImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

Image itk::simple::CropImageFilter::Execute ( Image && image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

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

private

◆ GetLowerBoundaryCropSize()

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

inline

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

Definition at line 66 of file sitkCropImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 79 of file sitkCropImageFilter.h.

◆ GetUpperBoundaryCropSize()

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

inline

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

Definition at line 76 of file sitkCropImageFilter.h.

◆ SetLowerBoundaryCropSize()

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

inline

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

Definition at line 61 of file sitkCropImageFilter.h.

◆ SetUpperBoundaryCropSize()

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

inline

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

Definition at line 71 of file sitkCropImageFilter.h.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 99 of file sitkCropImageFilter.h.

Member Data Documentation

◆ m_InPlace

bool itk::simple::CropImageFilter::m_InPlace {false}

private

Definition at line 111 of file sitkCropImageFilter.h.

◆ m_LowerBoundaryCropSize

std::vector<unsigned int> itk::simple::CropImageFilter::m_LowerBoundaryCropSize {std::vector<unsigned int>(3, 0)}

private

Definition at line 105 of file sitkCropImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::CropImageFilter::m_MemberFactory

private

Definition at line 101 of file sitkCropImageFilter.h.

◆ m_UpperBoundaryCropSize

std::vector<unsigned int> itk::simple::CropImageFilter::m_UpperBoundaryCropSize {std::vector<unsigned int>(3, 0)}

private

Definition at line 108 of file sitkCropImageFilter.h.

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

sitkCropImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~CropImageFilter()

◆ CropImageFilter()

Member Function Documentation

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ ExecuteInternal()

◆ GetLowerBoundaryCropSize()

◆ GetName()

◆ GetUpperBoundaryCropSize()

◆ SetLowerBoundaryCropSize()

◆ SetUpperBoundaryCropSize()

◆ ToString()

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_InPlace

◆ m_LowerBoundaryCropSize

◆ m_MemberFactory

◆ m_UpperBoundaryCropSize