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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
|
/*
* Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
*
* This file is part of Orfeo Toolbox
*
* https://www.orfeo-toolbox.org/
*
* 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
*
* 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 otbWrapperNumericalParameter_h
#define otbWrapperNumericalParameter_h
#include "otbWrapperParameter.h"
#include "itkNumericTraits.h"
#include <boost/optional.hpp>
namespace otb
{
namespace Wrapper
{
/** \class NumericalParameter
* \brief This class represents a numerical parameter
*
* \ingroup OTBApplicationEngine
*/
template <class T>
class ITK_ABI_EXPORT NumericalParameter : public Parameter
{
public:
/** Standard class typedef */
typedef NumericalParameter Self;
typedef Parameter Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
/** Typedef of the scalar type */
typedef T ScalarType;
/** Implement the reset method (replace value by default value) */
void Reset() override
{
m_Value = m_DefaultValue;
}
/** Set the value */
void SetValue(ScalarType value)
{
m_Value = (value < m_MinimumValue) ? m_MinimumValue : (value < m_MaximumValue) ? value : m_MaximumValue;
// Set Active only if the parameter is not automatically set
if (!GetAutomaticValue())
{
SetActive(true);
}
}
void SetValue(const std::string& valueStr)
{
ScalarType value = static_cast<ScalarType>(atof(valueStr.c_str()));
SetValue(value);
}
ScalarType GetValue() const
{
if (!HasValue())
{
itkGenericExceptionMacro(<< "Parameter " << this->GetKey() << " has no value yet.");
}
return static_cast<ScalarType>(*m_Value);
}
bool HasValue() const override
{
return m_Value != boost::none;
}
void ClearValue() override
{
m_Value.reset();
}
/** Set the default value */
itkSetMacro(DefaultValue, ScalarType);
/** Get the default value */
itkGetMacro(DefaultValue, ScalarType);
/** Set the minimum value */
itkSetMacro(MinimumValue, ScalarType);
/** Get the minimum value */
itkGetMacro(MinimumValue, ScalarType);
/** Set the maximum value */
itkSetMacro(MaximumValue, ScalarType);
/** Get the maximum value */
itkGetMacro(MaximumValue, ScalarType);
// TODO move to hxx
int ToInt() const override
{
if (!HasValue())
{
itkExceptionMacro("Cannot convert parameter " << GetKey() << " to int (no value).");
}
return static_cast<int>(*m_Value);
}
float ToFloat() const override
{
if (!HasValue())
{
itkExceptionMacro("Cannot convert parameter " << GetKey() << " to float (no value).");
}
return static_cast<float>(*m_Value);
}
double ToDouble() const override
{
if (!HasValue())
{
itkExceptionMacro("Cannot convert parameter " << GetKey() << " to double (no value).");
}
return static_cast<double>(*m_Value);
}
void FromInt(int value) override
{
SetValue(value);
}
void FromString(const std::string& value) override
{
SetValue(value);
}
std::string ToString() const override
{
std::ostringstream oss;
oss << this->GetValue();
return oss.str();
}
protected:
/** Constructor */
NumericalParameter()
: m_DefaultValue(itk::NumericTraits<T>::Zero), m_MinimumValue(itk::NumericTraits<T>::NonpositiveMin()), m_MaximumValue(itk::NumericTraits<T>::max())
{
}
/** Destructor */
~NumericalParameter() override
{
}
/** Value */
boost::optional<T> m_Value;
/** Default value (when applicable) */
ScalarType m_DefaultValue;
/** Minimum value */
ScalarType m_MinimumValue;
/** Maximum value */
ScalarType m_MaximumValue;
private:
NumericalParameter(const Parameter&) = delete;
void operator=(const Parameter&) = delete;
}; // End class Numerical Parameter
class OTBApplicationEngine_EXPORT FloatParameter : public NumericalParameter<float>
{
public:
/** Standard class typedef */
typedef FloatParameter Self;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
itkNewMacro(Self);
itkTypeMacro(NumericalParameter, Parameter);
ParameterType GetType() const override
{
return ParameterType_Float;
}
void FromFloat(float value) override
{
SetValue(value);
}
};
class OTBApplicationEngine_EXPORT DoubleParameter : public NumericalParameter<double>
{
public:
/** Standard class typedef */
typedef DoubleParameter Self;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
itkNewMacro(Self);
itkTypeMacro(NumericalParameter, Parameter);
ParameterType GetType() const override
{
return ParameterType_Double;
}
void FromDouble(double value) override
{
SetValue(value);
}
};
class OTBApplicationEngine_EXPORT IntParameter : public NumericalParameter<int>
{
public:
/** Standard class typedef */
typedef IntParameter Self;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
itkNewMacro(Self);
itkTypeMacro(NumericalParameter, Parameter);
ParameterType GetType() const override
{
return ParameterType_Int;
}
};
class OTBApplicationEngine_EXPORT RAMParameter : public NumericalParameter<unsigned int>
{
public:
/** Standard class typedef */
typedef RAMParameter Self;
typedef Parameter Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
/** Defining ::New() static method */
itkNewMacro(Self);
/** RTTI support */
itkTypeMacro(RAMParameter, Parameter);
ParameterType GetType() const override
{
return ParameterType_RAM;
}
/** Constructor */
RAMParameter() : NumericalParameter<unsigned int>()
{
this->SetName("RAM");
this->SetDescription("Set the maximum of available memory for the pipeline execution in mega bytes (optional, 256 by default).");
this->SetKey("ram");
// 0 RAM is not allowed, make the minimum to 1 by default
this->SetMinimumValue(1);
}
};
class OTBApplicationEngine_EXPORT RadiusParameter : public IntParameter
{
public:
typedef RadiusParameter Self;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
itkNewMacro(Self);
itkTypeMacro(RadiusParameter, Parameter);
bool HasValue() const override
{
return true;
}
ParameterType GetType() const override
{
return ParameterType_Radius;
}
protected:
RadiusParameter()
{
this->SetName("Radius");
this->SetKey("r");
this->SetDescription("Radius in pixels");
}
};
} // End namespace Wrapper
} // End namespace otb
#endif
|