#include <itkChangeInformationImageFilter.h>

Detailed Description

template<typename TInputImage>
class itk::ChangeInformationImageFilter< TInputImage >

Change the origin, spacing and/or region of an Image.

Change the origin, spacing, direction and/or buffered region of an itkImage. This "Information" along with an Image's container comprise the itkImage. By default, the output's information is set to the input's information. The methods ChangeSpacingOn/Off, ChangeOriginOn/Off, ChangeDirectionOn/Off and ChangeRegionOn/Off control whether the default origin, spacing, direction or buffered region should be changed. If On, the associated information will be replaced with either the ReferenceImage information (if UseReferenceImage is true) or the ivars OutputSpacing, OutputOrigin, OutputDirection, OutputOffset.

In addition, the method CenterImageOn will recompute the output image origin (using the selected output spacing) the align the center of the image with the coordinate 0.

Definition at line 49 of file itkChangeInformationImageFilter.h.

Inheritance diagram for itk::ChangeInformationImageFilter< TInputImage >:

Collaboration diagram for itk::ChangeInformationImageFilter< TInputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DirectionType = typename InputImageType::DirectionType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImageDirectionType = typename InputImageType::DirectionType

using	InputImageIndexType = typename InputImageType::IndexType

using	InputImageOffsetType = typename InputImageType::OffsetType

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageSizeType = typename InputImageType::SizeType

using	InputImageType = TInputImage

using	OutputImageDirectionType = typename OutputImageType::DirectionType

using	OutputImageIndexType = typename OutputImageType::IndexType

using	OutputImageOffsetType = typename OutputImageType::OffsetType

using	OutputImageOffsetValueType = typename OutputImageType::OffsetValueType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageSizeType = typename OutputImageType::SizeType

using	OutputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	PointType = typename InputImageType::PointType

using	Self = ChangeInformationImageFilter

using	SpacingType = typename InputImageType::SpacingType

using	Superclass = ImageToImageFilter< TInputImage, TInputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
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< TInputImage >

Public Types inherited from itk::ImageSource< TInputImage >
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 = TInputImage

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

virtual void	ChangeOriginOn ()

virtual void	ChangeRegionOn ()

virtual void	ChangeSpacingOn ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

virtual bool	GetChangeDirection () const

virtual bool	GetChangeOrigin () const

virtual bool	GetChangeRegion () const

virtual bool	GetChangeSpacing () const

virtual TInputImage *	GetModifiableReferenceImage ()

const char *	GetNameOfClass () const override

virtual bool	GetUseReferenceImage () const

virtual void	SetChangeDirection (bool _arg)

virtual void	SetChangeOrigin (bool _arg)

virtual void	SetChangeRegion (bool _arg)

virtual void	SetChangeSpacing (bool _arg)

virtual void	SetUseReferenceImage (bool _arg)

virtual void	UseReferenceImageOn ()


void	SetReferenceImage (InputImageType *image)


virtual void	SetOutputSpacing (SpacingType _arg)

virtual const SpacingType &	GetOutputSpacing () const


virtual void	SetOutputOrigin (PointType _arg)

virtual const PointType &	GetOutputOrigin () const


virtual void	SetOutputDirection (DirectionType _arg)

virtual const DirectionType &	GetOutputDirection () const


virtual void	SetOutputOffset (OutputImageOffsetType _arg)

virtual const OutputImageOffsetType &	GetOutputOffset () const

virtual void	SetOutputOffset (OutputImageOffsetValueType data[])


void	ChangeAll ()


void	ChangeNone ()


virtual void	SetCenterImage (bool _arg)

virtual void	CenterImageOn ()

virtual bool	GetCenterImage () const

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
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< TInputImage >
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, TInputImage >
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	ImageDimension = InputImageType::ImageDimension

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

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TInputImage >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
	ChangeInformationImageFilter ()=default

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

void	VerifyInputInformation () const override

	~ChangeInformationImageFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
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< TInputImage >
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 ()

Private Attributes
bool	m_CenterImage { false }

bool	m_ChangeDirection { false }

bool	m_ChangeOrigin { false }

bool	m_ChangeRegion { false }

bool	m_ChangeSpacing { false }

DirectionType	m_OutputDirection { DirectionType::GetIdentity() }

OutputImageOffsetType	m_OutputOffset {}

PointType	m_OutputOrigin {}

SpacingType	m_OutputSpacing { MakeFilled<SpacingType>(1.0) }

InputImagePointer	m_ReferenceImage { nullptr }

OutputImageOffsetType	m_Shift {}

bool	m_UseReferenceImage { false }

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

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

Static Protected Member Functions inherited from itk::ImageSource< TInputImage >
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::ImageSource< TInputImage >
bool	m_DynamicMultiThreading

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 >

using itk::ChangeInformationImageFilter< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkChangeInformationImageFilter.h.

◆ DirectionType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::DirectionType = typename InputImageType::DirectionType

Definition at line 95 of file itkChangeInformationImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 72 of file itkChangeInformationImageFilter.h.

◆ InputImageDirectionType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::InputImageDirectionType = typename InputImageType::DirectionType

Definition at line 87 of file itkChangeInformationImageFilter.h.

◆ InputImageIndexType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::InputImageIndexType = typename InputImageType::IndexType

Definition at line 84 of file itkChangeInformationImageFilter.h.

◆ InputImageOffsetType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::InputImageOffsetType = typename InputImageType::OffsetType

Definition at line 86 of file itkChangeInformationImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 76 of file itkChangeInformationImageFilter.h.

◆ InputImagePointer

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::InputImagePointer = typename InputImageType::Pointer

Typedef to describe the pointer to the input.

Definition at line 71 of file itkChangeInformationImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 68 of file itkChangeInformationImageFilter.h.

◆ InputImageSizeType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::InputImageSizeType = typename InputImageType::SizeType

Definition at line 85 of file itkChangeInformationImageFilter.h.

◆ InputImageType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::InputImageType = TInputImage

Definition at line 63 of file itkChangeInformationImageFilter.h.

◆ OutputImageDirectionType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::OutputImageDirectionType = typename OutputImageType::DirectionType

Definition at line 82 of file itkChangeInformationImageFilter.h.

◆ OutputImageIndexType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::OutputImageIndexType = typename OutputImageType::IndexType

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

Definition at line 79 of file itkChangeInformationImageFilter.h.

◆ OutputImageOffsetType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::OutputImageOffsetType = typename OutputImageType::OffsetType

Definition at line 81 of file itkChangeInformationImageFilter.h.

◆ OutputImageOffsetValueType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::OutputImageOffsetValueType = typename OutputImageType::OffsetValueType

Definition at line 83 of file itkChangeInformationImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Typedef to describe the type of pixel.

Definition at line 75 of file itkChangeInformationImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Typedef to describe the output and input image region types.

Definition at line 67 of file itkChangeInformationImageFilter.h.

◆ OutputImageSizeType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::OutputImageSizeType = typename OutputImageType::SizeType

Definition at line 80 of file itkChangeInformationImageFilter.h.

◆ OutputImageType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::OutputImageType = TInputImage

Definition at line 64 of file itkChangeInformationImageFilter.h.

◆ Pointer

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkChangeInformationImageFilter.h.

◆ PointType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::PointType = typename InputImageType::PointType

Definition at line 94 of file itkChangeInformationImageFilter.h.

◆ Self

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::Self = ChangeInformationImageFilter

Standard class type aliases.

Definition at line 55 of file itkChangeInformationImageFilter.h.

◆ SpacingType

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::SpacingType = typename InputImageType::SpacingType

Image spacing, origin and direction type alias

Definition at line 93 of file itkChangeInformationImageFilter.h.

◆ Superclass

template<typename TInputImage >

using itk::ChangeInformationImageFilter< TInputImage >::Superclass = ImageToImageFilter<TInputImage, TInputImage>

Definition at line 56 of file itkChangeInformationImageFilter.h.

Constructor & Destructor Documentation

◆ ChangeInformationImageFilter()

template<typename TInputImage >

itk::ChangeInformationImageFilter< TInputImage >::ChangeInformationImageFilter ( )

protecteddefault

◆ ~ChangeInformationImageFilter()

template<typename TInputImage >

itk::ChangeInformationImageFilter< TInputImage >::~ChangeInformationImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CenterImageOn()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::CenterImageOn ( )

virtual

Set the Origin of the output so that image coordinate (0,0,0) lies at the Center of the Image. This will override SetOutputOrigin.

◆ ChangeAll()

template<typename TInputImage >

void itk::ChangeInformationImageFilter< TInputImage >::ChangeAll ( )

inline

Change the origin, spacing and region of the output image.

Definition at line 156 of file itkChangeInformationImageFilter.h.

◆ ChangeDirectionOn()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeDirectionOn ( )

virtual

◆ ChangeNone()

template<typename TInputImage >

void itk::ChangeInformationImageFilter< TInputImage >::ChangeNone ( )

inline

Do not change the origin, spacing, direction or region of the output image.

Definition at line 168 of file itkChangeInformationImageFilter.h.

◆ ChangeOriginOn()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeOriginOn ( )

virtual

◆ ChangeRegionOn()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeRegionOn ( )

virtual

◆ ChangeSpacingOn()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeSpacingOn ( )

virtual

◆ GenerateData()

template<typename TInputImage >

void itk::ChangeInformationImageFilter< TInputImage >::GenerateData ( )

overridevirtual

Copy the input buffer.

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

template<typename TInputImage >

void itk::ChangeInformationImageFilter< TInputImage >::GenerateInputRequestedRegion ( )

overridevirtual

Apply changes to the input image requested region.

Reimplemented from itk::ProcessObject.

◆ GenerateOutputInformation()

template<typename TInputImage >

void itk::ChangeInformationImageFilter< TInputImage >::GenerateOutputInformation ( )

overridevirtual

Apply changes to the output image information.

Reimplemented from itk::ProcessObject.

◆ GetCenterImage()

template<typename TInputImage >

virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetCenterImage ( ) const

virtual

Set the Origin of the output so that image coordinate (0,0,0) lies at the Center of the Image. This will override SetOutputOrigin.

◆ GetChangeDirection()

template<typename TInputImage >

virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeDirection ( ) const

virtual

◆ GetChangeOrigin()

template<typename TInputImage >

virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeOrigin ( ) const

virtual

◆ GetChangeRegion()

template<typename TInputImage >

virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeRegion ( ) const

virtual

◆ GetChangeSpacing()

template<typename TInputImage >

virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeSpacing ( ) const

virtual

◆ GetModifiableReferenceImage()

template<typename TInputImage >

virtual TInputImage * itk::ChangeInformationImageFilter< TInputImage >::GetModifiableReferenceImage ( )

virtual

◆ GetNameOfClass()

template<typename TInputImage >

const char * itk::ChangeInformationImageFilter< TInputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetOutputDirection()

template<typename TInputImage >

virtual const DirectionType & itk::ChangeInformationImageFilter< TInputImage >::GetOutputDirection ( ) const

virtual

Specify a new direction cosine matrix explicitly. The default is to use the direction of the Input, or of the ReferenceImage if UseReferenceImage is true.

◆ GetOutputOffset()

template<typename TInputImage >

virtual const OutputImageOffsetType & itk::ChangeInformationImageFilter< TInputImage >::GetOutputOffset ( ) const

virtual

Specify an offset for the buffered region. The default is to use the same buffered region as the input or an Offset computed from the ReferenceImage's buffered region (if UseReferenceImage is true.) NOTE: Changing the buffered region should not be done without a corresponding change in the requested region. Of course, the pipeline controls the requested region. Therefore, changing the buffered region may mean the filter cannot produce the requested region.

◆ GetOutputOrigin()

template<typename TInputImage >

virtual const PointType & itk::ChangeInformationImageFilter< TInputImage >::GetOutputOrigin ( ) const

virtual

Specify a new data origin explicitly. The default is to use the origin of the Input, or of the ReferenceImage if UseReferenceImage is true.

◆ GetOutputSpacing()

template<typename TInputImage >

virtual const SpacingType & itk::ChangeInformationImageFilter< TInputImage >::GetOutputSpacing ( ) const

virtual

Specify a new data spacing explicitly. The default is to use the spacing of the Input, or of the ReferenceImage if UseReferenceImage is set.

◆ GetUseReferenceImage()

template<typename TInputImage >

virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetUseReferenceImage ( ) const

virtual

◆ New()

template<typename TInputImage >

static Pointer itk::ChangeInformationImageFilter< TInputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage >

void itk::ChangeInformationImageFilter< TInputImage >::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::ProcessObject.

◆ SetCenterImage()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetCenterImage ( bool _arg )

virtual

Set the Origin of the output so that image coordinate (0,0,0) lies at the Center of the Image. This will override SetOutputOrigin.

◆ SetChangeDirection()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetChangeDirection ( bool _arg )

virtual

Change the direction of the output image. If false, the output image direction will be set to the input image direction. If true, the output image direction will be set to: the ReferenceImage direction (if UseReferenceImage is true) or OutputDirection.

◆ SetChangeOrigin()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetChangeOrigin ( bool _arg )

virtual

Change the Origin of the output image. If false, the output image origin will be set to the input image origin. If true, the output image origin will be set to: the ReferenceImage origin (if UseReferenceImage is true) or OutputOrigin.

◆ SetChangeRegion()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetChangeRegion ( bool _arg )

virtual

Change the BufferedRegion of the output image.

◆ SetChangeSpacing()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetChangeSpacing ( bool _arg )

virtual

Change the Spacing of the output image. If false, the output image spacing will be set to the input image spacing. If true, the output image spacing will be set to: the ReferenceImage spacing (if UseReferenceImage is true) or OutputSpacing.

◆ SetOutputDirection()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputDirection ( DirectionType _arg )

virtual

Specify a new direction cosine matrix explicitly. The default is to use the direction of the Input, or of the ReferenceImage if UseReferenceImage is true.

◆ SetOutputOffset() [1/2]

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputOffset ( OutputImageOffsetType _arg )

virtual

Specify an offset for the buffered region. The default is to use the same buffered region as the input or an Offset computed from the ReferenceImage's buffered region (if UseReferenceImage is true.) NOTE: Changing the buffered region should not be done without a corresponding change in the requested region. Of course, the pipeline controls the requested region. Therefore, changing the buffered region may mean the filter cannot produce the requested region.

◆ SetOutputOffset() [2/2]

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputOffset ( OutputImageOffsetValueType data[] )

virtual

Specify an offset for the buffered region. The default is to use the same buffered region as the input or an Offset computed from the ReferenceImage's buffered region (if UseReferenceImage is true.) NOTE: Changing the buffered region should not be done without a corresponding change in the requested region. Of course, the pipeline controls the requested region. Therefore, changing the buffered region may mean the filter cannot produce the requested region.

◆ SetOutputOrigin()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputOrigin ( PointType _arg )

virtual

Specify a new data origin explicitly. The default is to use the origin of the Input, or of the ReferenceImage if UseReferenceImage is true.

◆ SetOutputSpacing()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputSpacing ( SpacingType _arg )

virtual

Specify a new data spacing explicitly. The default is to use the spacing of the Input, or of the ReferenceImage if UseReferenceImage is set.

◆ SetReferenceImage()

template<typename TInputImage >

void itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage ( InputImageType * image )

inline

Copy the information from another Image. By default, the information is copied from the input image.

Definition at line 103 of file itkChangeInformationImageFilter.h.

References itk::ProcessObject::SetNthInput().

◆ SetUseReferenceImage()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::SetUseReferenceImage ( bool _arg )

virtual

◆ UseReferenceImageOn()

template<typename TInputImage >

virtual void itk::ChangeInformationImageFilter< TInputImage >::UseReferenceImageOn ( )

virtual

◆ VerifyInputInformation()

template<typename TInputImage >

void itk::ChangeInformationImageFilter< TInputImage >::VerifyInputInformation ( ) const

inlineoverrideprotectedvirtual

Override VerifyInputInformation() since this filter's inputs do not need to occupy the same physical space.

See also: ProcessObject::VerifyInputInformation

Reimplemented from itk::ProcessObject.

Definition at line 246 of file itkChangeInformationImageFilter.h.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage >

constexpr unsigned int itk::ChangeInformationImageFilter< TInputImage >::ImageDimension = InputImageType::ImageDimension

staticconstexpr

Image related type alias.

Definition at line 90 of file itkChangeInformationImageFilter.h.

◆ m_CenterImage

template<typename TInputImage >

bool itk::ChangeInformationImageFilter< TInputImage >::m_CenterImage { false }

private

Definition at line 252 of file itkChangeInformationImageFilter.h.

◆ m_ChangeDirection

template<typename TInputImage >

bool itk::ChangeInformationImageFilter< TInputImage >::m_ChangeDirection { false }

private

Definition at line 255 of file itkChangeInformationImageFilter.h.

◆ m_ChangeOrigin

template<typename TInputImage >

bool itk::ChangeInformationImageFilter< TInputImage >::m_ChangeOrigin { false }

private

Definition at line 254 of file itkChangeInformationImageFilter.h.

◆ m_ChangeRegion

template<typename TInputImage >

bool itk::ChangeInformationImageFilter< TInputImage >::m_ChangeRegion { false }

private

Definition at line 256 of file itkChangeInformationImageFilter.h.

◆ m_ChangeSpacing

template<typename TInputImage >

bool itk::ChangeInformationImageFilter< TInputImage >::m_ChangeSpacing { false }

private

Definition at line 253 of file itkChangeInformationImageFilter.h.

◆ m_OutputDirection

template<typename TInputImage >

DirectionType itk::ChangeInformationImageFilter< TInputImage >::m_OutputDirection { DirectionType::GetIdentity() }

private

Definition at line 261 of file itkChangeInformationImageFilter.h.

◆ m_OutputOffset

template<typename TInputImage >

OutputImageOffsetType itk::ChangeInformationImageFilter< TInputImage >::m_OutputOffset {}

private

Definition at line 263 of file itkChangeInformationImageFilter.h.

◆ m_OutputOrigin

template<typename TInputImage >

PointType itk::ChangeInformationImageFilter< TInputImage >::m_OutputOrigin {}

private

Definition at line 260 of file itkChangeInformationImageFilter.h.

◆ m_OutputSpacing

template<typename TInputImage >

SpacingType itk::ChangeInformationImageFilter< TInputImage >::m_OutputSpacing { MakeFilled<SpacingType>(1.0) }

private

Definition at line 259 of file itkChangeInformationImageFilter.h.

◆ m_ReferenceImage

template<typename TInputImage >

InputImagePointer itk::ChangeInformationImageFilter< TInputImage >::m_ReferenceImage { nullptr }

private

Definition at line 250 of file itkChangeInformationImageFilter.h.

◆ m_Shift

template<typename TInputImage >

OutputImageOffsetType itk::ChangeInformationImageFilter< TInputImage >::m_Shift {}

private

Definition at line 264 of file itkChangeInformationImageFilter.h.

◆ m_UseReferenceImage

template<typename TInputImage >

bool itk::ChangeInformationImageFilter< TInputImage >::m_UseReferenceImage { false }

private

Definition at line 257 of file itkChangeInformationImageFilter.h.

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

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

◆ DirectionType

◆ InputImageConstPointer

◆ InputImageDirectionType

◆ InputImageIndexType

◆ InputImageOffsetType

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageSizeType

◆ InputImageType

◆ OutputImageDirectionType

◆ OutputImageIndexType

◆ OutputImageOffsetType

◆ OutputImageOffsetValueType

◆ OutputImagePixelType

◆ OutputImageRegionType

◆ OutputImageSizeType

◆ OutputImageType

◆ Pointer

◆ PointType

◆ Self

◆ SpacingType

◆ Superclass

Constructor & Destructor Documentation

◆ ChangeInformationImageFilter()

◆ ~ChangeInformationImageFilter()

Member Function Documentation

◆ CenterImageOn()

◆ ChangeAll()

◆ ChangeDirectionOn()

◆ ChangeNone()

◆ ChangeOriginOn()

◆ ChangeRegionOn()

◆ ChangeSpacingOn()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetCenterImage()

◆ GetChangeDirection()

◆ GetChangeOrigin()

◆ GetChangeRegion()

◆ GetChangeSpacing()

◆ GetModifiableReferenceImage()

◆ GetNameOfClass()

◆ GetOutputDirection()

◆ GetOutputOffset()

◆ GetOutputOrigin()

◆ GetOutputSpacing()

◆ GetUseReferenceImage()

◆ New()

◆ PrintSelf()

◆ SetCenterImage()

◆ SetChangeDirection()

◆ SetChangeOrigin()

◆ SetChangeRegion()

◆ SetChangeSpacing()

◆ SetOutputDirection()

◆ SetOutputOffset() [1/2]

◆ SetOutputOffset() [2/2]

◆ SetOutputOrigin()

◆ SetOutputSpacing()

◆ SetReferenceImage()

◆ SetUseReferenceImage()

◆ UseReferenceImageOn()

◆ VerifyInputInformation()

Member Data Documentation

◆ ImageDimension

◆ m_CenterImage

◆ m_ChangeDirection

◆ m_ChangeOrigin