itkCreateEulerAffineTransformMatrix.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef itkCreateEulerAffineTransformMatrix_h
#define itkCreateEulerAffineTransformMatrix_h

#include "itkCreateEulerAffineTransformMatrixBaseClass.h"
#include <itkEulerAffineTransform.h>
#include <itk_hash_map.h>

#include <vnl/vnl_math.h>
#include <vnl/vnl_vector.h>
#include <vnl/vnl_sparse_matrix.h>


namespace itk
{
  
template <class IntensityType = float>
class ITK_EXPORT CreateEulerAffineTransformMatrix :
    public CreateEulerAffineTransformMatrixBaseClass<Image< IntensityType, 3>,  // Input image
          Image< IntensityType, 3> > // Output image
{
public:
  typedef CreateEulerAffineTransformMatrix Self;
  typedef SmartPointer<Self>               Pointer;
  typedef SmartPointer<const Self>         ConstPointer;
  typedef CreateEulerAffineTransformMatrixBaseClass<Image< IntensityType, 3>, Image< IntensityType, 3> >    Superclass;

  itkNewMacro(Self);

  itkTypeMacro(CreateEulerAffineTransformMatrix, CreateEulerAffineTransformMatrixBaseClass);

  typedef Image<IntensityType, 3>                 InputImageType;
  typedef typename InputImageType::Pointer        InputImagePointer;
  typedef typename InputImageType::ConstPointer   InputImageConstPointer;
  typedef typename InputImageType::RegionType     InputImageRegionType;
  typedef typename InputImageType::SizeType       InputImageSizeType;
  typedef typename InputImageType::SpacingType    InputImageSpacingType;
  typedef typename InputImageType::PointType      InputImagePointType;
  typedef typename InputImageType::PixelType      InputImagePixelType;
  typedef typename InputImageType::IndexType      InputImageIndexType;


  typedef Image<IntensityType, 3>                 OutputImageType;
  typedef typename OutputImageType::Pointer       OutputImagePointer;
  typedef typename OutputImageType::ConstPointer  OutputImageConstPointer;
  typedef typename OutputImageType::RegionType    OutputImageRegionType;
  typedef typename OutputImageType::SizeType      OutputImageSizeType;
  typedef typename OutputImageType::SpacingType   OutputImageSpacingType;
  typedef typename OutputImageType::PointType     OutputImagePointType;
  typedef typename OutputImageType::PixelType     OutputImagePixelType;
  typedef typename OutputImageType::IndexType     OutputImageIndexType;

  typedef EulerAffineTransform<double, 3, 3> EulerAffineTransformType;

  typedef vnl_sparse_matrix<double>             SparseMatrixType;
  typedef vnl_matrix<double>                    FullMatrixType;
  typedef vnl_vector<double>                    VectorType;

  typedef itk::hash_map<int, VectorType>                                  VectorMapType;
  typedef typename itk::hash_map<int, VectorType>::iterator               VectorMapIterator;
  typedef typename itk::hash_map<int, VectorType>::const_iterator         VectorMapConstIterator;

  itkStaticConstMacro(InputImageDimension, unsigned int, 3);
  itkStaticConstMacro(OutputImageDimension, unsigned int, 3);
  itkSetObjectMacro( AffineTransform, EulerAffineTransformType );
  itkGetObjectMacro( AffineTransform, EulerAffineTransformType );

  virtual void GenerateOutputInformation(void);

  virtual void GenerateInputRequestedRegion(void);
  virtual void EnlargeOutputRequestedRegion(DataObject *output); 

  void SetTransformedImageSize(OutputImageSizeType &outImageSize) {m_OutputImageSize = outImageSize;};
  void SetTransformedImageSpacing(OutputImageSpacingType &outImageSpacing) {
    m_OutputImageSpacing = outImageSpacing;
    this->GetOutput()->SetSpacing(m_OutputImageSpacing);
  };
  void SetTransformedImageOrigin(OutputImagePointType &outImageOrigin) {
    m_OutputImageOrigin = outImageOrigin;
    this->GetOutput()->SetOrigin(m_OutputImageOrigin);
  };

  void SetSingleThreadedExecution(void) {m_FlagMultiThreadedExecution = false;}

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

  virtual void BeforeThreadedGenerateData(void);
  
  virtual void AfterThreadedGenerateData(void);
  
  void GenerateData();

  void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread,
                            ThreadIdType threadId );

  OutputImageSizeType m_OutputImageSize;
  OutputImageSpacingType m_OutputImageSpacing;
  OutputImagePointType m_OutputImageOrigin;

  bool m_FlagMultiThreadedExecution;

  FullMatrixType                                  m_affineCoreMatrix;
  FullMatrixType                                  m_affineCoreMatrixInverse;

  VectorType                                      m_inputCoordinateVector;
  VectorType                                      m_outputCoordinateVector;

  EulerAffineTransformType::Pointer               m_AffineTransform;

  SparseMatrixType                                m_sparseAffineTransformMatrix;

  SparseMatrixType                                m_sparseTransposeAffineTransformMatrix;

private:
  CreateEulerAffineTransformMatrix(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkCreateEulerAffineTransformMatrix.txx"
#endif

#endif