Main Page
Groups
Namespace List
Class Hierarchy
Alphabetical List
Compound List
File
List
Namespace Members
Compound Members
File Members
Concepts
itk::ImageFileReader< TOutputImage, ConvertPixelTraits > Class Template Reference
[Input and Output Filters]
Data source that reads image data from disk files.
More...
#include <itkImageFileReader.h>
Inheritance diagram for itk::ImageFileReader:
[legend]Collaboration diagram for itk::ImageFileReader< TOutputImage, ConvertPixelTraits >:
[legend]List of all members.
Detailed Description
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>>
class itk::ImageFileReader< TOutputImage, ConvertPixelTraits >
Data source that reads image data from disk files.
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.
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.
Definition at line 80 of file itkImageFileReader.h.
Member Typedef Documentation
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| typedef TOutputImage::RegionType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageRegionType
|
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| typedef TOutputImage::PixelType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::OutputImagePixelType
|
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| typedef SmartPointer<Self> itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::Pointer
|
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| typedef ImageFileReader itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::Self
|
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| typedef TOutputImage::SizeType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SizeType
|
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| typedef ImageSource<TOutputImage> itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::Superclass
|
|
Constructor & Destructor Documentation
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageFileReader |
( |
|
) |
[protected] |
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::~ImageFileReader |
( |
|
) |
[protected] |
|
Member Function Documentation
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::DoConvertBuffer |
( |
void * |
buffer, |
|
|
unsigned long |
numberOfPixels |
|
) |
[protected] |
|
|
|
Convert a block of pixels from one type to another. |
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| 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::PixelType>> |
| virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GenerateData |
( |
|
) |
[protected, virtual] |
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| 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::PixelType>> |
| virtual const char* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetClassName |
( |
|
) |
const [virtual] |
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| virtual const char* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetFileName |
( |
|
) |
const [virtual] |
|
|
|
Specify the file to load. This is forwarded to the IO instance. Either the FileName or FilePrefix plus pattern are used to read files. |
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| virtual const char* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetFilePattern |
( |
|
) |
const [virtual] |
|
|
|
The sprintf format used to build filename from FilePrefix and number. |
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| virtual const char* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetFilePrefix |
( |
|
) |
const [virtual] |
|
|
|
Specify file prefix for the image file(s). You should specify either a FileName or FilePrefix. Use FilePrefix if the data is stored in multiple files. |
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| virtual ImageIOBase* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetImageIO |
( |
|
) |
[virtual] |
|
|
|
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. |
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| Pointer itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::New |
( |
|
) |
[static] |
|
|
|
Method for creation through the object factory.
Reimplemented from itk::Object. |
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::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<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetFileName |
( |
const char * |
_arg |
) |
[virtual] |
|
|
|
Specify the file to load. This is forwarded to the IO instance. Either the FileName or FilePrefix plus pattern are used to read files. |
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetFilePattern |
( |
const char * |
_arg |
) |
[virtual] |
|
|
|
The sprintf format used to build filename from FilePrefix and number. |
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetFilePrefix |
( |
const char * |
_arg |
) |
[virtual] |
|
|
|
Specify file prefix for the image file(s). You should specify either a FileName or FilePrefix. Use FilePrefix if the data is stored in multiple files. |
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
| 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. |
Member Data Documentation
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
std::string itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_FileName [protected]
|
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
std::string itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_FilePattern [protected]
|
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
std::string itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_FilePrefix [protected]
|
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
ImageIOBase::Pointer itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_ImageIO [protected]
|
|
|
template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::PixelType>> |
bool itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_UserSpecifiedImageIO [protected]
|
|
The documentation for this class was generated from the following file:
Generated at Fri May 21 01:20:07 2004 for ITK by
1.2.15 written by Dimitri van Heesch,
© 1997-2000