itkMixtureModelComponentBase.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 itkMixtureModelComponentBase_h
#define itkMixtureModelComponentBase_h
 
#include "vnl/vnl_vector.h"
#include "vnl/vnl_matrix.h"
 
#include "itkArray.h"
#include "itkObject.h"
#include "itkMembershipFunctionBase.h"
 
namespace itk::Statistics
{
 
template <typename TSample>
class ITK_TEMPLATE_EXPORT MixtureModelComponentBase : public Object
{
public:
  using Self = MixtureModelComponentBase;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(MixtureModelComponentBase);
 
  using MeasurementVectorType = typename TSample::MeasurementVectorType;
  using MeasurementVectorSizeType = typename TSample::MeasurementVectorSizeType;

  using MembershipFunctionType = MembershipFunctionBase<MeasurementVectorType>;

  using WeightArrayType = Array<double>;
 
  using ParametersType = Array<double>;

  virtual void
  SetSample(const TSample * sample);

  const TSample *
  GetSample() const;

  MembershipFunctionType *
  GetMembershipFunction();
 
  void
  SetMinimalParametersChange(double change)
  {
    m_MinimalParametersChange = change;
  }
 
  double
  GetMinimalParametersChange()
  {
    return m_MinimalParametersChange;
  }
 
  virtual void
  SetParameters(const ParametersType & parameters);
 
  virtual ParametersType
  GetFullParameters()
  {
    return m_Parameters;
  }

  void
  AreParametersModified(bool flag);

  bool
  AreParametersModified();

  void
  SetWeight(unsigned int index, double value);

  double
  GetWeight(unsigned int index) const;

  double
  Evaluate(MeasurementVectorType & measurements);

  itkGetConstReferenceMacro(Weights, WeightArrayType);
 
  virtual void
  Update();
 
protected:
  MixtureModelComponentBase();
  ~MixtureModelComponentBase() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  SetMembershipFunction(MembershipFunctionType * function);
 
  virtual void
  GenerateData() = 0;
 
private:
  const TSample * m_Sample{};
 
  double m_MinimalParametersChange{};
 
  ParametersType m_Parameters{};

  MembershipFunctionType * m_MembershipFunction{};

  WeightArrayType m_Weights{};

  bool m_ParametersModified{};
}; // end of class
} // namespace itk::Statistics
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMixtureModelComponentBase.hxx"
#endif
 
#endif