itk::ChangeInformationImageFilter< TInputImage > Class Template Reference
[Geometric Transformation Filters]

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

#include <itkChangeInformationImageFilter.h>

Inheritance diagram for itk::ChangeInformationImageFilter< TInputImage >:

[legend]Collaboration diagram for itk::ChangeInformationImageFilter< TInputImage >:

[legend]List of all members.

Public Types
typedef ChangeInformationImageFilter	Self
typedef ImageToImageFilter< TInputImage, TInputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::RegionType	OutputImageRegionType
typedef TInputImage::RegionType	InputImageRegionType
typedef TInputImage::Pointer	InputImagePointer
typedef TInputImage::PixelType	OutputImagePixelType
typedef TInputImage::PixelType	InputImagePixelType
typedef TInputImage::IndexType	OutputImageIndexType
typedef TInputImage::IndexType	InputImageIndexType
typedef TInputImage::SizeType	OutputImageSizeType
typedef TInputImage::SizeType	InputImageSizeType
typedef TInputImage::OffsetType	OutputImageOffsetType
typedef TInputImage::OffsetType	InputImageOffsetType
typedef TInputImage::SpacingType	SpacingType
typedef TInputImage::PointType	PointType
Public Member Functions
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual const char *	GetClassName () const
virtual void	SetUseReferenceImage (bool _arg)
virtual void	UseReferenceImageOn ()
virtual void	UseReferenceImageOff ()
virtual bool	GetUseReferenceImage ()
void	ChangeNone ()
virtual void	SetChangeSpacing (bool _arg)
virtual void	ChangeSpacingOn ()
virtual void	ChangeSpacingOff ()
virtual bool	GetChangeSpacing ()
virtual void	SetChangeOrigin (bool _arg)
virtual void	ChangeOriginOn ()
virtual void	ChangeOriginOff ()
virtual bool	GetChangeOrigin ()
virtual void	SetChangeRegion (bool _arg)
virtual void	ChangeRegionOn ()
virtual void	ChangeRegionOff ()
virtual bool	GetChangeRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()
void	GenerateData ()
void	SetReferenceImage (TInputImage *image)
virtual TInputImage *	GetReferenceImage ()
virtual void	SetOutputSpacing (SpacingType _arg)
virtual const SpacingType &	GetOutputSpacing ()
virtual void	SetOutputOrigin (PointType _arg)
virtual const PointType &	GetOutputOrigin ()
virtual void	SetOutputOffset (long data[])
virtual const long *	GetOutputOffset () const
void	ChangeAll ()
virtual void	SetCenterImage (bool _arg)
virtual void	CenterImageOn ()
virtual void	CenterImageOff ()
virtual bool	GetCenterImage ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ChangeInformationImageFilter ()
	~ChangeInformationImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

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

Change the origin, spacing 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 and ChangeRegionOn/Off control whether the default origin, spacing 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, 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 47 of file itkChangeInformationImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage> typedef SmartPointer<const Self> itk::ChangeInformationImageFilter< TInputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >. Definition at line 55 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::IndexType itk::ChangeInformationImageFilter< TInputImage >::InputImageIndexType

Definition at line 73 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::OffsetType itk::ChangeInformationImageFilter< TInputImage >::InputImageOffsetType

Definition at line 77 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::PixelType itk::ChangeInformationImageFilter< TInputImage >::InputImagePixelType

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >. Definition at line 69 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::Pointer itk::ChangeInformationImageFilter< TInputImage >::InputImagePointer

Typedef to describe the pointer to the input. Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >. Definition at line 65 of file itkChangeInformationImageFilter.h. Referenced by itk::ChangeInformationImageFilter< TInputImage >::~ChangeInformationImageFilter().

template<class TInputImage> typedef TInputImage::RegionType itk::ChangeInformationImageFilter< TInputImage >::InputImageRegionType

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >. Definition at line 62 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::SizeType itk::ChangeInformationImageFilter< TInputImage >::InputImageSizeType

Definition at line 75 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::IndexType itk::ChangeInformationImageFilter< TInputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types. Definition at line 72 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::OffsetType itk::ChangeInformationImageFilter< TInputImage >::OutputImageOffsetType

Definition at line 76 of file itkChangeInformationImageFilter.h. Referenced by itk::ChangeInformationImageFilter< TInputImage >::~ChangeInformationImageFilter().

template<class TInputImage> typedef TInputImage::PixelType itk::ChangeInformationImageFilter< TInputImage >::OutputImagePixelType

Typedef to describe the type of pixel. Reimplemented from itk::ImageSource< TInputImage >. Definition at line 68 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::RegionType itk::ChangeInformationImageFilter< TInputImage >::OutputImageRegionType

Typedef to describe the output and input image region types. Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >. Definition at line 61 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::SizeType itk::ChangeInformationImageFilter< TInputImage >::OutputImageSizeType

Definition at line 74 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef SmartPointer<Self> itk::ChangeInformationImageFilter< TInputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >. Definition at line 54 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::PointType itk::ChangeInformationImageFilter< TInputImage >::PointType

Definition at line 85 of file itkChangeInformationImageFilter.h. Referenced by itk::ChangeInformationImageFilter< TInputImage >::~ChangeInformationImageFilter().

template<class TInputImage> typedef ChangeInformationImageFilter itk::ChangeInformationImageFilter< TInputImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >. Definition at line 52 of file itkChangeInformationImageFilter.h.

template<class TInputImage> typedef TInputImage::SpacingType itk::ChangeInformationImageFilter< TInputImage >::SpacingType

Image spacing and origin typedefs Definition at line 84 of file itkChangeInformationImageFilter.h. Referenced by itk::ChangeInformationImageFilter< TInputImage >::~ChangeInformationImageFilter().

template<class TInputImage> typedef ImageToImageFilter<TInputImage,TInputImage> itk::ChangeInformationImageFilter< TInputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >. Definition at line 53 of file itkChangeInformationImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage> itk::ChangeInformationImageFilter< TInputImage >::ChangeInformationImageFilter (   )  [protected]

template<class TInputImage> itk::ChangeInformationImageFilter< TInputImage >::~ChangeInformationImageFilter (   )  [inline, protected]

Definition at line 197 of file itkChangeInformationImageFilter.h. References itk::ChangeInformationImageFilter< TInputImage >::InputImagePointer, itk::ChangeInformationImageFilter< TInputImage >::OutputImageOffsetType, itk::ChangeInformationImageFilter< TInputImage >::PointType, and itk::ChangeInformationImageFilter< TInputImage >::SpacingType.

---

Member Function Documentation

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::CenterImageOff (   )  [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.

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

template<class TInputImage> void itk::ChangeInformationImageFilter< TInputImage >::ChangeAll (   )  [inline]

Change the origin, spacing and region of the output image. Definition at line 135 of file itkChangeInformationImageFilter.h.

template<class TInputImage> void itk::ChangeInformationImageFilter< TInputImage >::ChangeNone (   )  [inline]

Change neither the origin nor spacing nor region of the output image. Definition at line 145 of file itkChangeInformationImageFilter.h.

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeOriginOff (   )  [virtual]

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeOriginOn (   )  [virtual]

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeRegionOff (   )  [virtual]

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeRegionOn (   )  [virtual]

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeSpacingOff (   )  [virtual]

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeSpacingOn (   )  [virtual]

template<class TInputImage> void itk::ChangeInformationImageFilter< TInputImage >::GenerateData (   )  [virtual]

Copy the input buffer. Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::GenerateInputRequestedRegion (   )  [virtual]

Apply changes to the input image requested region. Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::GenerateOutputInformation (   )  [virtual]

Apply changes to the output image information. Reimplemented from itk::ProcessObject.

template<class TInputImage> virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetCenterImage (   )  [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.

template<class TInputImage> virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeOrigin (   )  [virtual]

template<class TInputImage> virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeRegion (   )  [virtual]

template<class TInputImage> virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeSpacing (   )  [virtual]

template<class TInputImage> virtual const char* itk::ChangeInformationImageFilter< TInputImage >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

template<class TInputImage> virtual const long* 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.

template<class TInputImage> virtual const PointType& itk::ChangeInformationImageFilter< TInputImage >::GetOutputOrigin (   )  [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.

template<class TInputImage> virtual const SpacingType& itk::ChangeInformationImageFilter< TInputImage >::GetOutputSpacing (   )  [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.

template<class TInputImage> virtual TInputImage* itk::ChangeInformationImageFilter< TInputImage >::GetReferenceImage (   )  [virtual]

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

template<class TInputImage> virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetUseReferenceImage (   )  [virtual]

template<class TInputImage> itk::ChangeInformationImageFilter< TInputImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TInputImage::ImageDimension  )

Image related typedefs.

template<class TInputImage> Pointer itk::ChangeInformationImageFilter< TInputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage> void itk::ChangeInformationImageFilter< TInputImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::ImageToImageFilter< TInputImage, TInputImage >.

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

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

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::SetChangeRegion (  bool  _arg  )  [virtual]

Change the BufferedRegion of the output image.

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

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputOffset (  long  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.

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

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

template<class TInputImage> void itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage (  TInputImage *  image  )  [inline]

Copy the information from another Image. By default, the information is copied from the input image. Definition at line 92 of file itkChangeInformationImageFilter.h.

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::SetUseReferenceImage (  bool  _arg  )  [virtual]

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::UseReferenceImageOff (   )  [virtual]

template<class TInputImage> virtual void itk::ChangeInformationImageFilter< TInputImage >::UseReferenceImageOn (   )  [virtual]

---

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

• itkChangeInformationImageFilter.h

---