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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkNumericSeriesFileNames_h
#define itkNumericSeriesFileNames_h
#include "ITKIOImageBaseExport.h"
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkIntTypes.h"
#include "itkMacro.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 snprintf-style series format which
* should contain an integer format string like "%d". Bad formats will
* cause the series reader to throw an exception.
*
* Warning: returned filenames (which may be full or relative paths)
* are not checked against any system-imposed path-length limit, because
* of difficulties finding a portable method to do so.
*
* \ingroup IOFilters
*
* \ingroup ITKIOImageBase
*
* \sphinx
* \sphinxexample{IO/ImageBase/CreateAListOfFileNames,Create A List Of File Names}
* \endsphinx
*/
class ITKIOImageBase_EXPORT NumericSeriesFileNames : public Object
{
public:
ITK_DISALLOW_COPY_AND_MOVE(NumericSeriesFileNames);
/** Standard class type aliases. */
using Self = NumericSeriesFileNames;
using Superclass = Object;
using Pointer = SmartPointer<Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(NumericSeriesFileNames);
/* -------- Define the API for NumericSeriesFileNames ----------- */
/** Use this method to set the starting index of the numeric series.
* The default value is 1. */
itkSetMacro(StartIndex, SizeValueType);
itkGetConstMacro(StartIndex, SizeValueType);
/** Set the end index of the numeric series. The default is 1. */
itkSetMacro(EndIndex, SizeValueType);
itkGetConstMacro(EndIndex, SizeValueType);
/** Set the increment of the index of the numeric series. The
* default value is 1. */
itkSetMacro(IncrementIndex, SizeValueType);
itkGetConstMacro(IncrementIndex, SizeValueType);
/** 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() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
private:
SizeValueType m_StartIndex{ 1 };
SizeValueType m_EndIndex{ 1 };
SizeValueType m_IncrementIndex{ 1 };
/** 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
|
