itkImageModelEstimatorBase.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 itkImageModelEstimatorBase_h
#define itkImageModelEstimatorBase_h
 
#include "itkLightProcessObject.h"
 
namespace itk
{
template <typename TInputImage, typename TMembershipFunction>
class ITK_TEMPLATE_EXPORT ImageModelEstimatorBase : public LightProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageModelEstimatorBase);

  using Self = ImageModelEstimatorBase;
  using Superclass = LightProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ImageModelEstimatorBase);

  itkSetMacro(NumberOfModels, unsigned int);

  itkGetConstReferenceMacro(NumberOfModels, unsigned int);

  using MembershipFunctionPointer = typename TMembershipFunction::Pointer;
 
  using MembershipFunctionPointerVector = std::vector<MembershipFunctionPointer>;

  using InputImageType = TInputImage;
  using InputImagePointer = typename TInputImage::Pointer;

  // using TrainingImagePointer = typename TTrainingImage::Pointer;

  itkSetObjectMacro(InputImage, InputImageType);
  itkGetModifiableObjectMacro(InputImage, InputImageType);

  void
  SetMembershipFunctions(MembershipFunctionPointerVector membershipFunctions)
  {
    m_MembershipFunctions = membershipFunctions;
  }

  const MembershipFunctionPointerVector
  GetMembershipFunctions() const
  {
    return m_MembershipFunctions;
  }

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

  void
  DeleteAllMembershipFunctions()
  {
    m_MembershipFunctions.resize(0);
  }

  unsigned int
  AddMembershipFunction(MembershipFunctionPointer function);

  void
  Update();
 
protected:
  ImageModelEstimatorBase();
  ~ImageModelEstimatorBase() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override;
 
private:
  unsigned int m_NumberOfModels{ 0 };

  MembershipFunctionPointerVector m_MembershipFunctions{};

  InputImagePointer m_InputImage{};

  virtual void
  EstimateModels() = 0;
}; // class ImageModelEstimator
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageModelEstimatorBase.hxx"
#endif
 
#endif