otbModelComponentBase.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
 * Copyright (C) 2007-2012 Institut Mines Telecom / Telecom Bretagne
 *
 * 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 otbModelComponentBase_h
#define otbModelComponentBase_h
 
#include <vnl/vnl_vector.h>
#include <vnl/vnl_matrix.h>
 
#include "itkObject.h"
#include "itkArray.h"
#include "itkMembershipFunctionBase.h"
 
namespace otb
{
namespace Statistics
{
 
template <class TSample>
class ITK_EXPORT ModelComponentBase : public itk::Object
{
public:
  typedef ModelComponentBase            Self;
  typedef itk::Object                   Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
  itkTypeMacro(ModelComponentBase, Object);
 
  typedef typename TSample::MeasurementVectorType     MeasurementVectorType;
  typedef typename TSample::MeasurementVectorSizeType MeasurementVectorSizeType;
 
  typedef itk::Statistics::MembershipFunctionBase<MeasurementVectorType> MembershipFunctionType;
 
  typedef itk::Array<double> ParametersType;
 
  virtual void SetSample(const TSample* sample);
 
  const TSample* GetSample() const;
 
  MembershipFunctionType* GetPdfMembershipFunction();
  MembershipFunctionType* GetCdfMembershipFunction();
 
  void SetCdfMembershipFunction(MembershipFunctionType* function);
 
  void SetParameters(const ParametersType& parameters);
  ParametersType GetParameters()
  {
    return m_Parameters;
  }
 
  double Evaluate(MeasurementVectorType& measurements);
  double Pdf(MeasurementVectorType& measurements);
 
  double Cdf(MeasurementVectorType& measurements);
 
  virtual void Update();
 
  virtual void ShowParameters(std::ostream& os, itk::Indent indent) const;
 
  // TODO: Distance between distributions with some kind of member function...
 
protected:
  ModelComponentBase();
  ~ModelComponentBase() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  virtual void GenerateData();
 
  void SetPdfMembershipFunction(MembershipFunctionType* function);
 
  int IsSampleModified();
 
  ParametersType m_Parameters;
 
private:
  ModelComponentBase(const Self&) = delete;
  void operator=(const Self&) = delete;
  const TSample* m_Sample;
 
protected:
  MembershipFunctionType* m_PdfFunction;
 
  MembershipFunctionType* m_CdfFunction;
 
  int m_SampleModified;
 
}; // end of class
 
} // end of namespace Statistics
} // end of namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbModelComponentBase.hxx"
#endif
 
#endif