itkCreateForwardBackwardProjectionMatrix.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 itkCreateForwardBackwardProjectionMatrix_h
#define itkCreateForwardBackwardProjectionMatrix_h

#include <itkRay.h>
#include <itkImageProjectionBaseClass2D3D.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 CreateForwardBackwardProjectionMatrix :
    public ImageProjectionBaseClass2D3D<Image< IntensityType, 3>,  // Input image
          Image< IntensityType, 2> > // Output image
{
public:
  typedef CreateForwardBackwardProjectionMatrix  Self;
  typedef SmartPointer<Self>                     Pointer;
  typedef SmartPointer<const Self>               ConstPointer;
  typedef ImageProjectionBaseClass2D3D<Image< IntensityType, 3>,
               Image< IntensityType, 2> >   Superclass;

  itkNewMacro(Self);

  itkTypeMacro(CreateForwardBackwardProjectionMatrix, ProcessObject);

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

  typedef Image<IntensityType, 2>               OutputImageType;
  typedef typename OutputImageType::Pointer     OutputImagePointer;
  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 vnl_sparse_matrix<double>             SparseMatrixType;
  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, 2);

  virtual void GenerateOutputInformation(void);

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

  void SetProjectedImageSize(OutputImageSizeType &outImageSize) {m_OutputImageSize = outImageSize;};
  void SetProjectedImageSpacing(OutputImageSpacingType &outImageSpacing) {
    m_OutputImageSpacing = outImageSpacing;
    this->GetOutput()->SetSpacing(m_OutputImageSpacing);
  };
  void SetProjectedImageOrigin(OutputImagePointType &outImageOrigin) {
    m_OutputImageOrigin = outImageOrigin;
    this->GetOutput()->SetOrigin(m_OutputImageOrigin);
  };

  void SetRayIntegrationThreshold(double threshold) {m_Threshold = threshold;}

  void SetSingleThreadedExecution(void) {m_FlagMultiThreadedExecution = false;}

protected:
  CreateForwardBackwardProjectionMatrix();
  virtual ~CreateForwardBackwardProjectionMatrix(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;

  double m_Threshold;

  bool m_FlagMultiThreadedExecution;

  typedef enum {
    UNDEFINED_DIRECTION=0,        
    TRANSVERSE_IN_X,              
    TRANSVERSE_IN_Y,              
    TRANSVERSE_IN_Z,              
    LAST_DIRECTION
  } TraversalDirection;

  SparseMatrixType m_sparseForwardProjMatrix;

  SparseMatrixType m_sparseBackwardProjMatrix;

  VectorType       m_outputVectorPerThread;
  VectorMapType    m_outputVectorAllThread;

  VectorType       m_outputVectorBackProjPerThread;
  VectorMapType    m_outputVectorBackProjAllThread;


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

};

} // end namespace itk

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

#endif