#include <itkExtractImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::ExtractImageFilter< TInputImage, TOutputImage >

Decrease the image size by cropping the image to the selected region bounds.

ExtractImageFilter changes the image boundary of an image by removing pixels outside the target region. The target region must be specified.

ExtractImageFilter also collapses dimensions so that the input image may have more dimensions than the output image (i.e. 4-D input image to a 3-D output image). To specify what dimensions to collapse, the ExtractionRegion must be specified. For any dimension dim where ExtractionRegion.Size[dim] = 0, that dimension is collapsed. The index to collapse on is specified by ExtractionRegion.Index[dim]. For example, we have a image 4D = a 4x4x4x4 image, and we want to get a 3D image, 3D = a 4x4x4 image, specified as [x,y,z,2] from 4D (i.e. the 3rd "time" slice from 4D). The ExtractionRegion.Size = [4,4,4,0] and ExtractionRegion.Index = [0,0,0,2].

The number of dimension in ExtractionRegion.Size and Index must = InputImageDimension. The number of non-zero dimensions in ExtractionRegion.Size must = OutputImageDimension.

The output image produced by this filter will have the same origin as the input image, while the ImageRegion of the output image will start at the starting index value provided in the ExtractRegion parameter. If you are looking for a filter that will re-compute the origin of the output image, and provide an output image region whose index is set to zeros, then you may want to use the RegionOfInterestImageFilter. The output spacing is simply the collapsed version of the input spacing.

Determining the direction of the collapsed output image from an larger dimensional input space is an ill defined problem in general. It is required that the application developer select the desired transformation strategy for collapsing direction cosines. It is REQUIRED that a strategy be explicitly requested (i.e. there is no working default). Direction Collapsing Strategies: 1) DirectionCollapseToUnknown(); This is the default and the filter can not run when this is set. The reason is to explicitly force the application developer to define their desired behavior. 1) DirectionCollapseToIdentity(); Output has identity direction no matter what 2) DirectionCollapseToSubmatrix(); Output direction is the sub-matrix if it is positive definite, else throw an exception.

This filter is implemented as a multithreaded filter. It provides a DynamicThreadedGenerateData() method for its implementation.

Note: This filter is derived from InPlaceImageFilter. When the input to this filter matched the output requested region, like with streaming filter for input, then setting this filter to run in-place will result in no copying of the bulk pixel data.

See also: CropImageFilter

ITK Sphinx Examples:

<a href=
<a href=

Definition at line 119 of file itkExtractImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DirectionCollapseStrategyEnum = ExtractImageFilterEnums::DirectionCollapseStrategy

using	ExtractImageFilterRegionCopierType = ImageToImageFilterDetail::ExtractImageFilterRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

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 = 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	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

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

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

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

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *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 >
const char *	GetNameOfClass () const override

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	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

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 DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

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

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
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 = 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	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
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

	InPlaceImageFilter ()=default

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

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

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	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

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

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	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

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

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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	ReleaseInputs ()

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	VerifyInputInformation () const

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	SetThreaderUpdateProgress (bool arg)

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

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

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

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	PrintSelf (std::ostream &os, Indent indent) const

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

virtual	~LightObject ()

Protected Attributes
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 {}

Private Attributes
DirectionCollapseStrategyEnum	m_DirectionCollapseStrategy { DirectionCollapseStrategyEnum::DIRECTIONCOLLAPSETOUNKOWN }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

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)

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 128 of file itkExtractImageFilter.h.

◆ DirectionCollapseStrategyEnum

template<typename TInputImage , typename TOutputImage >

using itk::ExtractImageFilter< TInputImage, TOutputImage >::DirectionCollapseStrategyEnum = ExtractImageFilterEnums::DirectionCollapseStrategy

Definition at line 154 of file itkExtractImageFilter.h.

◆ ExtractImageFilterRegionCopierType

template<typename TInputImage , typename TOutputImage >

using itk::ExtractImageFilter< TInputImage, TOutputImage >::ExtractImageFilterRegionCopierType = ImageToImageFilterDetail::ExtractImageFilterRegionCopier<Self::InputImageDimension, Self::OutputImageDimension>

Definition at line 253 of file itkExtractImageFilter.h.

◆ InputImageIndexType

template<typename TInputImage , typename TOutputImage >

using itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageIndexType = typename TInputImage::IndexType

Definition at line 150 of file itkExtractImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage >

using itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename TInputImage::PixelType

Definition at line 146 of file itkExtractImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >

using itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename TInputImage::RegionType

Definition at line 142 of file itkExtractImageFilter.h.

◆ InputImageSizeType

template<typename TInputImage , typename TOutputImage >

using itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageSizeType = typename TInputImage::SizeType

Definition at line 152 of file itkExtractImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

using itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Image type information.

Definition at line 137 of file itkExtractImageFilter.h.

◆ OutputImageIndexType

template<typename TInputImage , typename TOutputImage >

using itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageIndexType = typename TOutputImage::IndexType

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 = typename TOutputImage::PixelType

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 = typename TOutputImage::RegionType

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 = typename TOutputImage::SizeType

Definition at line 151 of file itkExtractImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >

using itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 138 of file itkExtractImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 127 of file itkExtractImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

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

Standard class type aliases.

Definition at line 125 of file itkExtractImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

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

Definition at line 126 of file itkExtractImageFilter.h.

Constructor & Destructor Documentation

◆ ExtractImageFilter()

template<typename TInputImage , typename TOutputImage >

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

protected

◆ ~ExtractImageFilter()

template<typename TInputImage , typename TOutputImage >

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

overrideprotecteddefault

Member Function Documentation

◆ CallCopyOutputRegionToInputRegion()

template<typename TInputImage , typename TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::CallCopyOutputRegionToInputRegion	(	InputImageRegionType &	destRegion,
		const OutputImageRegionType &	srcRegion
	)

overrideprotected

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

See also: ImageToImageFilter::CallCopyRegion()

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

overrideprotected

ExtractImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a DynamicThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling DynamicThreadedGenerateData(). DynamicThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

Overridden to check if there is no work to be done, before calling superclass' implementation.

Reimplemented from itk::ProcessObject.

◆ GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

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

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

◆ GetDirectionCollapseToStrategy()

template<typename TInputImage , typename TOutputImage >

DirectionCollapseStrategyEnum itk::ExtractImageFilter< TInputImage, TOutputImage >::GetDirectionCollapseToStrategy ( ) const

inline

NOTE: The SetDirectionCollapseToUknown is explicitly not defined. It is a state that a filter can be in only when it is first instantiate prior to being initialized. Get the currently set strategy for collapsing directions of physical space.

Definition at line 222 of file itkExtractImageFilter.h.

◆ GetExtractionRegion()

template<typename TInputImage , typename TOutputImage >

virtual InputImageRegionType itk::ExtractImageFilter< TInputImage, TOutputImage >::GetExtractionRegion ( ) const

virtual

Set/Get the output image region. If any of the ExtractionRegion.Size = 0 for any particular dimension dim, we have to collapse dimension dim. This means the output image will have 'c' dimensions less than the input image, where c = number of ExtractionRegion.Size = 0.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

◆ New()

template<typename TInputImage , typename TOutputImage >

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

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::ExtractImageFilter< 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.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

◆ SetDirectionCollapseToGuess()

template<typename TInputImage , typename TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToGuess ( )

inline

See also: SetDirectionCollapseToStrategy

Definition at line 229 of file itkExtractImageFilter.h.

◆ SetDirectionCollapseToIdentity()

template<typename TInputImage , typename TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToIdentity ( )

inline

See also: SetDirectionCollapseToStrategy

Definition at line 236 of file itkExtractImageFilter.h.

◆ SetDirectionCollapseToStrategy()

template<typename TInputImage , typename TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToStrategy ( const DirectionCollapseStrategyEnum choosenStrategy )

inline

Backwards compatibility for enum values Set the strategy to be used to collapse physical space dimensions.

itk::itkExtractImageFilter::DIRECTIONCOLLAPSETOIDENTITY Set the strategy so that all collapsed images have an identity direction. Use this strategy when you know that retention of the physical space orientation of the collapsed image is not important.

itk::itkExtractImageFilter::DIRECTIONCOLLAPSETOGUESS Set the strategy so that all collapsed images where output direction is the sub-matrix if it is positive definite, else return identity. This is backwards compatible with ITKv3, but is highly discouraged because the results are difficult to anticipate under differing data scenarios.

itk::itkExtractImageFilter::DIRECTIONCOLLAPSETOSUBMATRIX Set the strategy so that all collapsed images where output direction is the sub-matrix if it is positive definite, else throw an exception. Use this strategy when it is known that properly identified physical space sub-volumes can be reliably extracted from a higher dimensional space. For example when the application programmer knows that a 4D image is 3D+time, and that the 3D sub-space is properly defined.

Definition at line 195 of file itkExtractImageFilter.h.

◆ SetDirectionCollapseToSubmatrix()

template<typename TInputImage , typename TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToSubmatrix ( )

inline

See also: SetDirectionCollapseToStrategy

Definition at line 243 of file itkExtractImageFilter.h.

◆ SetExtractionRegion()

template<typename TInputImage , typename TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetExtractionRegion ( InputImageRegionType extractRegion )

Set/Get the output image region. If any of the ExtractionRegion.Size = 0 for any particular dimension dim, we have to collapse dimension dim. This means the output image will have 'c' dimensions less than the input image, where c = number of ExtractionRegion.Size = 0.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension enumeration

Definition at line 250 of file itkExtractImageFilter.h.

◆ m_DirectionCollapseStrategy

template<typename TInputImage , typename TOutputImage >

DirectionCollapseStrategyEnum itk::ExtractImageFilter< TInputImage, TOutputImage >::m_DirectionCollapseStrategy { DirectionCollapseStrategyEnum::DIRECTIONCOLLAPSETOUNKOWN }

private

Definition at line 325 of file itkExtractImageFilter.h.

◆ m_ExtractionRegion

template<typename TInputImage , typename TOutputImage >

InputImageRegionType itk::ExtractImageFilter< TInputImage, TOutputImage >::m_ExtractionRegion {}

protected

Definition at line 320 of file itkExtractImageFilter.h.

◆ m_OutputImageRegion

template<typename TInputImage , typename TOutputImage >

OutputImageRegionType itk::ExtractImageFilter< TInputImage, TOutputImage >::m_OutputImageRegion {}

protected

Definition at line 322 of file itkExtractImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 251 of file itkExtractImageFilter.h.

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

itkExtractImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DirectionCollapseStrategyEnum

◆ ExtractImageFilterRegionCopierType

◆ InputImageIndexType

◆ InputImagePixelType

◆ InputImageRegionType

◆ InputImageSizeType

◆ InputImageType

◆ OutputImageIndexType

◆ OutputImagePixelType

◆ OutputImageRegionType

◆ OutputImageSizeType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ExtractImageFilter()

◆ ~ExtractImageFilter()

Member Function Documentation

◆ CallCopyOutputRegionToInputRegion()

◆ DynamicThreadedGenerateData()

◆ GenerateData()

◆ GenerateOutputInformation()

◆ GetDirectionCollapseToStrategy()

◆ GetExtractionRegion()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

◆ SetDirectionCollapseToGuess()

◆ SetDirectionCollapseToIdentity()

◆ SetDirectionCollapseToStrategy()

◆ SetDirectionCollapseToSubmatrix()

◆ SetExtractionRegion()

Member Data Documentation

◆ InputImageDimension

◆ m_DirectionCollapseStrategy

◆ m_ExtractionRegion

◆ m_OutputImageRegion

◆ OutputImageDimension