Skip to content
GitLab
Select Git revision
  • zonalstats_histogram default
Find file BlameHistoryPermalink
otbConfigurationManager.h 3.55 KiB
1 
/*
2 
 * Copyright (C) 2005-2017 Centre National d'Etudes Spatiales (CNES)
3 
 *
4 
 * This file is part of Orfeo Toolbox
5 
 *
6 
 *     https://www.orfeo-toolbox.org/
7 
 *
8 
 * Licensed under the Apache License, Version 2.0 (the "License");
9 
 * you may not use this file except in compliance with the License.
10 
 * You may obtain a copy of the License at
11 
 *
12 
 *     http://www.apache.org/licenses/LICENSE-2.0
13 
 *
14 
 * Unless required by applicable law or agreed to in writing, software
15 
 * distributed under the License is distributed on an "AS IS" BASIS,
16 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 
 * See the License for the specific language governing permissions and
18 
 * limitations under the License.
19 
 */
20
21 
#ifndef _otbConfigurationManager_h
22 
#define _otbConfigurationManager_h
23
24 
#include "itkVersion.h"
25
26 
#if ITK_VERSION_MAJOR < 4 || (ITK_VERSION_MAJOR == 4 && ITK_VERSION_MINOR <= 8)
27 
#include "itksys/FundamentalType.h"
28 
#else
29 
#include "itk_kwiml.h"
30 
#endif
31
32 
#include <string>
33 
#include <boost/cstdint.hpp>
34 
#include "itkLoggerBase.h"
35 
#include "OTBCommonExport.h"
36
37 
namespace otb
38 
{
39 
/**
40 
 * \brief Retrieve configuration values from env var or default values
41 
 *
42 
 * This is a simple helper class to retrieve configuration values from
43 
 * environment variables if they are set, or from default values if
44 
 * not.
45 
 *
46 
 * Please refer to each static method documentation for available
47 
 * configuration values and related environment variables.
48 
 */
49 
class OTBCommon_EXPORT ConfigurationManager
50 
{
51 
public:
52 
#if ITK_VERSION_MAJOR < 4 || (ITK_VERSION_MAJOR == 4 && ITK_VERSION_MINOR <= 8)
53 
  typedef ::itksysFundamentalType_UInt64 RAMValueType;
54 
#else
55 
  typedef KWIML_INT_uint64_t RAMValueType;
56 
#endif
57
58 
  /**
59 
   * DEMDirectory is a directory were DEM tiles are stored.
60 
   *
61 
   * If environment variable OTB_DEM_DIRECTORY is defined,
62 
   * returns it contents as a string
63 
   * Else, returns an empty string
64 
   */
65 
  static std::string GetDEMDirectory();
66
67 
  /**
68 
   * GeoidFile is path to a geoid file.
69 
   *
70 
   * If environment variable OTB_GEOID_FILE is defined,
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
* returns it contents as a string * Else, returns an empty string */ static std::string GetGeoidFile(); /** * MaxRAMHint denotes the maximum memory OTB should use for * processing, expressed in MegaBytes. * * If environment variable OTB_MAX_RAM_HINT is defined and could be * converted to int, return its content as a 64 bits unsigned int. * Else, returns default value, which is 128 Mb * */ static RAMValueType GetMaxRAMHint(); /** * Logger level controls the level of logging that OTB will output. * * This is used to set-up the otb::Logger class. * * If OTB_LOGGER_LEVEL environment variable is set to one of DEBUG, * INFO, WARNING, CRITICAL or FATAL, the logger level will be * set accordingly. * * Priority is DEBUG < INFO < WARNING < CRITICAL < FATAL. * * Only messages with a higher priority than the logger level will * be displayed. * * By default (if OTB_LOGGER_LEVEL is not set or can not be * decoded), level is INFO. * */ static itk::LoggerBase::PriorityLevelType GetLoggerLevel(); /** * If OpenMP is enabled, the number of threads for openMP is set to the * same number as in ITK (see GetGlobalDefaultNumberOfThreads()). This number * of threads is returned. * If OpenMP is disabled, this function does nothing */ static int InitOpenMPThreads(); private: ConfigurationManager() = delete; ~ConfigurationManager() = delete; ConfigurationManager(const ConfigurationManager&) = delete; void operator =(const ConfigurationManager&) = delete; }; } #endif