1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile: itkImageSeriesReader.h,v $
Language: C++
Date: $Date: 2007-08-24 13:35:59 $
Version: $Revision: 1.14 $
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkImageSeriesReader_h
#define __itkImageSeriesReader_h
#include "itkImageSource.h"
#include "itkImageIOBase.h"
#include "itkExceptionObject.h"
#include "itkSize.h"
#include "itkImageRegion.h"
#include <vector>
#include <string>
#include "itkMetaDataDictionary.h"
namespace itk
{
/** \brief Data source that reads image data from a series of disk files.
*
* This class builds an n-dimension image from multiple n-1
* dimension image files. The files stored in a vector of strings
* are read using the ImageFileReader. File format may vary between
* the files, but the image data must have the same Size for all
* dimensions.
*
* \sa GDCMSeriesFileNames
* \sa NumericSeriesFileNames
* \ingroup IOFilters
*
*/
template <class TOutputImage>
class ITK_EXPORT ImageSeriesReader : public ImageSource<TOutputImage>
{
public:
/** Standard class typedefs. */
typedef ImageSeriesReader Self;
typedef ImageSource<TOutputImage> Superclass;
typedef SmartPointer<Self> Pointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(ImageSeriesReader, ImageSource);
/** The size of the output image. */
typedef typename TOutputImage::SizeType SizeType;
/** The region of the output image. */
typedef typename TOutputImage::RegionType ImageRegionType;
/** The pixel type of the output image. */
typedef typename TOutputImage::PixelType OutputImagePixelType;
/** The pixel type of the output image. */
typedef MetaDataDictionary DictionaryType;
typedef MetaDataDictionary * DictionaryRawPointer;
typedef std::vector< DictionaryRawPointer > DictionaryArrayType;
typedef const DictionaryArrayType * DictionaryArrayRawPointer;
typedef std::vector<std::string> FileNamesContainer;
/** Set the vector of strings that contains the file names. Files
* are processed in sequential order. */
void SetFileNames (const FileNamesContainer &name)
{
if ( m_FileNames != name)
{
m_FileNames = name;
this->Modified();
}
}
const FileNamesContainer & GetFileNames() const
{
return m_FileNames;
}
/** Set the first file name to be processed. This deletes previous
* filenames. */
void SetFileName (std::string const &name)
{
m_FileNames.clear();
m_FileNames.push_back(name);
this->Modified();
}
/** Add a single filename to the list of files. To add a vector of
* filenames, use the AddFileNames method. */
void AddFileName (std::string const &name)
{
m_FileNames.push_back(name);
this->Modified();
}
/** ReverseOrderOn changes the order of travesal of the file names
* from last to first */
itkSetMacro(ReverseOrder,bool);
itkGetMacro(ReverseOrder,bool);
itkBooleanMacro(ReverseOrder);
/** Set/Get the ImageIO helper class. By default, the
* ImageSeriesReader uses the factory mechanism of the
* ImageFileReader to determine the file type. This method can be
* used to specify which IO to use. */
itkSetObjectMacro(ImageIO,ImageIOBase);
itkGetObjectMacro(ImageIO,ImageIOBase);
/** Prepare the allocation of the output image during the first back
* propagation of the pipeline. */
virtual void GenerateOutputInformation(void);
/** Give the reader a chance to indicate that it will produce more
* output than it was requested to produce. ImageSeriesReader cannot
* currently read a portion of an image (since the ImageIO objects
* cannot read a portion of an image), so the ImageSeriesReader must
* enlarge the RequestedRegion to the size of the image on disk. */
virtual void EnlargeOutputRequestedRegion(DataObject *output);
/** Get access to the Array of MetaDataDictionaries */
DictionaryArrayRawPointer GetMetaDataDictionaryArray() const;
protected:
ImageSeriesReader() : m_ImageIO(0), m_ReverseOrder(false) {};
~ImageSeriesReader();
void PrintSelf(std::ostream& os, Indent indent) const;
/** Does the real work. */
virtual void GenerateData();
/** The image format, 0 will use the factory mechnism. */
ImageIOBase::Pointer m_ImageIO;
/** Select the traversal order. */
bool m_ReverseOrder;
/** A list of filenames to be processed. */
FileNamesContainer m_FileNames;
/** The number of independent variables in the images that comprise
* the series. */
int m_NumberOfDimensionsInImage;
/** Array of MetaDataDictionaries. This allows to hold information from the
* ImageIO objects after reading every sub image in the series */
DictionaryArrayType m_MetaDataDictionaryArray;
private:
ImageSeriesReader(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
};
} //namespace ITK
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageSeriesReader.txx"
#endif
#endif // __itkImageSeriesReader_h
|
