ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
itk::ImageFileReader< TOutputImage, ConvertPixelTraits > Class Template Reference

Data source that reads image data from a single file. More...

#include <itkImageFileReader.h>

Inheritance diagram for itk::ImageFileReader< TOutputImage, ConvertPixelTraits >:
Collaboration diagram for itk::ImageFileReader< TOutputImage, ConvertPixelTraits >:

List of all members.

Public Types

typedef TOutputImage::RegionType ImageRegionType
typedef TOutputImage::IndexType IndexType
typedef
TOutputImage::InternalPixelType 
OutputImagePixelType
typedef SmartPointer< SelfPointer
typedef ImageFileReader Self
typedef TOutputImage::SizeType SizeType
typedef ImageSource< TOutputImage > Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void EnlargeOutputRequestedRegion (DataObject *output)
virtual void GenerateOutputInformation (void)
virtual ImageIOBaseGetImageIO ()
virtual const char * GetNameOfClass () const
 itkSetGetDecoratedInputMacro (FileName, std::string)
void SetImageIO (ImageIOBase *imageIO)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

void DoConvertBuffer (void *buffer, vcl_size_t numberOfPixels)
virtual void GenerateData ()
void TestFileExistanceAndReadability ()

Protected Attributes

ImageIOBase::Pointer m_ImageIO
bool m_UserSpecifiedImageIO
bool m_UseStreaming

Private Member Functions

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

Private Attributes

ImageIORegion m_ActualIORegion
std::string m_ExceptionMessage
virtual void SetUseStreaming (bool _arg)
virtual const bool & GetUseStreaming ()
virtual void UseStreamingOn ()
virtual void UseStreamingOff ()
 ImageFileReader ()
 ~ImageFileReader ()
void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
class itk::ImageFileReader< TOutputImage, ConvertPixelTraits >

Data source that reads image data from a single file.

This source object is a general filter to read data from a variety of file formats. It works with a ImageIOBase subclass to actually do the reading of the data. Object factory machinery can be used to automatically create the ImageIOBase, or the ImageIOBase can be manually created and set. Note that this class reads data from a single file; if you wish to read data from a series of files use ImageSeriesReader.

TOutputImage is the type expected by the external users of the filter. If data stored in the file is stored in a different format then specified by TOutputImage, than this filter converts data between the file type and the external expected type. The ConvertTraits template argument is used to do the conversion.

A Pluggable factory pattern is used this allows different kinds of readers to be registered (even at run time) without having to modify the code in this class. Normally just setting the FileName with the appropriate suffix is enough to get the reader to instantiate the correct ImageIO and read the file properly. However, some files (like raw binary format) have no accepted suffix, so you will have to manually create the ImageIO instance of the write type.

See also:
ImageSeriesReader
ImageIOBase
Wiki Examples:
Examples:

Image2.cxx, ImageLinearIteratorWithIndex.cxx, ImageRegionIterator.cxx, ImageRegionIteratorWithIndex.cxx, itkVectorImageTest.cxx, and RGBImage.cxx.

Definition at line 99 of file itkImageFileReader.h.


Member Typedef Documentation

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef TOutputImage::RegionType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageRegionType

The region of the output image.

Definition at line 120 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef TOutputImage::IndexType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::IndexType

The size of the output image.

Definition at line 117 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef TOutputImage::InternalPixelType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::OutputImagePixelType

The pixel type of the output image.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 123 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef SmartPointer< Self > itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::Pointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 105 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef ImageFileReader itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::Self

Standard class typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 103 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef TOutputImage::SizeType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SizeType

The size of the output image.

Definition at line 111 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef ImageSource< TOutputImage > itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::Superclass

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 104 of file itkImageFileReader.h.


Constructor & Destructor Documentation

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageFileReader ( ) [protected]

Set the stream On or Off

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::~ImageFileReader ( ) [protected]

Set the stream On or Off

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageFileReader ( const Self ) [private]

Member Function Documentation

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual::itk::LightObject::Pointer itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::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 TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::DoConvertBuffer ( void *  buffer,
vcl_size_t  numberOfPixels 
) [protected]

Convert a block of pixels from one type to another.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::EnlargeOutputRequestedRegion ( DataObject output) [virtual]

Give the reader a chance to indicate that it will produce more output than it was requested to produce. ImageFileReader cannot currently read a portion of an image (since the ImageIO objects cannot read a portion of an image), so the ImageFileReader must enlarge the RequestedRegion to the size of the image on disk.

Reimplemented from itk::ProcessObject.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GenerateData ( ) [protected, virtual]

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GenerateOutputInformation ( void  ) [virtual]

Prepare the allocation of the output image during the first back propagation of the pipeline.

Reimplemented from itk::ProcessObject.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual ImageIOBase* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetImageIO ( ) [virtual]
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual const char* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual const bool& itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetUseStreaming ( ) [virtual]

Set the stream On or Off

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::itkSetGetDecoratedInputMacro ( FileName  ,
std::string   
)

Specify the file to read. This is forwarded to the IO instance.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
static Pointer itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

Examples:
Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx.
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::operator= ( const Self ) [private]

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Set the stream On or Off

Reimplemented from itk::ProcessObject.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetImageIO ( ImageIOBase imageIO)

Set/Get the ImageIO helper class. Often this is created via the object factory mechanism that determines whether a particular ImageIO can read a certain file. This method provides a way to get the ImageIO instance that is created. Or you can directly specify the ImageIO to use to read a particular file in case the factory mechanism will not work properly (e.g., unknown or unusual extension).

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetUseStreaming ( bool  _arg) [virtual]

Set the stream On or Off

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::TestFileExistanceAndReadability ( ) [protected]

Test whether the given filename exist and it is readable, this is intended to be called before attempting to use ImageIO classes for actually reading the file. If the file doesn't exist or it is not readable, and exception with an approriate message will be thrown.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::UseStreamingOff ( ) [virtual]

Set the stream On or Off

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::UseStreamingOn ( ) [virtual]

Set the stream On or Off


Member Data Documentation

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
ImageIORegion itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_ActualIORegion [private]

Definition at line 186 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
std::string itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_ExceptionMessage [private]

Definition at line 182 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
ImageIOBase::Pointer itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_ImageIO [protected]

Definition at line 172 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
bool itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_UserSpecifiedImageIO [protected]

Definition at line 174 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
bool itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_UseStreaming [protected]

Definition at line 177 of file itkImageFileReader.h.


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