#include <itkCropImageFilter.h>

Detailed Description

template<typename TInputImage, typename 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.

ITK Sphinx Examples:

All ITK Sphinx Examples

Crop Image By Specifying Region

Definition at line 44 of file itkCropImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	InputImageIndexType

using	InputImagePixelType

using	InputImageRegionType

using	InputImageSizeType

using	OutputImageIndexType

using	OutputImagePixelType

using	OutputImageRegionType

using	OutputImageSizeType

using	Pointer = SmartPointer<Self>

using	Self = CropImageFilter

using	SizeType = InputImageSizeType

using	Superclass = ExtractImageFilter<TInputImage, TOutputImage>

Public Types inherited from itk::ExtractImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer<const Self>

using	DirectionCollapseStrategyEnum = ExtractImageFilterEnums::DirectionCollapseStrategy

using	ExtractImageFilterRegionCopierType

using	InputImageIndexType = typename TInputImage::IndexType

using	InputImagePixelType = typename TInputImage::PixelType

using	InputImageRegionType = typename TInputImage::RegionType

using	InputImageSizeType = typename TInputImage::SizeType

using	InputImageType = TInputImage

using	OutputImageIndexType = typename TOutputImage::IndexType

using	OutputImagePixelType = typename TOutputImage::PixelType

using	OutputImageRegionType = typename TOutputImage::RegionType

using	OutputImageSizeType = typename TOutputImage::SizeType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer<Self>

using	Self = ExtractImageFilter

using	Superclass = InPlaceImageFilter<TInputImage, TOutputImage>

Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
using	ConstPointer

using	ConstPointer

using	InputImageConstPointer

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePixelType

using	InputImagePointer

using	InputImagePointer

using	InputImageRegionType

using	InputImageRegionType

using	InputImageType

using	InputImageType

typedef typename OutputImageType::PixelType	OutputImagePixelType

using	OutputImagePixelType

typedef typename OutputImageType::RegionType	OutputImageRegionType

using	OutputImageRegionType

using	Pointer

using	Pointer

using	Self

using	Self

using	Superclass

using	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer<const Self>

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OutputImagePixelType

using	OutputImageRegionType

using	Pointer = SmartPointer<Self>

using	Self = ImageToImageFilter

using	Superclass = ImageSource<TOutputImage>

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer<const Self>

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer<Self>

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer<const Self>

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector<DataObjectPointer>

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector<DataObjectIdentifierType>

using	Pointer = SmartPointer<Self>

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
virtual::itk::LightObject::Pointer	CreateAnother () const

const char *	GetNameOfClass () const override

void	SetBoundaryCropSize (const SizeType &s)


virtual void	SetUpperBoundaryCropSize (SizeType _arg)

virtual SizeType	GetUpperBoundaryCropSize () const

virtual void	SetLowerBoundaryCropSize (SizeType _arg)

virtual SizeType	GetLowerBoundaryCropSize () const

Public Member Functions inherited from itk::ExtractImageFilter< TInputImage, TOutputImage >
virtual::itk::LightObject::Pointer	CreateAnother () const

DirectionCollapseStrategyEnum	GetDirectionCollapseToStrategy () const

const char *	GetNameOfClass () const override

void	SetDirectionCollapseToGuess ()

void	SetDirectionCollapseToIdentity ()

void	SetDirectionCollapseToSubmatrix ()

void	SetDirectionCollapseToStrategy (const DirectionCollapseStrategyEnum choosenStrategy)

void	SetExtractionRegion (InputImageRegionType extractRegion)

virtual InputImageRegionType	GetExtractionRegion () const

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const

virtual bool	CanRunInPlace () const

const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *output)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ExtractImageFilter< TInputImage, TOutputImage >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	InputImageDimension = Superclass::InputImageDimension

static constexpr unsigned int	OutputImageDimension = Superclass::OutputImageDimension

Static Public Attributes inherited from itk::ExtractImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
	CropImageFilter ()

void	GenerateOutputInformation () override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

	~CropImageFilter () override=default

Protected Member Functions inherited from itk::ExtractImageFilter< TInputImage, TOutputImage >
void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion) override

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

	ExtractImageFilter ()

void	GenerateData () override

void	GenerateOutputInformation () override

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ExtractImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	GetRunningInPlace () const

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

	InPlaceImageFilter ()=default

void	PrintSelf (std::ostream &os, Indent indent) const override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	ReleaseInputs () override

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

void	AllocateOutputs () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
SizeType	m_LowerBoundaryCropSize {}

SizeType	m_UpperBoundaryCropSize {}

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject>
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ExtractImageFilter< TInputImage, TOutputImage >
InputImageRegionType	m_ExtractionRegion {}

OutputImageRegionType	m_OutputImageRegion {}

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TOutputImage>

using itk::CropImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkCropImageFilter.h.

◆ InputImageIndexType

template<typename TInputImage, typename TOutputImage>

using itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageIndexType

Definition at line 150 of file itkExtractImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage, typename TOutputImage>

using itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Definition at line 146 of file itkExtractImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage, typename TOutputImage>

using itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 142 of file itkExtractImageFilter.h.

◆ InputImageSizeType

template<typename TInputImage, typename TOutputImage>

using itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageSizeType

Definition at line 152 of file itkExtractImageFilter.h.

◆ OutputImageIndexType

template<typename TInputImage, typename TOutputImage>

using itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types.

Definition at line 149 of file itkExtractImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage, typename TOutputImage>

using itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

Definition at line 145 of file itkExtractImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage, typename TOutputImage>

using itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output and input image region types.

Definition at line 141 of file itkExtractImageFilter.h.

◆ OutputImageSizeType

template<typename TInputImage, typename TOutputImage>

using itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

Definition at line 151 of file itkExtractImageFilter.h.

◆ Pointer

template<typename TInputImage, typename TOutputImage>

using itk::CropImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkCropImageFilter.h.

◆ Self

template<typename TInputImage, typename TOutputImage>

using itk::CropImageFilter< TInputImage, TOutputImage >::Self = CropImageFilter

Standard class type aliases.

Definition at line 50 of file itkCropImageFilter.h.

◆ SizeType

template<typename TInputImage, typename TOutputImage>

using itk::CropImageFilter< TInputImage, TOutputImage >::SizeType = InputImageSizeType

Definition at line 74 of file itkCropImageFilter.h.

◆ Superclass

template<typename TInputImage, typename TOutputImage>

using itk::CropImageFilter< TInputImage, TOutputImage >::Superclass = ExtractImageFilter<TInputImage, TOutputImage>

Definition at line 51 of file itkCropImageFilter.h.

Constructor & Destructor Documentation

◆ CropImageFilter()

template<typename TInputImage, typename TOutputImage>

itk::CropImageFilter< TInputImage, TOutputImage >::CropImageFilter ( )

inlineprotected

Definition at line 98 of file itkCropImageFilter.h.

References m_LowerBoundaryCropSize, m_UpperBoundaryCropSize, and itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToSubmatrix().

Referenced by GetNameOfClass().

◆ ~CropImageFilter()

template<typename TInputImage, typename TOutputImage>

itk::CropImageFilter< TInputImage, TOutputImage >::~CropImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage, typename TOutputImage>

virtual::itk::LightObject::Pointer itk::CropImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) 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::LightObject.

◆ GenerateOutputInformation()

template<typename TInputImage, typename TOutputImage>

void itk::CropImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

◆ GetLowerBoundaryCropSize()

template<typename TInputImage, typename TOutputImage>

virtual SizeType itk::CropImageFilter< TInputImage, TOutputImage >::GetLowerBoundaryCropSize ( ) const

virtual

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

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage>

const char * itk::CropImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

References CropImageFilter().

◆ GetUpperBoundaryCropSize()

template<typename TInputImage, typename TOutputImage>

virtual SizeType itk::CropImageFilter< TInputImage, TOutputImage >::GetUpperBoundaryCropSize ( ) const

virtual

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

◆ New()

template<typename TInputImage, typename TOutputImage>

static Pointer itk::CropImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage, typename TOutputImage>

void itk::CropImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent ) const

overrideprotectedvirtual

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

◆ SetBoundaryCropSize()

template<typename TInputImage, typename TOutputImage>

void itk::CropImageFilter< TInputImage, TOutputImage >::SetBoundaryCropSize ( const SizeType & s )

inline

Definition at line 88 of file itkCropImageFilter.h.

References SetLowerBoundaryCropSize(), and SetUpperBoundaryCropSize().

◆ SetLowerBoundaryCropSize()

template<typename TInputImage, typename TOutputImage>

virtual void itk::CropImageFilter< TInputImage, TOutputImage >::SetLowerBoundaryCropSize ( SizeType _arg )

virtual

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

Referenced by SetBoundaryCropSize().

◆ SetUpperBoundaryCropSize()

template<typename TInputImage, typename TOutputImage>

virtual void itk::CropImageFilter< TInputImage, TOutputImage >::SetUpperBoundaryCropSize ( SizeType _arg )

virtual

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

Referenced by SetBoundaryCropSize().

◆ VerifyInputInformation()

template<typename TInputImage, typename TOutputImage>

void itk::CropImageFilter< TInputImage, TOutputImage >::VerifyInputInformation ( ) const

overrideprotectedvirtual

Verifies that the inputs meta-data is consistent and valid for continued execution of the pipeline, throws an exception if not valid.

This method is called immediately before GenerateOutputInformation().

The ProcessObject implementation does nothing. Subclasses might check if all the inputs are in the same coordinate frame.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage, typename TOutputImage>

unsigned int itk::CropImageFilter< TInputImage, TOutputImage >::InputImageDimension = Superclass::InputImageDimension

staticconstexpr

ImageDimension constants.

Definition at line 77 of file itkCropImageFilter.h.

◆ m_LowerBoundaryCropSize

template<typename TInputImage, typename TOutputImage>

SizeType itk::CropImageFilter< TInputImage, TOutputImage >::m_LowerBoundaryCropSize {}

private

Definition at line 117 of file itkCropImageFilter.h.

Referenced by CropImageFilter().

◆ m_UpperBoundaryCropSize

template<typename TInputImage, typename TOutputImage>

SizeType itk::CropImageFilter< TInputImage, TOutputImage >::m_UpperBoundaryCropSize {}

private

Definition at line 116 of file itkCropImageFilter.h.

Referenced by CropImageFilter().

◆ OutputImageDimension

template<typename TInputImage, typename TOutputImage>

unsigned int itk::CropImageFilter< TInputImage, TOutputImage >::OutputImageDimension = Superclass::OutputImageDimension

staticconstexpr

Definition at line 78 of file itkCropImageFilter.h.

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

itkCropImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputImageIndexType

◆ InputImagePixelType

◆ InputImageRegionType

◆ InputImageSizeType

◆ OutputImageIndexType

◆ OutputImagePixelType

◆ OutputImageRegionType

◆ OutputImageSizeType

◆ Pointer

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ CropImageFilter()

◆ ~CropImageFilter()

Member Function Documentation

◆ CreateAnother()

◆ GenerateOutputInformation()

◆ GetLowerBoundaryCropSize()

◆ GetNameOfClass()

◆ GetUpperBoundaryCropSize()

◆ New()

◆ PrintSelf()

◆ SetBoundaryCropSize()

◆ SetLowerBoundaryCropSize()

◆ SetUpperBoundaryCropSize()

◆ VerifyInputInformation()

Member Data Documentation

◆ InputImageDimension

◆ m_LowerBoundaryCropSize

◆ m_UpperBoundaryCropSize

◆ OutputImageDimension