itk::ImportImageFilter< TPixel, VImageDimension > Class Template Reference
[Input and Output Filters]

Import data from a standard C array into an itk::Image. More...

#include <itkImportImageFilter.h>

Inheritance diagram for itk::ImportImageFilter< TPixel, VImageDimension >:

[legend]Collaboration diagram for itk::ImportImageFilter< TPixel, VImageDimension >:

[legend]List of all members.

Public Types
typedef Image< TPixel, VImageDimension >	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::SpacingType	SpacingType
typedef OutputImageType::PointType	OriginType
typedef ImportImageFilter	Self
typedef ImageSource< OutputImageType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Index< VImageDimension >	IndexType
typedef Size< VImageDimension >	SizeType
typedef ImageRegion< VImageDimension >	RegionType
typedef TPixel	OutputImagePixelType
Public Member Functions
virtual const char *	GetNameOfClass () const
TPixel *	GetImportPointer ()
void	SetImportPointer (TPixel *ptr, unsigned long num, bool LetFilterManageMemory)
void	SetRegion (const RegionType &region)
const RegionType &	GetRegion () const
virtual const double *	GetOrigin () const
virtual void	SetSpacing (const double data[])
virtual void	SetSpacing (const float data[])
virtual const double *	GetSpacing () const
void	SetSpacing (const SpacingType &spacing)
virtual void	SetOrigin (const double data[])
virtual void	SetOrigin (const float data[])
void	SetOrigin (const OriginType &origin)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ImportImageFilter ()
	~ImportImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	GenerateData ()
virtual void	GenerateOutputInformation ()
virtual void	EnlargeOutputRequestedRegion (DataObject *output)

---

Detailed Description

template<typename TPixel, unsigned int VImageDimension = 2>
class itk::ImportImageFilter< TPixel, VImageDimension >

Import data from a standard C array into an itk::Image.

ImportImageFilter provides a mechanism for importing data into an itk::Image. ImportImageFilter is an image source, so it behaves like any other pipeline object.

This class is templated over the pixel type and the image dimension of the output image.

Definition at line 39 of file itkImportImageFilter.h.

---

Member Typedef Documentation

template<typename TPixel, unsigned int VImageDimension = 2> typedef SmartPointer<const Self> itk::ImportImageFilter< TPixel, VImageDimension >::ConstPointer

Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >. Definition at line 54 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef Index<VImageDimension> itk::ImportImageFilter< TPixel, VImageDimension >::IndexType

Index typedef support. An index is used to access pixel values. Definition at line 63 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef OutputImageType::PointType itk::ImportImageFilter< TPixel, VImageDimension >::OriginType

Definition at line 47 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef TPixel itk::ImportImageFilter< TPixel, VImageDimension >::OutputImagePixelType

Type of the output image pixel type. Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >. Definition at line 73 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef OutputImageType::Pointer itk::ImportImageFilter< TPixel, VImageDimension >::OutputImagePointer

Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >. Definition at line 45 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef Image<TPixel,VImageDimension> itk::ImportImageFilter< TPixel, VImageDimension >::OutputImageType

Typedef for the output image. Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >. Definition at line 44 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef SmartPointer<Self> itk::ImportImageFilter< TPixel, VImageDimension >::Pointer

Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >. Definition at line 53 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef ImageRegion<VImageDimension> itk::ImportImageFilter< TPixel, VImageDimension >::RegionType

Region typedef support. A region is used to specify a subset of an image. Definition at line 70 of file itkImportImageFilter.h. Referenced by itk::ImportImageFilter< TPixel, VImageDimension >::GetRegion(), and itk::ImportImageFilter< TPixel, VImageDimension >::SetRegion().

template<typename TPixel, unsigned int VImageDimension = 2> typedef ImportImageFilter itk::ImportImageFilter< TPixel, VImageDimension >::Self

Standard class typedefs. Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >. Definition at line 51 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef Size<VImageDimension> itk::ImportImageFilter< TPixel, VImageDimension >::SizeType

Size typedef support. A size is used to define region bounds. Definition at line 66 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef OutputImageType::SpacingType itk::ImportImageFilter< TPixel, VImageDimension >::SpacingType

Definition at line 46 of file itkImportImageFilter.h.

template<typename TPixel, unsigned int VImageDimension = 2> typedef ImageSource<OutputImageType> itk::ImportImageFilter< TPixel, VImageDimension >::Superclass

Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >. Definition at line 52 of file itkImportImageFilter.h.

---

Constructor & Destructor Documentation

template<typename TPixel, unsigned int VImageDimension = 2> itk::ImportImageFilter< TPixel, VImageDimension >::ImportImageFilter (   )  [protected]

template<typename TPixel, unsigned int VImageDimension = 2> itk::ImportImageFilter< TPixel, VImageDimension >::~ImportImageFilter (   )  [protected]

---

Member Function Documentation

template<typename TPixel, unsigned int VImageDimension = 2> virtual void itk::ImportImageFilter< TPixel, VImageDimension >::EnlargeOutputRequestedRegion (  DataObject *  output  )  [protected, virtual]

This filter can only produce the amount of data that it is given, so we must override ProcessObject::EnlargeOutputRequestedRegion() (The default implementation of a source produces the amount of data requested. This source, however, can only produce what it is given.) See also: ProcessObject::EnlargeOutputRequestedRegion() Reimplemented from itk::ProcessObject.

template<typename TPixel, unsigned int VImageDimension = 2> virtual void itk::ImportImageFilter< TPixel, VImageDimension >::GenerateData (   )  [protected, virtual]

This filter does not actually "produce" any data, rather it "wraps" the user supplied data into an itk::Image. Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >.

template<typename TPixel, unsigned int VImageDimension = 2> virtual void itk::ImportImageFilter< TPixel, VImageDimension >::GenerateOutputInformation (   )  [protected, virtual]

This is a source, so it must set the spacing, size, and largest possible region for the output image that it will produce. See also: ProcessObject::GenerateOutputInformation() Reimplemented from itk::ProcessObject.

template<typename TPixel, unsigned int VImageDimension = 2> TPixel* itk::ImportImageFilter< TPixel, VImageDimension >::GetImportPointer (   )

Get the pointer from which the image data is imported.

template<typename TPixel, unsigned int VImageDimension = 2> virtual const char* itk::ImportImageFilter< TPixel, VImageDimension >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageSource< Image< TPixel, VImageDimension > >.

template<typename TPixel, unsigned int VImageDimension = 2> virtual const double* itk::ImportImageFilter< TPixel, VImageDimension >::GetOrigin (   )  const [virtual]

Get the origin of the image. See also: SetOrigin()

template<typename TPixel, unsigned int VImageDimension = 2> const RegionType& itk::ImportImageFilter< TPixel, VImageDimension >::GetRegion (   )  const [inline]

Get the region object that defines the size and starting index for the imported image. This will serve as the LargestPossibleRegion, the BufferedRegion, and the RequestedRegion. See also: ImageRegion Definition at line 99 of file itkImportImageFilter.h. References itk::ImportImageFilter< TPixel, VImageDimension >::RegionType.

template<typename TPixel, unsigned int VImageDimension = 2> virtual const double* itk::ImportImageFilter< TPixel, VImageDimension >::GetSpacing (   )  const [virtual]

Get the spacing (size of a pixel) of the image. See also: SetSpacing()

template<typename TPixel, unsigned int VImageDimension = 2> Pointer itk::ImportImageFilter< TPixel, VImageDimension >::New (   )  [static]

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

template<typename TPixel, unsigned int VImageDimension = 2> void itk::ImportImageFilter< TPixel, VImageDimension >::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::ProcessObject.

template<typename TPixel, unsigned int VImageDimension = 2> void itk::ImportImageFilter< TPixel, VImageDimension >::SetImportPointer (  TPixel *  ptr, unsigned long  num, bool  LetFilterManageMemory )

Set the pointer from which the image data is imported. "num" is the number of pixels in the block of memory. If "LetFilterManageMemory" is false, then the this filter will not free the memory in its destructor and the application providing the buffer retains the responsibility of freeing the memory for this image data. If "LetFilterManageMemory" is true, then this class will free the memory when this object is destroyed.

template<typename TPixel, unsigned int VImageDimension = 2> void itk::ImportImageFilter< TPixel, VImageDimension >::SetOrigin (  const OriginType &  origin  )

Set the origin of the image. See also: GetOrigin()

template<typename TPixel, unsigned int VImageDimension = 2> virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetOrigin (  const float  data[]  )  [virtual]

Set the origin of the image. See also: GetOrigin()

template<typename TPixel, unsigned int VImageDimension = 2> virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetOrigin (  const double  data[]  )  [virtual]

Set the origin of the image. See also: GetOrigin()

template<typename TPixel, unsigned int VImageDimension = 2> void itk::ImportImageFilter< TPixel, VImageDimension >::SetRegion (  const RegionType &  region  )  [inline]

Set the region object that defines the size and starting index for the imported image. This will serve as the LargestPossibleRegion, the BufferedRegion, and the RequestedRegion. See also: ImageRegion Definition at line 92 of file itkImportImageFilter.h. References itk::ImportImageFilter< TPixel, VImageDimension >::RegionType.

template<typename TPixel, unsigned int VImageDimension = 2> void itk::ImportImageFilter< TPixel, VImageDimension >::SetSpacing (  const SpacingType &  spacing  )

Get the spacing (size of a pixel) of the image. See also: SetSpacing()

template<typename TPixel, unsigned int VImageDimension = 2> virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetSpacing (  const float  data[]  )  [virtual]

Set the spacing (size of a pixel) of the image. See also: GetSpacing()

template<typename TPixel, unsigned int VImageDimension = 2> virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetSpacing (  const double  data[]  )  [virtual]

Set the spacing (size of a pixel) of the image. See also: GetSpacing()

---

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

• itkImportImageFilter.h

---