otbDataNode.hxx

Go to the documentation of this file.

/*
 * 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 otbDataNode_hxx
#define otbDataNode_hxx
 
#include "otbDataNode.h"
#include "otbMetaDataKey.h"
 
namespace otb
{
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
DataNode<TPrecision, VDimension, TValuePrecision>::DataNode()
{
  m_NodeType   = ROOT;
  m_NodeId     = "";
  m_Data.valid = false;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::SetNodeType(NodeType type)
{
  m_NodeType   = type;
  m_Data.valid = false;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::SetPoint(PointType point)
{
  m_NodeType   = FEATURE_POINT;
  m_Data.point = point;
  m_Data.valid = true;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::SetLine(LineType* line)
{
  m_NodeType   = FEATURE_LINE;
  m_Data.line  = line;
  m_Data.valid = true;
}
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::SetPolygonExteriorRing(PolygonType* polygon)
{
  m_NodeType          = FEATURE_POLYGON;
  m_Data.exteriorRing = polygon;
  if (!m_Data.interiorRings)
  {
    m_Data.interiorRings = PolygonListType::New();
  }
  m_Data.valid = true;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::SetPolygonInteriorRings(PolygonListType* polygonList)
{
  m_NodeType           = FEATURE_POLYGON;
  m_Data.interiorRings = polygonList;
  if (!m_Data.exteriorRing)
  {
    m_Data.exteriorRing = PolygonType::New();
  }
  m_Data.valid = true;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
typename DataNode<TPrecision, VDimension, TValuePrecision>::PointType DataNode<TPrecision, VDimension, TValuePrecision>::GetPoint() const
{
  if (!IsPointFeature())
  {
    itkGenericExceptionMacro(<< "Node " << m_NodeId << " is not a point.");
  }
  if (!m_Data.valid)
  {
    itkGenericExceptionMacro(<< "Invalid point node.");
  }
  return m_Data.point;
}
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
typename DataNode<TPrecision, VDimension, TValuePrecision>::LinePointerType DataNode<TPrecision, VDimension, TValuePrecision>::GetLine() const
{
  if (!IsLineFeature())
  {
    itkGenericExceptionMacro(<< "Node " << m_NodeId << " is not a line.");
  }
  if (!m_Data.valid)
  {
    itkGenericExceptionMacro(<< "Invalid line node.");
  }
  return m_Data.line;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
typename DataNode<TPrecision, VDimension, TValuePrecision>::PolygonPointerType DataNode<TPrecision, VDimension, TValuePrecision>::GetPolygonExteriorRing() const
{
  if (!IsPolygonFeature())
  {
    itkGenericExceptionMacro(<< "Node " << m_NodeId << " is not a polygon.");
  }
  if (!m_Data.valid || !m_Data.exteriorRing)
  {
    itkGenericExceptionMacro(<< "Invalid polygon node.");
  }
  return m_Data.exteriorRing;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
typename DataNode<TPrecision, VDimension, TValuePrecision>::PolygonListPointerType
DataNode<TPrecision, VDimension, TValuePrecision>::GetPolygonInteriorRings() const
{
  if (!IsPolygonFeature())
  {
    itkGenericExceptionMacro(<< "Node " << m_NodeId << " is not a polygon.");
  }
  if (!m_Data.valid || !m_Data.interiorRings)
  {
    itkGenericExceptionMacro(<< "Invalid polygon node.");
  }
  return m_Data.interiorRings;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::PrintSelf(std::ostream& os, itk::Indent indent) const
{
  os << indent << this->GetNodeTypeAsString();
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
std::string DataNode<TPrecision, VDimension, TValuePrecision>::GetNodeTypeAsString() const
{
  std::ostringstream oss;
  switch (m_NodeType)
  {
  case ROOT:
  {
    oss << "Root (" << m_NodeId << ")";
    break;
  }
  case DOCUMENT:
  {
    oss << "Document (" << m_NodeId << ")";
    break;
  }
  case FOLDER:
  {
    oss << "Folder (" << m_NodeId << ")";
    break;
  }
  case FEATURE_POINT:
  {
    oss << "Point (" << m_NodeId << ") " << m_Data.point;
    break;
  }
  case FEATURE_LINE:
  {
    oss << "Line (" << m_NodeId << ") " << m_Data.line->GetVertexList()->Size() << " points";
    break;
  }
  case FEATURE_POLYGON:
  {
    oss << "Polygon (" << m_NodeId << ") " << this->GetPolygonExteriorRing()->GetVertexList()->Size() << " points, " << this->GetPolygonInteriorRings()->Size()
        << " interior rings";
    break;
  }
  case FEATURE_MULTIPOINT:
  {
    oss << "MultiPoint (" << m_NodeId << ")";
    break;
  }
  case FEATURE_MULTILINE:
  {
    oss << "MultiLine (" << m_NodeId << ")";
    break;
  }
  case FEATURE_MULTIPOLYGON:
  {
    oss << "MultiPolygon (" << m_NodeId << ")";
    break;
  }
  case FEATURE_COLLECTION:
  {
    oss << "Collection (" << m_NodeId << ")";
    break;
  }
  }
  if (GetMetaDataDictionary().HasKey(MetaDataKey::VectorDataKeywordlistKey))
  {
    VectorDataKeywordlist kwl;
    itk::ExposeMetaData<VectorDataKeywordlist>(GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, kwl);
    oss << "\n  -> Metadata: " << kwl;
  }
  return oss.str();
}
/*
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void
DataNode<TPrecision, VDimension, TValuePrecision>
::SetField(const std::string& key, const std::string& value)
{
  m_FieldMap[key] = value;
}
*/
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::SetFieldAsString(const std::string& key, const std::string& value)
{
  otb::VectorDataKeywordlist kwl;
  itk::ExposeMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, kwl);
  kwl.SetFieldAsString(key, value);
  itk::EncapsulateMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, kwl);
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::SetFieldAsInt(const std::string& key, int value)
{
  otb::VectorDataKeywordlist kwl;
  itk::ExposeMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, kwl);
  kwl.SetFieldAsInt(key, value);
  itk::EncapsulateMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, kwl);
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::SetFieldAsDouble(const std::string& key, double value)
{
  otb::VectorDataKeywordlist kwl;
  itk::ExposeMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, kwl);
 
  kwl.SetFieldAsDouble(key, value);
  itk::EncapsulateMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, kwl);
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
double DataNode<TPrecision, VDimension, TValuePrecision>::GetFieldAsDouble(const std::string& key) const
{
  VectorDataKeywordlist keywordlist;
  if (HasField(key))
  {
    itk::ExposeMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, keywordlist);
 
    return keywordlist.GetFieldAsDouble(key);
  }
  return 0;
}
 
/*
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
std::string
DataNode<TPrecision, VDimension, TValuePrecision>
::GetField(const std::string& key) const
{
  if (HasField(key))
  {
    return (*m_FieldMap.find(key)).second;
  }
  else
  {
    return "Unknown Key";
  }
}*/
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
std::string DataNode<TPrecision, VDimension, TValuePrecision>::GetFieldAsString(const std::string& key) const
{
  VectorDataKeywordlist keywordlist;
  if (HasField(key))
  {
    itk::ExposeMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, keywordlist);
    return keywordlist.GetFieldAsString(key);
  }
  return "";
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
int DataNode<TPrecision, VDimension, TValuePrecision>::GetFieldAsInt(const std::string& key) const
{
  VectorDataKeywordlist keywordlist;
  if (HasField(key))
  {
    itk::ExposeMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, keywordlist);
 
    return keywordlist.GetFieldAsInt(key);
  }
  return 0;
}
 
/*
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void
DataNode<TPrecision, VDimension, TValuePrecision>
::RemoveField(const std::string& key)
{
  m_FieldMap.erase(key);
}
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool
DataNode<TPrecision, VDimension, TValuePrecision>
::HasField(const std::string& key) const
{
  return (m_FieldMap.find(key)!=m_FieldMap.end());
}
*/
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::HasField(const std::string& key) const
{
  VectorDataKeywordlist keywordlist;
  if (this->GetMetaDataDictionary().HasKey(MetaDataKey::VectorDataKeywordlistKey))
  {
    itk::ExposeMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, keywordlist);
    return keywordlist.HasField(key);
  }
  return false;
}
 
/*
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
typename DataNode<TPrecision, VDimension, TValuePrecision>
::FieldType
DataNode<TPrecision, VDimension, TValuePrecision>
::GetNthField(unsigned int index) const
{
  if (index<GetNumberOfFields())
  {
    FieldMapType::iterator it = m_FieldMap.begin();
 
    for (unsigned int i = 0; i<index; ++i)
    {
      ++it;
    }
    return (*it);
  }
  return FieldType("No key","No value");
}
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
unsigned int
DataNode<TPrecision, VDimension, TValuePrecision>
::GetNumberOfFields() const
{
  return m_FieldMap.size();
}
*/
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void DataNode<TPrecision, VDimension, TValuePrecision>::CopyFieldList(const DataNode* dataNode)
{
  // The source keywordlist where to get the feature list to copy
  otb::VectorDataKeywordlist srcKwl;
  itk::ExposeMetaData<VectorDataKeywordlist>(dataNode->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, srcKwl);
 
  otb::VectorDataKeywordlist kwl;
  itk::ExposeMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, kwl);
 
  kwl.CopyFieldList(srcKwl);
  itk::EncapsulateMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, kwl);
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
std::vector<std::string> DataNode<TPrecision, VDimension, TValuePrecision>::GetFieldList() const
{
  VectorDataKeywordlist keywordlist;
  if (this->GetMetaDataDictionary().HasKey(MetaDataKey::VectorDataKeywordlistKey))
  {
    itk::ExposeMetaData<VectorDataKeywordlist>(this->GetMetaDataDictionary(), MetaDataKey::VectorDataKeywordlistKey, keywordlist);
    return keywordlist.GetFieldList();
  }
  std::vector<std::string> empty;
  return empty;
}
 
/*
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
void
DataNode<TPrecision, VDimension, TValuePrecision>
::ClearFields()
{
  m_FieldMap.clear();
}*/
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsDocument() const
{
  return m_NodeType == DOCUMENT;
}
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsRoot() const
{
  return m_NodeType == ROOT;
}
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsFolder() const
{
  return m_NodeType == FOLDER;
}
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsPointFeature() const
{
  return m_NodeType == FEATURE_POINT;
}
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsLineFeature() const
{
  return m_NodeType == FEATURE_LINE;
}
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsPolygonFeature() const
{
  return m_NodeType == FEATURE_POLYGON;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsMultiPointFeature() const
{
  return m_NodeType == FEATURE_MULTIPOINT;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsMultiLineFeature() const
{
  return m_NodeType == FEATURE_MULTILINE;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsMultiPolygonFeature() const
{
  return m_NodeType == FEATURE_MULTIPOLYGON;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::IsCollectionFeature() const
{
  return m_NodeType == FEATURE_COLLECTION;
}
 
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
OGRGeometry* DataNode<TPrecision, VDimension, TValuePrecision>::ConvertDataNodeToOGRGeometry(const DataNode* dataNode)
{
  switch (dataNode->GetNodeType())
  {
  case FEATURE_POINT:
  {
    OGRPoint* ogrPoint = (OGRPoint*)OGRGeometryFactory::createGeometry(wkbPoint);
    ogrPoint->setX(dataNode->GetPoint()[0]);
    ogrPoint->setY(dataNode->GetPoint()[1]);
    return ogrPoint;
  }
  break;
  case FEATURE_LINE:
  {
    // Build the ogrObject
    OGRLineString*                         ogrLine    = (OGRLineString*)OGRGeometryFactory::createGeometry(wkbLineString);
    VertexListConstPointerType             vertexList = dataNode->GetLine()->GetVertexList();
    typename VertexListType::ConstIterator vIt        = vertexList->Begin();
 
    while (vIt != vertexList->End())
    {
      OGRPoint ogrPoint;
      ogrPoint.setX(vIt.Value()[0]);
      ogrPoint.setY(vIt.Value()[1]);
      if (Dimension > 2)
      {
        ogrPoint.setZ(vIt.Value()[2]);
      }
      ogrLine->addPoint(&ogrPoint);
      ++vIt;
    }
    return ogrLine;
  }
  break;
  case FEATURE_POLYGON:
  {
    OGRPolygon*    polygon         = (OGRPolygon*)OGRGeometryFactory::createGeometry(wkbPolygon);
    OGRLinearRing* ogrExternalRing = (OGRLinearRing*)OGRGeometryFactory::createGeometry(wkbLinearRing);
 
    VertexListConstPointerType vertexList = dataNode->GetPolygonExteriorRing()->GetVertexList();
 
    typename VertexListType::ConstIterator vIt = vertexList->Begin();
 
    while (vIt != vertexList->End())
    {
      OGRPoint ogrPoint;
      ogrPoint.setX(vIt.Value()[0]);
      ogrPoint.setY(vIt.Value()[1]);
      if (Dimension > 2)
      {
        ogrPoint.setZ(vIt.Value()[2]);
      }
 
      ogrExternalRing->addPoint(&ogrPoint);
      ++vIt;
    }
    polygon->addRing(ogrExternalRing);
    // Close the polygon
    polygon->closeRings();
    OGRGeometryFactory::destroyGeometry(ogrExternalRing);
    return polygon;
  }
  break;
  default:
    break;
  }
 
  return nullptr;
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
double DataNode<TPrecision, VDimension, TValuePrecision>::EuclideanDistanceMetric(const DataNode* node)
{
  // Convert the nodes to OGRGeometries
  OGRGeometry* dstGeomtery     = this->ConvertDataNodeToOGRGeometry(node);
  OGRGeometry* currentGeometry = this->ConvertDataNodeToOGRGeometry(this);
 
  // Compute the distance
  return currentGeometry->Distance(dstGeomtery);
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
double DataNode<TPrecision, VDimension, TValuePrecision>::EuclideanDistanceMetric(const PointType point)
{
  // Convert Point to point to ogrPoint
  OGRPoint ogrPointSrc;
  ogrPointSrc.setX(point[0]);
  ogrPointSrc.setY(point[1]);
 
  // Convert the current datanode to an OGRGeometry
  OGRGeometry* currentGeometry = this->ConvertDataNodeToOGRGeometry(this);
 
  // return the distance
  return currentGeometry->Distance(&ogrPointSrc);
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::Intersects(const DataNode* node)
{
  // Convert the nodes to OGRGeometries
  OGRGeometry* dstGeomtery     = this->ConvertDataNodeToOGRGeometry(node);
  OGRGeometry* currentGeometry = this->ConvertDataNodeToOGRGeometry(this);
 
  //
  return currentGeometry->Intersects(dstGeomtery);
}
 
template <class TPrecision, unsigned int VDimension, class TValuePrecision>
bool DataNode<TPrecision, VDimension, TValuePrecision>::Within(const DataNode* node)
{
  // Convert the nodes to OGRGeometries
  OGRGeometry* dstGeomtery     = this->ConvertDataNodeToOGRGeometry(node);
  OGRGeometry* currentGeometry = this->ConvertDataNodeToOGRGeometry(this);
 
  //
  return currentGeometry->Within(dstGeomtery);
}
 
 
} // end namespace otb
 
#endif