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
|
/*=========================================================================
*
* Copyright UMC Utrecht and contributors
*
* 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
*
* http://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 itkParameterFileParser_h
#define itkParameterFileParser_h
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkMacro.h"
#include <map>
#include <string>
#include <vector>
namespace itk
{
/** \class ParameterFileParser
*
* \brief Implements functionality to read a parameter file.
*
* A parameter file is a text file that contains parameters and their values.
* Parameters should be specified obeying certain rules.\n
* 1) A single parameter should be on a single line\n
* 2) A parameter should be specified between brackets: (...)\n
* 3) Parameters are specified by a single name, followed by one or more
* values, all separated by spaces\n
* 4) Values that are strings should be quoted using "\n
* 5) Values that are numbers should be unquoted\n
*
* For example: \n
* (ParameterName1 "string1" "string2")\n
* (ParameterName2 3 5.8)\n
* (ParameterName3 "true" "false" "true")\n
*
* The parameter file is read, and parameter name-value combinations are
* stored in an std::map< std::string, std::vector<std:string> >, where the
* string is the parameter name, and the vector of strings are the values.
* Exceptions are raised in case:\n
* - the parameter text file cannot be opened,\n
* - rule 2 or 3 is not satisfied,\n
* - the parameter name or value contains invalid characters.\n
*
* Here is an example on how to use this class:\n
*
* itk::ParameterFileParser::Pointer parser = itk::ParameterFileParser::New();
* parser->SetParameterFileName( parameterFileName );
* try
* {
* parser->Initialize();
* }
* catch ( itk::ExceptionObject & e )
* {
* ...
* }
*
* The resulting map can be accessed via:\n
*
* parser->GetParameterMap();
*
* \sa itk::ParameterMapInterface
*/
class ParameterFileParser : public Object
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ParameterFileParser);
/** Standard ITK typedefs. */
using Self = ParameterFileParser;
using Superclass = Object;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(ParameterFileParser, Object);
/** Typedefs. */
using ParameterValuesType = std::vector<std::string>;
using ParameterMapType = std::map<std::string, ParameterValuesType>;
/** Set the name of the file containing the parameters. */
itkSetStringMacro(ParameterFileName);
itkGetStringMacro(ParameterFileName);
/** Return the parameter map. */
const ParameterMapType &
GetParameterMap() const;
/** Read the parameters in the parameter map. */
void
ReadParameterFile();
/** Read the parameter file and return the content as a string.
* Useful for printing the content.
*/
std::string
ReturnParameterFileAsString();
/** Read the specified file into a parameter map and return the map. */
static ParameterMapType
ReadParameterMap(const std::string & fileName);
/** Converts the specified text string to the corresponding parameter map, assuming that the text is formatted
* according to the elastix parameter text file format. */
static ParameterMapType
ConvertToParameterMap(const std::string & text);
protected:
ParameterFileParser();
~ParameterFileParser() override;
private:
/** Member variables. */
std::string m_ParameterFileName{};
ParameterMapType m_ParameterMap{};
};
} // end of namespace itk
#endif // end itkParameterFileParser_h
|
