otbDecisionTree.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 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 otbDecisionTree_h
#define otbDecisionTree_h
 
#include <map>
#include "itkObjectFactory.h"
#include "itkDataObject.h"
 
namespace otb
{
 
template <class AttributeValueType, class LabelType>
class ITK_EXPORT DecisionTree : public itk::DataObject
{
public:
  enum DecisionTreeTestType
  {
    MIN,
    LT = MIN,
    LE,
    EQ,
    GE,
    GT,
    MAX = GT
  };
  typedef DecisionTree                  Self;
  typedef itk::DataObject               Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(DecisionTree, DataObject);
 
  typedef typename std::pair<AttributeValueType, DecisionTreeTestType> KeyType;
  typedef typename std::map<KeyType, Pointer>                          TreeMapType;
  typedef typename std::map<KeyType, LabelType>                        LabelMapType;
  typedef std::vector<AttributeValueType> ExampleType;
 
  itkSetMacro(Attribute, unsigned int);
  itkGetMacro(Attribute, unsigned int);
 
  void AddBranch(AttributeValueType attr, DecisionTreeTestType testType, Pointer branch);
 
  void AddBranch(AttributeValueType attr, Pointer branch);
 
  void AddBranch(AttributeValueType attr, DecisionTreeTestType testType, LabelType label);
 
  void AddBranch(AttributeValueType attr, LabelType label);
 
  LabelType Decide(const ExampleType& example);
 
protected:
  DecisionTree();
 
  ~DecisionTree() override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  DecisionTree(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  TreeMapType* m_TreeMap;
 
  LabelMapType m_LabelMap;
 
  unsigned int m_Attribute;
 
  bool m_IsFinal;
 
  LabelType m_Label;
};
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbDecisionTree.hxx"
#endif
 
#endif