itkImagePCADecompositionCalculator.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 itkImagePCADecompositionCalculator_h
#define itkImagePCADecompositionCalculator_h
 
#include "itkObject.h"
#include "itkImagePCAShapeModelEstimator.h"
#include "vnl/vnl_vector.h"
#include "vnl/vnl_matrix.h"
 
namespace itk
{
template <typename TInputImage, typename TBasisImage = Image<double, TInputImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT ImagePCADecompositionCalculator : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImagePCADecompositionCalculator);

  using Self = ImagePCADecompositionCalculator;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ImagePCADecompositionCalculator);

  using InputImageType = TInputImage;
  using BasisImageType = TBasisImage;

  using InputImagePointer = typename TInputImage::Pointer;
  using BasisImagePointer = typename TBasisImage::Pointer;

  using InputImageConstPointer = typename TInputImage::ConstPointer;
  using BasisImageConstPointer = typename TBasisImage::ConstPointer;

  using BasisPixelType = typename TBasisImage::PixelType;

  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;

  static constexpr unsigned int BasisImageDimension = TBasisImage::ImageDimension;

  using BasisImagePointerVector = std::vector<BasisImagePointer>;

  using BasisMatrixType = vnl_matrix<BasisPixelType>;
  using BasisVectorType = vnl_vector<BasisPixelType>;

  itkSetConstObjectMacro(Image, InputImageType);
  itkGetConstObjectMacro(Image, InputImageType);

  itkSetConstObjectMacro(MeanImage, BasisImageType);
  itkGetConstObjectMacro(MeanImage, BasisImageType);

  void
  SetBasisImages(const BasisImagePointerVector &);
 
  BasisImagePointerVector
  GetBasisImages()
  {
    return m_BasisImages;
  }

  using ModelPointerType = typename ImagePCAShapeModelEstimator<TInputImage, TBasisImage>::Pointer;

  void
  SetBasisFromModel(ModelPointerType model);

  void
  Compute();

  itkGetConstMacro(Projection, BasisVectorType);
 
protected:
  ImagePCADecompositionCalculator();
  ~ImagePCADecompositionCalculator() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  CalculateBasisMatrix();

  void
  CalculateRecenteredImageAsVector();
 
private:
  using BasisSizeType = typename BasisImageType::SizeType;
 
  BasisVectorType         m_Projection{};
  BasisVectorType         m_ImageAsVector{};
  BasisImagePointerVector m_BasisImages{};
  BasisImageConstPointer  m_MeanImage{};
  BasisSizeType           m_Size{};
  InputImageConstPointer  m_Image{};
  BasisMatrixType         m_BasisMatrix{};
  bool                    m_BasisMatrixCalculated{};
  SizeValueType           m_NumPixels{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImagePCADecompositionCalculator.hxx"
#endif
 
#endif