ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::ChangeInformationImageFilter< TInputImage > Class Template Reference

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

#include <itkChangeInformationImageFilter.h>

Inheritance diagram for itk::ChangeInformationImageFilter< TInputImage >:
Collaboration diagram for itk::ChangeInformationImageFilter< TInputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
InputImageType::DirectionType 
DirectionType
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef
InputImageType::DirectionType 
InputImageDirectionType
typedef InputImageType::IndexType InputImageIndexType
typedef InputImageType::OffsetType InputImageOffsetType
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef InputImageType::SizeType InputImageSizeType
typedef TInputImage InputImageType
typedef
OutputImageType::DirectionType 
OutputImageDirectionType
typedef OutputImageType::IndexType OutputImageIndexType
typedef OutputImageType::OffsetType OutputImageOffsetType
typedef
OutputImageType::OffsetValueType 
OutputImageOffsetValueType
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::RegionType OutputImageRegionType
typedef OutputImageType::SizeType OutputImageSizeType
typedef TInputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef InputImageType::PointType PointType
typedef
ChangeInformationImageFilter 
Self
typedef InputImageType::SpacingType SpacingType
typedef ImageToImageFilter
< TInputImage, TInputImage > 
Superclass

Public Member Functions

virtual void ChangeDirectionOff ()
virtual void ChangeDirectionOn ()
virtual void ChangeOriginOff ()
virtual void ChangeOriginOn ()
virtual void ChangeRegionOff ()
virtual void ChangeRegionOn ()
virtual void ChangeSpacingOff ()
virtual void ChangeSpacingOn ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
void GenerateData ()
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()
virtual bool GetChangeDirection () const
virtual bool GetChangeOrigin () const
virtual bool GetChangeRegion () const
virtual bool GetChangeSpacing () const
virtual const char * GetNameOfClass () const
virtual TInputImage * GetReferenceImage ()
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 UseReferenceImageOff ()
virtual void UseReferenceImageOn ()
void SetReferenceImage (InputImageType *image)
virtual void SetOutputSpacing (SpacingType _arg)
virtual const SpacingTypeGetOutputSpacing ()
virtual void SetOutputOrigin (PointType _arg)
virtual const PointTypeGetOutputOrigin ()
virtual void SetOutputDirection (DirectionType _arg)
virtual const DirectionTypeGetOutputDirection ()
virtual void SetOutputOffset (OutputImageOffsetType _arg)
virtual const
OutputImageOffsetType
GetOutputOffset ()
virtual void SetOutputOffset (OutputImageOffsetValueType data[])
void ChangeAll ()
void ChangeNone ()
virtual void SetCenterImage (bool _arg)
virtual void CenterImageOn ()
virtual void CenterImageOff ()
virtual bool GetCenterImage () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = InputImageType::ImageDimension

Protected Member Functions

 ChangeInformationImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual void VerifyInputInformation ()

Private Member Functions

 ChangeInformationImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

bool m_CenterImage
bool m_ChangeDirection
bool m_ChangeOrigin
bool m_ChangeRegion
bool m_ChangeSpacing
DirectionType m_OutputDirection
OutputImageOffsetType m_OutputOffset
PointType m_OutputOrigin
SpacingType m_OutputSpacing
InputImagePointer m_ReferenceImage
OutputImageOffsetType m_Shift
bool m_UseReferenceImage

Detailed Description

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


Member Typedef Documentation

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

Definition at line 95 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
typedef InputImageType::ConstPointer itk::ChangeInformationImageFilter< TInputImage >::InputImageConstPointer
template<class TInputImage >
typedef InputImageType::DirectionType itk::ChangeInformationImageFilter< TInputImage >::InputImageDirectionType

Definition at line 86 of file itkChangeInformationImageFilter.h.

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

Definition at line 83 of file itkChangeInformationImageFilter.h.

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

Definition at line 85 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
typedef InputImageType::PixelType itk::ChangeInformationImageFilter< TInputImage >::InputImagePixelType
template<class TInputImage >
typedef InputImageType::Pointer itk::ChangeInformationImageFilter< TInputImage >::InputImagePointer

Typedef to describe the pointer to the input.

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 70 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
typedef InputImageType::RegionType itk::ChangeInformationImageFilter< TInputImage >::InputImageRegionType
template<class TInputImage >
typedef InputImageType::SizeType itk::ChangeInformationImageFilter< TInputImage >::InputImageSizeType

Definition at line 84 of file itkChangeInformationImageFilter.h.

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

Some convenient typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 60 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
typedef OutputImageType::DirectionType itk::ChangeInformationImageFilter< TInputImage >::OutputImageDirectionType

Definition at line 81 of file itkChangeInformationImageFilter.h.

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

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

Definition at line 78 of file itkChangeInformationImageFilter.h.

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

Definition at line 80 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
typedef OutputImageType::OffsetValueType itk::ChangeInformationImageFilter< TInputImage >::OutputImageOffsetValueType

Definition at line 82 of file itkChangeInformationImageFilter.h.

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

Typedef to describe the type of pixel.

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 74 of file itkChangeInformationImageFilter.h.

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

Typedef to describe the output and input image region types.

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 66 of file itkChangeInformationImageFilter.h.

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

Definition at line 79 of file itkChangeInformationImageFilter.h.

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

Some convenient typedefs.

Reimplemented from itk::ImageSource< TInputImage >.

Definition at line 63 of file itkChangeInformationImageFilter.h.

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

Definition at line 94 of file itkChangeInformationImageFilter.h.

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

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 54 of file itkChangeInformationImageFilter.h.

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

Image spacing, origin and direction typedefs

Definition at line 93 of file itkChangeInformationImageFilter.h.

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

Constructor & Destructor Documentation

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

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 154 of file itkChangeInformationImageFilter.h.

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

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

Definition at line 165 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 >
virtual::itk::LightObject::Pointer itk::ChangeInformationImageFilter< TInputImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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

template<class TInputImage >
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeDirection ( ) const [virtual]
template<class TInputImage >
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeOrigin ( ) const [virtual]
template<class TInputImage >
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeRegion ( ) const [virtual]
template<class TInputImage >
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeSpacing ( ) const [virtual]
template<class TInputImage >
virtual const char* itk::ChangeInformationImageFilter< TInputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

template<class TInputImage >
virtual const DirectionType& itk::ChangeInformationImageFilter< TInputImage >::GetOutputDirection ( ) [virtual]

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

template<class TInputImage >
virtual const OutputImageOffsetType& itk::ChangeInformationImageFilter< TInputImage >::GetOutputOffset ( ) [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]
template<class TInputImage >
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetUseReferenceImage ( ) const [virtual]
template<class TInputImage >
static Pointer itk::ChangeInformationImageFilter< TInputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage >
void itk::ChangeInformationImageFilter< TInputImage >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

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

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 >::SetOutputDirection ( DirectionType  _arg) [virtual]

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

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

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

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 ( InputImageType image) [inline]

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

Definition at line 102 of file itkChangeInformationImageFilter.h.

References itk::ProcessObject::SetNthInput().

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]
template<class TInputImage >
virtual void itk::ChangeInformationImageFilter< TInputImage >::VerifyInputInformation ( ) [inline, protected, virtual]

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

See also:
ProcessObject::VerifyInputInformation

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

Definition at line 238 of file itkChangeInformationImageFilter.h.


Member Data Documentation

template<class TInputImage >
const unsigned int itk::ChangeInformationImageFilter< TInputImage >::ImageDimension = InputImageType::ImageDimension [static]

Image related typedefs.

Definition at line 90 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
bool itk::ChangeInformationImageFilter< TInputImage >::m_CenterImage [private]

Definition at line 246 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
bool itk::ChangeInformationImageFilter< TInputImage >::m_ChangeDirection [private]

Definition at line 249 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
bool itk::ChangeInformationImageFilter< TInputImage >::m_ChangeOrigin [private]

Definition at line 248 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
bool itk::ChangeInformationImageFilter< TInputImage >::m_ChangeRegion [private]

Definition at line 250 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
bool itk::ChangeInformationImageFilter< TInputImage >::m_ChangeSpacing [private]

Definition at line 247 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
DirectionType itk::ChangeInformationImageFilter< TInputImage >::m_OutputDirection [private]

Definition at line 255 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
OutputImageOffsetType itk::ChangeInformationImageFilter< TInputImage >::m_OutputOffset [private]

Definition at line 257 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
PointType itk::ChangeInformationImageFilter< TInputImage >::m_OutputOrigin [private]

Definition at line 254 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
SpacingType itk::ChangeInformationImageFilter< TInputImage >::m_OutputSpacing [private]

Definition at line 253 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
InputImagePointer itk::ChangeInformationImageFilter< TInputImage >::m_ReferenceImage [private]

Definition at line 244 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
OutputImageOffsetType itk::ChangeInformationImageFilter< TInputImage >::m_Shift [private]

Definition at line 258 of file itkChangeInformationImageFilter.h.

template<class TInputImage >
bool itk::ChangeInformationImageFilter< TInputImage >::m_UseReferenceImage [private]

Definition at line 251 of file itkChangeInformationImageFilter.h.


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