ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageSeriesWriter.h>
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.
Definition at line 82 of file itkImageSeriesWriter.h.
Static Public Member Functions | |
static Pointer | New () |
Protected Attributes | |
ImageIOBase::Pointer | m_ImageIO |
bool | m_UserSpecifiedImageIO |
Protected Attributes inherited from itk::ProcessObject | |
TimeStamp | m_OutputInformationMTime |
bool | m_Updating |
Private Member Functions | |
void | GenerateNumericFileNames (void) |
ImageSeriesWriter (const Self &) | |
void | operator= (const Self &) |
void | WriteFiles () |
Private Attributes | |
FileNamesContainer | m_FileNames |
SizeValueType | m_IncrementIndex |
DictionaryArrayRawPointer | m_MetaDataDictionaryArray |
std::string | m_SeriesFormat |
SizeValueType | m_StartIndex |
bool | m_UseCompression |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
typedef SmartPointer< const Self > itk::ImageSeriesWriter< TInputImage, TOutputImage >::ConstPointer |
Definition at line 89 of file itkImageSeriesWriter.h.
typedef const DictionaryArrayType* itk::ImageSeriesWriter< TInputImage, TOutputImage >::DictionaryArrayRawPointer |
Definition at line 109 of file itkImageSeriesWriter.h.
typedef std::vector< DictionaryRawPointer > itk::ImageSeriesWriter< TInputImage, TOutputImage >::DictionaryArrayType |
Definition at line 108 of file itkImageSeriesWriter.h.
typedef MetaDataDictionary* itk::ImageSeriesWriter< TInputImage, TOutputImage >::DictionaryRawPointer |
Definition at line 107 of file itkImageSeriesWriter.h.
typedef MetaDataDictionary itk::ImageSeriesWriter< TInputImage, TOutputImage >::DictionaryType |
The pixel type of the output image.
Definition at line 106 of file itkImageSeriesWriter.h.
typedef std::vector< std::string > itk::ImageSeriesWriter< TInputImage, TOutputImage >::FileNamesContainer |
Definition at line 103 of file itkImageSeriesWriter.h.
typedef InputImageType::RegionType itk::ImageSeriesWriter< TInputImage, TOutputImage >::InputImageRegionType |
Definition at line 99 of file itkImageSeriesWriter.h.
typedef TInputImage itk::ImageSeriesWriter< TInputImage, TOutputImage >::InputImageType |
Some convenient typedefs.
Definition at line 95 of file itkImageSeriesWriter.h.
typedef OutputImageType::RegionType itk::ImageSeriesWriter< TInputImage, TOutputImage >::OutputImageRegionType |
Definition at line 101 of file itkImageSeriesWriter.h.
typedef TOutputImage itk::ImageSeriesWriter< TInputImage, TOutputImage >::OutputImageType |
Definition at line 100 of file itkImageSeriesWriter.h.
typedef SmartPointer< Self > itk::ImageSeriesWriter< TInputImage, TOutputImage >::Pointer |
Definition at line 88 of file itkImageSeriesWriter.h.
typedef ImageSeriesWriter itk::ImageSeriesWriter< TInputImage, TOutputImage >::Self |
Standard class typedefs.
Definition at line 86 of file itkImageSeriesWriter.h.
typedef ProcessObject itk::ImageSeriesWriter< TInputImage, TOutputImage >::Superclass |
Definition at line 87 of file itkImageSeriesWriter.h.
typedef ImageFileWriter< TOutputImage > itk::ImageSeriesWriter< TInputImage, TOutputImage >::WriterType |
Definition at line 102 of file itkImageSeriesWriter.h.
|
protected |
|
protected |
|
private |
|
inline |
Add a single filename to the list of files. To add a vector of filenames, use the AddFileNames method.
Definition at line 191 of file itkImageSeriesWriter.h.
|
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.
|
protectedvirtual |
Does the real work.
Reimplemented from itk::ProcessObject.
|
private |
|
protected |
Transition method used for DEPRECATING old functionality. This method should be removed after release ITK 1.8
|
inline |
Definition at line 174 of file itkImageSeriesWriter.h.
|
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).
|
virtual |
Set the increment of the index of the series. The default value is 1.
const InputImageType* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetInput | ( | void | ) |
const InputImageType* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetInput | ( | unsigned int | idx | ) |
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ProcessObject.
|
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.
|
virtual |
Use this method to set the starting index of the series. The default value is 1.
|
virtual |
Set the compression On or Off
|
static |
Method for creation through the object factory.
|
private |
|
protectedvirtual |
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.
|
inline |
Set the first file name to be processed. This deletes previous filenames.
Definition at line 181 of file itkImageSeriesWriter.h.
|
inline |
Set/Get the vector of strings that contains the file names. Files are processed in sequential order.
Definition at line 164 of file itkImageSeriesWriter.h.
|
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).
|
virtual |
Set the increment of the index of the series. The default value is 1.
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetInput | ( | const InputImageType * | input | ) |
|
virtual |
Set the array of MetaDataDictionaries this is an optinal entry, mostly intended to be used when writing DICOM slices.
|
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.
|
virtual |
Use this method to set the starting index of the series. The default value is 1.
|
virtual |
Set the compression On or Off
|
inlinevirtual |
Aliased to the Write() method to be consistent with the rest of the pipeline.
Reimplemented from itk::ProcessObject.
Definition at line 137 of file itkImageSeriesWriter.h.
|
virtual |
Set the compression On or Off
|
virtual |
Set the compression On or Off
|
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.
|
private |
|
private |
A list of filenames to be processed.
Definition at line 230 of file itkImageSeriesWriter.h.
|
protected |
Definition at line 220 of file itkImageSeriesWriter.h.
|
private |
Definition at line 239 of file itkImageSeriesWriter.h.
|
private |
Array of MetaDataDictionary used for passing information to each slice
Definition at line 244 of file itkImageSeriesWriter.h.
|
private |
These variables are used for generating filenames using a numeric approach This functionality is being DEPRECATED since it belongs to a NumericSeriesFileNames class. Removing this functionality from here allows to use additional SeriesFileNames such as the DICOM filenames generators.
Definition at line 237 of file itkImageSeriesWriter.h.
|
private |
Definition at line 238 of file itkImageSeriesWriter.h.
|
private |
Definition at line 241 of file itkImageSeriesWriter.h.
|
protected |
Definition at line 223 of file itkImageSeriesWriter.h.