itkPCAShapeSignedDistanceFunction.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 itkPCAShapeSignedDistanceFunction_h
#define itkPCAShapeSignedDistanceFunction_h
 
#include "itkShapeSignedDistanceFunction.h"
#include "itkImage.h"
#include "itkInterpolateImageFunction.h"
#include "itkExtrapolateImageFunction.h"
#include "itkTransform.h"
 
namespace itk
{
template <typename TCoordinate, unsigned int VSpaceDimension, typename TImage = Image<double, VSpaceDimension>>
class ITK_TEMPLATE_EXPORT PCAShapeSignedDistanceFunction
  : public ShapeSignedDistanceFunction<TCoordinate, VSpaceDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PCAShapeSignedDistanceFunction);

  using Self = PCAShapeSignedDistanceFunction;
  using Superclass = ShapeSignedDistanceFunction<TCoordinate, VSpaceDimension>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(PCAShapeSignedDistanceFunction);

  itkNewMacro(Self);

  static constexpr unsigned int SpaceDimension = Superclass::SpaceDimension;

  using typename Superclass::CoordinateType;

  using typename Superclass::InputType;

  using typename Superclass::OutputType;

  using typename Superclass::PointType;

  using typename Superclass::ParametersType;

  using ImageType = TImage;
  using ImagePointer = typename ImageType::Pointer;
  using ImagePointerVector = std::vector<ImagePointer>;

  using TransformType = Transform<CoordinateType, Self::SpaceDimension, Self::SpaceDimension>;

  using InterpolatorType = InterpolateImageFunction<ImageType, CoordinateType>;
  using InterpolatorPointer = typename InterpolatorType::Pointer;
  using InterpolatorPointerVector = std::vector<InterpolatorPointer>;

  using ExtrapolatorType = ExtrapolateImageFunction<ImageType, CoordinateType>;
  using ExtrapolatorPointer = typename ExtrapolatorType::Pointer;
  using ExtrapolatorPointerVector = std::vector<ExtrapolatorPointer>;

  using FunctionType = ImageFunction<ImageType, double, CoordinateType>;
  using FunctionPointer = typename FunctionType::Pointer;
  using FunctionPointerVector = std::vector<FunctionPointer>;

  void
  SetNumberOfPrincipalComponents(unsigned int n);
 
  itkGetConstMacro(NumberOfPrincipalComponents, unsigned int);

  itkSetObjectMacro(MeanImage, ImageType);
  itkGetModifiableObjectMacro(MeanImage, ImageType);

  void
  SetPrincipalComponentImages(ImagePointerVector v)
  {
    m_PrincipalComponentImages = v;
  }
  //  ImagePointerVector & GetPrincipalComponentImages()
  //    { return m_PrincipalComponentImages; }

  itkSetMacro(PrincipalComponentStandardDeviations, ParametersType);
  itkGetConstMacro(PrincipalComponentStandardDeviations, ParametersType);

  itkSetObjectMacro(Transform, TransformType);
  itkGetModifiableObjectMacro(Transform, TransformType);

  void
  SetParameters(const ParametersType &) override;
 
  [[nodiscard]] unsigned int
  GetNumberOfShapeParameters() const override
  {
    return m_NumberOfPrincipalComponents;
  }
  [[nodiscard]] unsigned int
  GetNumberOfPoseParameters() const override
  {
    return m_Transform ? m_Transform->GetNumberOfParameters() : 0;
  }

  OutputType
  Evaluate(const PointType & point) const override;

  void
  Initialize() override;
 
protected:
  PCAShapeSignedDistanceFunction();
  ~PCAShapeSignedDistanceFunction() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  unsigned int m_NumberOfPrincipalComponents{};
  unsigned int m_NumberOfTransformParameters{};
 
  ImagePointer       m_MeanImage{};
  ImagePointerVector m_PrincipalComponentImages{};
  ParametersType     m_PrincipalComponentStandardDeviations{};

  typename TransformType::Pointer m_Transform{};
 
  InterpolatorPointerVector m_Interpolators{};
  ExtrapolatorPointerVector m_Extrapolators{};

  ParametersType m_WeightOfPrincipalComponents{};
  ParametersType m_TransformParameters{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPCAShapeSignedDistanceFunction.hxx"
#endif
 
#endif