Main Page
Groups
Namespace List
Class Hierarchy
Alphabetical List
Compound List
File
List
Namespace Members
Compound Members
File Members
Concepts
itk::ImageSeriesWriter< TInputImage > Class Template Reference
[Input and Output Filters]
Writes image data to a series of data files.
More...
#include <itkImageSeriesWriter.h>
Inheritance diagram for itk::ImageSeriesWriter< TInputImage >:
[legend]Collaboration diagram for itk::ImageSeriesWriter< TInputImage >:
[legend]List of all members.
Detailed Description
template<class TInputImage>
class itk::ImageSeriesWriter< TInputImage >
Writes image data to a series of data files.
ImageSeriesWriter writes its input data to a series of output files. ImageSeriesWriter interfaces with the classes ImageIOBase and FileIteratorBase to write out the data. If you wish to write data into a single file, ImageFileWriter is easier to use.
A pluggable factory pattern is used that allows different file formats to be written (even at run time) without having to modify the code in this class. You can either manually instantiate the ImageIO object and associate it with the ImageSeriesWriter, or create a FileIteratorBase subclass and set the SeriesFormat with a suitable suffix (".png", ".jpg", etc). Of course the input to the to the writer must be set as well.
Note: the name of the output files is controlled by a subclass of FileIteratorBase. If an ImageIO is set, it will produce a file iterator. However, the FileIterator can be manually set to control how the files are named. If an ImageIO is not set, but a file iterator is set, then the appropriate ImageIO (if possible) is determined from the SeriesFormat ivar of the FileIterator.
- See also:
- ImageFileWriter
ImageIOBase
FileIteratorBase
ImageSeriesReader
Definition at line 87 of file itkImageSeriesWriter.h.
Member Typedef Documentation
Constructor & Destructor Documentation
Member Function Documentation
|
template<class TInputImage> |
| void itk::ImageSeriesWriter< TInputImage >::GenerateData |
( |
void |
|
) |
[protected, virtual] |
|
|
template<class TInputImage> |
| virtual const char* itk::ImageSeriesWriter< TInputImage >::GetClassName |
( |
|
) |
const [virtual] |
|
|
|
The naming of the output files is controlled by using a subclass of FileIteratorBase (e.g., NumericSeriesFileIterator). |
|
|
Set/Get the ImageIO helper class. Usually this is created via the object factory mechanism that determines whether a particular ImageIO can write a certain file. This method provides a way to get the ImageIO instance that is created, or to manually set one when the factory mechanism may not work (e.g., for raw files or for non-standard file suffix). |
|
|
Set/Get the image input of this writer. |
|
|
Specify the region to write. If left NULL, then the whole image is written. (Left protected for now to insure that the user doesn't try to use writing of partial images just yet since it's really not working at this time.) |
|
|
Method for creation through the object factory.
Reimplemented from itk::Object.
|
|
template<class TInputImage> |
| void itk::ImageSeriesWriter< 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::ProcessObject.
|
|
|
The naming of the output files is controlled by using a subclass of FileIteratorBase (e.g., NumericSeriesFileIterator). |
|
|
Set/Get the ImageIO helper class. Usually this is created via the object factory mechanism that determines whether a particular ImageIO can write a certain file. This method provides a way to get the ImageIO instance that is created, or to manually set one when the factory mechanism may not work (e.g., for raw files or for non-standard file suffix). |
|
|
Set/Get the image input of this writer. |
|
|
Specify the region to write. If left NULL, then the whole image is written. (Left protected for now to insure that the user doesn't try to use writing of partial images just yet since it's really not working at this time.) |
|
template<class TInputImage> |
| virtual void itk::ImageSeriesWriter< TInputImage >::Update |
( |
void |
|
) |
[inline, virtual] |
|
|
|
A special version of the Update() method for writers. It invokes start and end events and handles releasing data. It eventually calls GenerateData() which does the actual writing. Note: the write method will write data specified by the IORegion. If not set, then then the whole image is written. Note that the region will be cropped to fit the input image's LargestPossibleRegion. |
Member Data Documentation
The documentation for this class was generated from the following file:
Generated at Sat Mar 31 03:02:17 2007 for ITK by 
1.3.8 written by Dimitri van Heesch,
© 1997-2000