itkManifoldParzenWindowsPointSetFunction.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 itkManifoldParzenWindowsPointSetFunction_h
#define itkManifoldParzenWindowsPointSetFunction_h
 
#include "itkPointSetFunction.h"
 
#include "itkGaussianMembershipFunction.h"
#include "itkMatrix.h"
#include "itkPointSet.h"
#include "itkPointsLocator.h"
#include "itkVector.h"
#include "itkMultiThreaderBase.h"
 
#include <vector>
 
namespace itk
{

template <typename TPointSet, typename TOutput = double, typename TCoordinate = double>
class ITK_TEMPLATE_EXPORT ManifoldParzenWindowsPointSetFunction
  : public PointSetFunction<TPointSet, TOutput, TCoordinate>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ManifoldParzenWindowsPointSetFunction);
 
  using Self = ManifoldParzenWindowsPointSetFunction;
  using Superclass = PointSetFunction<TPointSet, TOutput, TCoordinate>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  static constexpr unsigned int PointDimension = TPointSet::PointDimension;
 
  using typename Superclass::InputPointSetType;
  using typename Superclass::InputPointType;

  using PointSetType = TPointSet;
  using PointType = typename PointSetType::PointType;
  using PointsContainer = typename PointSetType::PointsContainer;
  using PointIdentifier = typename PointsContainer::ElementIdentifier;

  using RealType = TOutput;
  using OutputType = TOutput;
  using CoordinateType = TCoordinate;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif

  using PointsLocatorType = PointsLocator<PointsContainer>;
  using NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType;
 
  using GaussianType = typename Statistics::GaussianMembershipFunction<PointType>;
  using GaussianPointer = typename GaussianType::Pointer;
  using GaussianConstPointer = typename GaussianType::ConstPointer;
  using GaussianContainerType = std::vector<GaussianPointer>;
  using CovarianceMatrixType = typename GaussianType::CovarianceMatrixType;


  itkSetMacro(CovarianceKNeighborhood, unsigned int);

  itkGetConstMacro(CovarianceKNeighborhood, unsigned int);

  itkSetMacro(EvaluationKNeighborhood, unsigned int);

  itkGetConstMacro(EvaluationKNeighborhood, unsigned int);

  itkSetMacro(RegularizationSigma, RealType);

  itkGetConstMacro(RegularizationSigma, RealType);

  itkSetMacro(KernelSigma, RealType);

  itkGetConstMacro(KernelSigma, RealType);

  itkSetMacro(Normalize, bool);

  itkGetConstMacro(Normalize, bool);

  itkBooleanMacro(Normalize);

  itkSetMacro(UseAnisotropicCovariances, bool);

  itkGetConstMacro(UseAnisotropicCovariances, bool);

  itkBooleanMacro(UseAnisotropicCovariances);

  void
  SetInputPointSet(const InputPointSetType *) override;

  TOutput
  Evaluate(const InputPointType &) const override;

  GaussianConstPointer GetGaussian(PointIdentifier) const;

  itkGetModifiableObjectMacro(PointsLocator, PointsLocatorType);
 
protected:
  ManifoldParzenWindowsPointSetFunction();
  ~ManifoldParzenWindowsPointSetFunction() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData();
 
private:
  typename PointsLocatorType::Pointer m_PointsLocator{};
 
  unsigned int m_CovarianceKNeighborhood{ 5 };
  unsigned int m_EvaluationKNeighborhood{ 50 };
  RealType     m_RegularizationSigma{};
  RealType     m_KernelSigma{};
 
  GaussianContainerType m_Gaussians{};
  bool                  m_Normalize{ true };
  bool                  m_UseAnisotropicCovariances{ true };
 
  MultiThreaderBase::Pointer m_MultiThreader{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkManifoldParzenWindowsPointSetFunction.hxx"
#endif
 
#endif