ADD: new helper class to handle itk::MetaDataDictionary

Modules/Wrappers/ApplicationEngine/include/otbWrapperMetaDataHelper.h

+/*
+ * Copyright (C) 2005-2017 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 otbWrapperMetaDataHelper_h
+#define otbWrapperMetaDataHelper_h
+
+#include "otbMetaDataKey.h"
+#include "otbImageKeywordlist.h"
+#include "otbVectorDataKeywordlist.h"
+#include "itkMetaDataDictionary.h"
+#include "OTBApplicationEngineExport.h"
+
+namespace otb
+{
+namespace Wrapper
+{
+
+/**
+ * \class MetaDataHelper
+ *
+ * \brief Small helper to manipulate itk::MetaDataDictionary
+ *
+ * This class is only here to instanciate the different template function that
+ * allow to get/set values in MetaDataDictionary. All functions are static.
+ * 
+ * \ingroup OTBApplicationEngine
+ */
+class OTBApplicationEngine_EXPORT MetaDataHelper
+{
+public:
+  MetaDataHelper();
+  virtual ~MetaDataHelper();
+
+  typedef enum
+  {
+    MDType_STRING,
+    MDType_INT,
+    MDType_DOUBLE,
+    MDType_GCP,
+    MDType_VECTOR,
+    MDType_IMAGEKWL,
+    MDType_VECTORDATAKWL,
+    MDType_BOOLVECTOR
+  } MDType;
+
+  static MDType GetType(const std::string &val);
+
+  static std::string GetString(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key);
+  static void SetString(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const std::string &val);
+
+  static unsigned int GetInt(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key);
+  static void SetInt(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    unsigned int val);
+
+  static double GetDouble(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key);
+  static void SetDouble(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    double val);
+
+  static otb::OTB_GCP GetGCP(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key);
+  static void SetGCP(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::OTB_GCP &val);
+
+  static otb::MetaDataKey::VectorType GetVector(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key);
+  static void SetVector(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::MetaDataKey::VectorType &val);
+
+  static otb::ImageKeywordlist GetImageKWL(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key);
+  static void SetImageKWL(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::ImageKeywordlist &val);
+
+  static otb::VectorDataKeywordlist GetVectorDataKWL(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key);
+  static void SetVectorDataKWL(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::VectorDataKeywordlist &val);
+
+  static otb::MetaDataKey::BoolVectorType GetBoolVector(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key);
+  static void SetBoolVector(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::MetaDataKey::BoolVectorType &val);
+};
+
+} // end of namespace Wrapper
+} // end of namespace otb
+
+#endif

Modules/Wrappers/ApplicationEngine/src/CMakeLists.txt

@@ -53,6 +53,7 @@ set( OTBApplicationEngine_SRC
   otbWrapperAbstractParameterList.cxx
   otbWrapperParameterList.cxx
   otbLogger.cxx
+  otbWrapperMetaDataHelper.cxx
   )
 
 add_library(OTBApplicationEngine ${OTBApplicationEngine_SRC})

Modules/Wrappers/ApplicationEngine/src/otbWrapperMetaDataHelper.cxx

+/*
+ * Copyright (C) 2005-2017 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.
+ */
+
+#include "otbWrapperMetaDataHelper.h"
+#include "itkMetaDataObject.h"
+
+namespace otb
+{
+namespace Wrapper
+{
+
+MetaDataHelper::MetaDataHelper()
+{
+}
+
+MetaDataHelper::~MetaDataHelper()
+{
+}
+
+MetaDataHelper::MDType
+MetaDataHelper::GetType(const std::string &val)
+{
+  MDType ret;
+  otb::MetaDataKey::KeyType kt = otb::MetaDataKey::GetKeyType(val);
+  switch (kt)
+    {
+    case otb::MetaDataKey::TSTRING:
+      ret = MDType_STRING;
+      break;
+    case otb::MetaDataKey::TENTIER:
+      ret = MDType_INT;
+      break;
+    case otb::MetaDataKey::TDOUBLE:
+      ret = MDType_DOUBLE;
+      break;
+    case otb::MetaDataKey::TOTB_GCP:
+      ret = MDType_GCP;
+      break;
+    case otb::MetaDataKey::TVECTOR:
+      ret = MDType_VECTOR;
+      break;
+    case otb::MetaDataKey::TOSSIMKEYWORDLIST:
+      ret = MDType_IMAGEKWL;
+      break;
+    case otb::MetaDataKey::TVECTORDATAKEYWORDLIST:
+      ret = MDType_VECTORDATAKWL;
+      break;
+    case otb::MetaDataKey::TBOOLVECTOR:
+      ret = MDType_BOOLVECTOR;
+      break;
+    default:
+      break;
+    }
+  return ret;
+}
+
+std::string
+MetaDataHelper::GetString(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key)
+{
+  std::string ret;
+  itk::ExposeMetaData<std::string>(dict, key, ret);
+  return ret;
+}
+
+void
+MetaDataHelper::SetString(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const std::string &val)
+{
+  itk::EncapsulateMetaData<std::string>(dict, key, val);
+}
+
+unsigned int
+MetaDataHelper::GetInt(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key)
+{
+  unsigned int ret;
+  itk::ExposeMetaData<unsigned int>(dict, key, ret);
+  return ret;
+}
+
+void
+MetaDataHelper::SetInt(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    unsigned int val)
+{
+  itk::EncapsulateMetaData<unsigned int>(dict, key, val);
+}
+
+double
+MetaDataHelper::GetDouble(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key)
+{
+  double ret;
+  itk::ExposeMetaData<double>(dict, key, ret);
+  return ret;
+}
+
+void
+MetaDataHelper::SetDouble(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    double val)
+{
+  itk::EncapsulateMetaData<double>(dict, key, val);
+}
+
+otb::OTB_GCP
+MetaDataHelper::GetGCP(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key)
+{
+  otb::OTB_GCP ret;
+  itk::ExposeMetaData<otb::OTB_GCP>(dict, key, ret);
+  return ret;
+}
+
+void
+MetaDataHelper::SetGCP(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::OTB_GCP &val)
+{
+  itk::EncapsulateMetaData<otb::OTB_GCP>(dict, key, val);
+}
+
+otb::MetaDataKey::VectorType
+MetaDataHelper::GetVector(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key)
+{
+  otb::MetaDataKey::VectorType ret;
+  itk::ExposeMetaData<otb::MetaDataKey::VectorType>(dict, key, ret);
+  return ret;
+}
+
+void
+MetaDataHelper::SetVector(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::MetaDataKey::VectorType &val)
+{
+  itk::EncapsulateMetaData<otb::MetaDataKey::VectorType>(dict, key, val);
+}
+
+otb::ImageKeywordlist
+MetaDataHelper::GetImageKWL(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key)
+{
+  otb::ImageKeywordlist ret;
+  itk::ExposeMetaData<otb::ImageKeywordlist>(dict, key, ret);
+  return ret;
+}
+
+void
+MetaDataHelper::SetImageKWL(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::ImageKeywordlist &val)
+{
+  itk::EncapsulateMetaData<otb::ImageKeywordlist>(dict, key, val);
+}
+
+otb::VectorDataKeywordlist
+MetaDataHelper::GetVectorDataKWL(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key)
+{
+  otb::VectorDataKeywordlist ret;
+  itk::ExposeMetaData<otb::VectorDataKeywordlist>(dict, key, ret);
+  return ret;
+}
+
+void
+MetaDataHelper::SetVectorDataKWL(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::VectorDataKeywordlist &val)
+{
+  itk::EncapsulateMetaData<otb::VectorDataKeywordlist>(dict, key, val);
+}
+
+otb::MetaDataKey::BoolVectorType
+MetaDataHelper::GetBoolVector(
+    const itk::MetaDataDictionary &dict,
+    const std::string &key)
+{
+  otb::MetaDataKey::BoolVectorType ret;
+  itk::ExposeMetaData<otb::MetaDataKey::BoolVectorType>(dict, key, ret);
+  return ret;
+}
+
+void
+MetaDataHelper::SetBoolVector(
+    itk::MetaDataDictionary &dict,
+    const std::string &key,
+    const otb::MetaDataKey::BoolVectorType &val)
+{
+  itk::EncapsulateMetaData<otb::MetaDataKey::BoolVectorType>(dict, key, val);
+}
+
+} // end of namespace Wrapper
+} // end of namespace otb