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
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkNumericSeriesFileNames.h
Language: C++
Date: $Date$
Version: $Revision$
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 __itkNumericSeriesFileNames_h
#define __itkNumericSeriesFileNames_h
#ifdef _MSC_VER
#pragma warning ( disable : 4786 )
#endif
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkExceptionObject.h"
#include <vector>
namespace itk
{
/** \class NumericSeriesFileNames
* \brief Generate an ordered sequence of filenames.
*
* This class generate an ordered sequence of files whose filenames
* contain a single unique, non-negative, integral value
* (e.g. test.1.png, test2.png, foo.3, etc.).
*
* The file name is created from a sprintf-style series format which
* should contain an integer format string like "%d". Bad formats will
* cause the series reader to throw an exception.
*
* \ingroup IOFilters
*
*/
class ITK_EXPORT NumericSeriesFileNames : public Object
{
public:
/** Standard class typedefs. */
typedef NumericSeriesFileNames Self;
typedef Object Superclass;
typedef SmartPointer<Self> Pointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(NumericSeriesFileNames, Object);
/* -------- Define the API for NumericSeriesFileNames ----------- */
/** Use this method to set the starting index of the numeric series.
* The default value is 1. */
itkSetMacro(StartIndex,unsigned long);
itkGetConstMacro(StartIndex,unsigned long);
/** Set the end index of the numeric series. The default is 1. */
itkSetMacro(EndIndex,unsigned long);
itkGetConstMacro(EndIndex,unsigned long);
/** Set the increment of the index of the numeric series. The
* default value is 1. */
itkSetMacro(IncrementIndex,unsigned long);
itkGetConstMacro(IncrementIndex,unsigned long);
/** The format string used to generate the series. Different subclasses
* require different characteristics of this string. For example, the
* subclass NumericSeriesFileNames requires a "%d" or some integral
* format specified to be embedded in the string. Default is "%d". */
itkSetStringMacro(SeriesFormat);
itkGetStringMacro(SeriesFormat);
/** Returns a vector containing the series' file names. The file
* names are ordered by Index. */
const std::vector<std::string> &GetFileNames ();
protected:
NumericSeriesFileNames();
~NumericSeriesFileNames() {};
void PrintSelf(std::ostream& os, Indent indent) const;
private:
NumericSeriesFileNames(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
unsigned long m_StartIndex;
unsigned long m_EndIndex;
unsigned long m_IncrementIndex;
/** A string for formatting the names of files in the series. */
std::string m_SeriesFormat;
std::vector<std::string> m_FileNames;
};
} //namespace ITK
#endif // __itkNumericSeriesFileNames_h
|
