itkClassifierBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  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 itkClassifierBase_h
#define itkClassifierBase_h
 
#include "itkLightProcessObject.h"
#include "itkMembershipFunctionBase.h"
#include "itkDecisionRule.h"
 
#include <vector>
 
namespace itk
{
template <typename TDataContainer>
class ITK_TEMPLATE_EXPORT ClassifierBase : public LightProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ClassifierBase);

  using Self = ClassifierBase;
  using Superclass = LightProcessObject;

  itkOverrideGetNameOfClassMacro(ClassifierBase);

  itkSetMacro(NumberOfClasses, unsigned int);

  itkGetConstReferenceMacro(NumberOfClasses, unsigned int);

  using MeasurementVectorType = typename TDataContainer::ValueType;

  using MembershipFunctionType = Statistics::MembershipFunctionBase<MeasurementVectorType>;
  using MembershipFunctionPointer = typename MembershipFunctionType::Pointer;
 
  using MembershipFunctionPointerVector = std::vector<MembershipFunctionPointer>;

  using DecisionRuleType = Statistics::DecisionRule;

  void
  SetDecisionRule(DecisionRuleType * ptrToDecisionRule)
  {
    m_DecisionRule = ptrToDecisionRule;
  }

  DecisionRuleType *
  GetDecisionRule()
  {
    return m_DecisionRule.GetPointer();
  }

  const MembershipFunctionType *
  GetMembershipFunction(unsigned int index) const
  {
    return m_MembershipFunctions[index].GetPointer();
  }

  unsigned int
  GetNumberOfMembershipFunctions()
  {
    return static_cast<unsigned int>(m_MembershipFunctions.size());
  }

  unsigned int
  AddMembershipFunction(MembershipFunctionType * function);

  void
  Update();
 
protected:
  ClassifierBase();
  ~ClassifierBase() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override = 0;
 
private:
  unsigned int m_NumberOfClasses{};

  typename DecisionRuleType::Pointer m_DecisionRule{};

  MembershipFunctionPointerVector m_MembershipFunctions{};
}; // class Classifier
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkClassifierBase.hxx"
#endif
 
#endif