itkImagePCADecompositionCalculator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 ImagePCADecompositionCalculator:public Object
{
public:
  typedef ImagePCADecompositionCalculator Self;
  typedef Object                          Superclass;
  typedef SmartPointer< Self >            Pointer;
  typedef SmartPointer< const Self >      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ImagePCADecompositionCalculator, Object);

  typedef TInputImage InputImageType;
  typedef TBasisImage BasisImageType;

  typedef typename TInputImage::Pointer InputImagePointer;
  typedef typename TBasisImage::Pointer BasisImagePointer;

  typedef typename TInputImage::ConstPointer InputImageConstPointer;
  typedef typename TBasisImage::ConstPointer BasisImageConstPointer;

  typedef typename TBasisImage::PixelType BasisPixelType;

  itkStaticConstMacro(InputImageDimension, unsigned int,
                      TInputImage::ImageDimension);

  itkStaticConstMacro(BasisImageDimension, unsigned int,
                      TBasisImage::ImageDimension);

  typedef std::vector< BasisImagePointer > BasisImagePointerVector;

  typedef vnl_matrix< BasisPixelType > BasisMatrixType;
  typedef vnl_vector< BasisPixelType > BasisVectorType;

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

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

  void SetBasisImages(const BasisImagePointerVector &);

  BasisImagePointerVector GetBasisImages() { return m_BasisImages; }

  typedef typename ImagePCAShapeModelEstimator< TInputImage,
                                                TBasisImage >::Pointer ModelPointerType;

  void SetBasisFromModel(ModelPointerType model);

  void Compute(void);

  itkGetConstMacro(Projection, BasisVectorType);

protected:
  ImagePCADecompositionCalculator();
  virtual ~ImagePCADecompositionCalculator() {}
  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  void CalculateBasisMatrix(void);

  void CalculateRecenteredImageAsVector(void);

private:
  typedef typename BasisImageType::SizeType BasisSizeType;

  ImagePCADecompositionCalculator(const Self &); //purposely not implemented
  void operator=(const Self &);                  //purposely not implemented

  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