ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::ImportImageFilter< TPixel, VImageDimension > Class Template Reference
Input and Output Filters | Module ITKCommon

#include <itkImportImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef Matrix< double,
VImageDimension,
VImageDimension > 		DirectionType
typedef Index< VImageDimension > IndexType
typedef OutputImageType::PointType OriginType
typedef TPixel OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef Image< TPixel,
VImageDimension > 		OutputImageType
typedef SmartPointer< Self > Pointer
typedef ImageRegion
< VImageDimension > 		RegionType
typedef ImportImageFilter Self
typedef Size< VImageDimension > SizeType
typedef
OutputImageType::SpacingType 		SpacingType
typedef ImageSource
< OutputImageType > 		Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
TPixel * GetImportPointer ()
virtual const char * GetNameOfClass () const
const RegionType & GetRegion () const
virtual void SetDirection (const DirectionType direction)
void SetImportPointer (TPixel *ptr, SizeValueType num, bool LetFilterManageMemory)
void SetRegion (const RegionType &region)
virtual void SetSpacing (SpacingType _arg)
virtual const SpacingType & GetSpacing ()
virtual void SetSpacing (const float data[])
virtual void SetOrigin (OriginType _arg)
virtual const OriginType & GetOrigin ()
virtual void SetOrigin (const float data[])

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual void EnlargeOutputRequestedRegion (DataObject *output)
virtual void GenerateData ()
virtual void GenerateOutputInformation ()

Private Member Functions

 ImportImageFilter (const ImportImageFilter &)
void operator= (const ImportImageFilter &)

Private Attributes

DirectionType m_Direction
bool m_FilterManageMemory
TPixel * m_ImportPointer
OriginType m_Origin
RegionType m_Region
SizeValueType m_Size
SpacingType m_Spacing
virtual const DirectionType & GetDirection ()
 ImportImageFilter ()
 ~ImportImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const

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.

Wiki Examples:

Definition at line 43 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 57 of file itkImportImageFilter.h.

template<typename TPixel , unsigned int VImageDimension = 2>
typedef Matrix< double, VImageDimension, VImageDimension > itk::ImportImageFilter< TPixel, VImageDimension >::DirectionType

Definition at line 116 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 51 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 76 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 49 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 48 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 56 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 73 of file itkImportImageFilter.h.

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 54 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 69 of file itkImportImageFilter.h.

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

Definition at line 50 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 55 of file itkImportImageFilter.h.

Constructor & Destructor Documentation

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

Get the direction of the image

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

Get the direction of the image

See also:
SetDirection
template<typename TPixel , unsigned int VImageDimension = 2>
itk::ImportImageFilter< TPixel, VImageDimension >::ImportImageFilter ( const ImportImageFilter< TPixel, VImageDimension > &  ) [private]

Member Function Documentation

template<typename TPixel , unsigned int VImageDimension = 2>
virtual::itk::LightObject::Pointer itk::ImportImageFilter< TPixel, VImageDimension >::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<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>
virtual const DirectionType& itk::ImportImageFilter< TPixel, VImageDimension >::GetDirection ( ) [virtual]

Get the direction of the image

See also:
SetDirection
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 OriginType& itk::ImportImageFilter< TPixel, VImageDimension >::GetOrigin ( ) [virtual]

Set the origin of the image.

See also:
GetOrigin()
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 102 of file itkImportImageFilter.h.

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

Set the spacing (size of a pixel) of the image.

See also:
GetSpacing()
template<typename TPixel , unsigned int VImageDimension = 2>
static 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 >::operator= ( const ImportImageFilter< TPixel, VImageDimension > &  ) [private]
template<typename TPixel , unsigned int VImageDimension = 2>
void itk::ImportImageFilter< TPixel, VImageDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Get the direction of the image

See also:
SetDirection

Reimplemented from itk::ProcessObject.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetDirection ( const DirectionType  direction) [virtual]

Set the direction of the image

See also:
GetDirection()
template<typename TPixel , unsigned int VImageDimension = 2>
void itk::ImportImageFilter< TPixel, VImageDimension >::SetImportPointer ( TPixel *  ptr,
SizeValueType  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>
virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetOrigin ( OriginType  _arg) [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 float  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 95 of file itkImportImageFilter.h.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::ImportImageFilter< TPixel, VImageDimension >::SetSpacing ( SpacingType  _arg) [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 float  data[]) [virtual]

Set the spacing (size of a pixel) of the image.

See also:
GetSpacing()

Member Data Documentation

template<typename TPixel , unsigned int VImageDimension = 2>
DirectionType itk::ImportImageFilter< TPixel, VImageDimension >::m_Direction [private]

Definition at line 159 of file itkImportImageFilter.h.

template<typename TPixel , unsigned int VImageDimension = 2>
bool itk::ImportImageFilter< TPixel, VImageDimension >::m_FilterManageMemory [private]

Definition at line 162 of file itkImportImageFilter.h.

template<typename TPixel , unsigned int VImageDimension = 2>
TPixel* itk::ImportImageFilter< TPixel, VImageDimension >::m_ImportPointer [private]

Definition at line 161 of file itkImportImageFilter.h.

template<typename TPixel , unsigned int VImageDimension = 2>
OriginType itk::ImportImageFilter< TPixel, VImageDimension >::m_Origin [private]

Definition at line 158 of file itkImportImageFilter.h.

template<typename TPixel , unsigned int VImageDimension = 2>
RegionType itk::ImportImageFilter< TPixel, VImageDimension >::m_Region [private]

Definition at line 156 of file itkImportImageFilter.h.

template<typename TPixel , unsigned int VImageDimension = 2>
SizeValueType itk::ImportImageFilter< TPixel, VImageDimension >::m_Size [private]

Definition at line 163 of file itkImportImageFilter.h.

template<typename TPixel , unsigned int VImageDimension = 2>
SpacingType itk::ImportImageFilter< TPixel, VImageDimension >::m_Spacing [private]

Definition at line 157 of file itkImportImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 00:34:55 for ITK by doxygen 1.7.6.1