Main Page
Groups
Namespace List
Class Hierarchy
Alphabetical List
Compound List
File
List
Namespace Members
Compound Members
File Members
Concepts
itk::ImageSeriesWriter< TInputImage, TOutputImage > 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, TOutputImage >:
[legend]Collaboration diagram for itk::ImageSeriesWriter< TInputImage, TOutputImage >:
[legend]List of all members.
Detailed Description
template<class TInputImage, class TOutputImage>
class itk::ImageSeriesWriter< TInputImage, TOutputImage >
Writes image data to a series of data files.
ImageSeriesWriter writes its input data to a series of output files. The writer is templated over an input image type and an output image type. Usually, the output image type will have fewer dimensions than the input image type. Each file has a name created using the SeriesFormat. This string is used as a sprintf argument to build a filename. The string should contain zero or one "%d" or equivalent. The "%d" is an incremental file number that starts at StartIndex and is incremented by IncrementIndex. Since this writer uses an internal instance of an ImageFileWriter, the type of file is determined by either the file extension or an ImageIO class if specified.
- See also:
- ImageFileWriter
ImageIOBase
ImageSeriesReader
Definition at line 77 of file itkImageSeriesWriter.h.
Member Typedef Documentation
Constructor & Destructor Documentation
Member Function Documentation
|
template<class TInputImage, class TOutputImage> |
| void itk::ImageSeriesWriter< TInputImage, TOutputImage >::GenerateData |
( |
void |
|
) |
[protected, virtual] |
|
|
template<class TInputImage, class TOutputImage> |
| virtual const char* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetClassName |
( |
|
) |
const [virtual] |
|
|
|
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). |
|
template<class TInputImage, class TOutputImage> |
| virtual unsigned long itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetIncrementIndex |
( |
|
) |
[virtual] |
|
|
|
Set the increment of the index of the series. The default value is 1. |
|
|
Set/Get the image input of this writer. |
|
template<class TInputImage, class TOutputImage> |
| virtual const char* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetSeriesFormat |
( |
|
) |
const [virtual] |
|
|
|
The format string used to generate each filename in the series. The filename is built with sprintf(filename, SeriesFormat, number) where number starts at StartIndex and is incremented by IncrementIndex. |
|
template<class TInputImage, class TOutputImage> |
| virtual unsigned long itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetStartIndex |
( |
|
) |
[virtual] |
|
|
|
Use this method to set the starting index of the series. The default value is 1. |
|
|
Method for creation through the object factory.
Reimplemented from itk::Object.
|
|
template<class TInputImage, class TOutputImage> |
| void itk::ImageSeriesWriter< TInputImage, TOutputImage >::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.
|
|
|
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). |
|
template<class TInputImage, class TOutputImage> |
| virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetIncrementIndex |
( |
unsigned long |
_arg |
) |
[virtual] |
|
|
|
Set the increment of the index of the series. The default value is 1. |
|
|
Set/Get the image input of this writer. |
|
template<class TInputImage, class TOutputImage> |
| virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetSeriesFormat |
( |
const char * |
_arg |
) |
[virtual] |
|
|
|
The format string used to generate each filename in the series. The filename is built with sprintf(filename, SeriesFormat, number) where number starts at StartIndex and is incremented by IncrementIndex. |
|
template<class TInputImage, class TOutputImage> |
| virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetStartIndex |
( |
unsigned long |
_arg |
) |
[virtual] |
|
|
|
Use this method to set the starting index of the series. The default value is 1. |
|
template<class TInputImage, class TOutputImage> |
| virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::Update |
( |
void |
|
) |
[inline, virtual] |
|
|
template<class TInputImage, class TOutputImage> |
| virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::Write |
( |
void |
|
) |
[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. The whole image is written. |
Member Data Documentation
The documentation for this class was generated from the following file:
Generated at Sun Apr 1 03:14:54 2007 for ITK by 
1.3.8 written by Dimitri van Heesch,
© 1997-2000