itkMatrixBasedSimulReconRegnMethod.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 itkMatrixBasedSimulReconRegnMethod_h
#define itkMatrixBasedSimulReconRegnMethod_h

#include <itkProcessObject.h>

#include <itkImage.h>
#include <itkProjectionGeometry.h>
#include <itkSingleValuedNonLinearOptimizer.h>

#include <itkReconstructionUpdateCommand.h>
#include <itkMatrixBasedSimulReconRegnMetric.h>
#include <itkEulerAffineTransformMatrixAndItsVariations.h>

namespace itk
{

template <class IntensityType = double>
class ITK_EXPORT MatrixBasedSimulReconRegnMethod : public ProcessObject 
{
public:
  typedef MatrixBasedSimulReconRegnMethod                           Self;
  typedef ProcessObject                                             Superclass;
  typedef SmartPointer<Self>                                        Pointer;
  typedef SmartPointer<const Self>                                  ConstPointer;

  typedef itk::ReconstructionUpdateCommand                          ReconstructionUpdateCommandType;
  typedef ReconstructionUpdateCommand::Pointer                      ReconstructionUpdateCommandPointer;
  
  itkNewMacro(Self);
  
  itkTypeMacro(MatrixBasedSimulReconRegnMethod, ProcessObject);

  // Some convenient typedefs.

  typedef Image<IntensityType, 3>                                       MatrixFormReconstructionType;
  typedef typename MatrixFormReconstructionType::Pointer                MatrixFormReconstructionPointer;
  typedef typename MatrixFormReconstructionType::RegionType             MatrixFormReconstructionRegionType;
  typedef typename MatrixFormReconstructionType::PixelType              MatrixFormReconstructionPixelType;
  typedef typename MatrixFormReconstructionType::SizeType               MatrixFormReconstructionSizeType;
  typedef typename MatrixFormReconstructionType::SpacingType            MatrixFormReconstructionSpacingType;
  typedef typename MatrixFormReconstructionType::PointType              MatrixFormReconstructionPointType;
  typedef typename MatrixFormReconstructionType::IndexType              MatrixFormReconstructionIndexType;

  typedef itk::EulerAffineTransformMatrixAndItsVariations< double >     AffineTransformerType;
  typedef AffineTransformerType::EulerAffineTransformType               EulerAffineTransformType;
  typedef typename EulerAffineTransformType::Pointer                    EulerAffineTransformPointer;

  typedef SingleValuedNonLinearOptimizer                                OptimizerType;
  typedef typename    OptimizerType::Pointer                            OptimizerPointer;

  typedef MatrixBasedSimulReconRegnMetric<double>                       MetricType;
  typedef typename MetricType::Pointer                                  MetricPointer;

  typedef itk::ProjectionGeometry<double>                               ProjectionGeometryType;
  typedef typename ProjectionGeometryType::Pointer                      ProjectionGeometryPointer;

  typedef typename MetricType::ParametersType                           ParametersType;

  typedef MatrixFormReconstructionType                                  MatrixFormReconstructionOutputType;
  typedef typename MatrixFormReconstructionOutputType::Pointer          MatrixFormReconstructionOutputPointer;
  typedef typename MatrixFormReconstructionOutputType::ConstPointer     MatrixFormReconstructionOutputConstPointer;
  
  itkSetObjectMacro( Optimizer,  OptimizerType );
  itkGetObjectMacro( Optimizer,  OptimizerType );

  itkSetObjectMacro( Metric, MetricType );
  itkGetObjectMacro( Metric, MetricType );

  itkSetObjectMacro( ProjectionGeometry, ProjectionGeometryType );
  itkGetObjectMacro( ProjectionGeometry, ProjectionGeometryType );

  itkSetObjectMacro( ReconstructionUpdateCommand, ReconstructionUpdateCommandType );
  itkGetObjectMacro( ReconstructionUpdateCommand, ReconstructionUpdateCommandType );

  void SetReconEstimate( MatrixFormReconstructionType *im3D);

  void SetAffineEstimate( EulerAffineTransformType *affinePara);

  void UpdateReconstructionEstimate( MatrixFormReconstructionType *im3D);
  void UpdateInitialParameters(void);

#if 0

  void UpdateReconstructionEstimateWithAverage( MatrixFormReconstructionType *im3D);

  bool SetInputProjectionVolume( MatrixFormReconstructionType *im2D);
#endif

  void SetMatrixFormReconstructedVolumeSize(MatrixFormReconstructionSizeType &reconSize) {m_ReconstructedVolumeSize = reconSize;};
  void SetMatrixFormReconstructedVolumeSpacing(MatrixFormReconstructionSpacingType &reconSpacing) {m_ReconstructedVolumeSpacing = reconSpacing;};
  void SetMatrixFormReconstructedVolumeOrigin(MatrixFormReconstructionPointType &reconOrigin) {m_ReconstructedVolumeOrigin = reconOrigin;};

  virtual void Initialise() throw (ExceptionObject);

#if 0

  MatrixFormReconstructionType *GetInput();
#endif

  MatrixFormReconstructionOutputType *GetOutput();

  MatrixFormReconstructionOutputType *GetReconstructedVolume() const;

  virtual DataObjectPointer MakeOutput(unsigned int idx);

  unsigned long GetMTime() const;  
    
protected:
  MatrixBasedSimulReconRegnMethod();
  virtual ~MatrixBasedSimulReconRegnMethod() {};
  void PrintSelf(std::ostream& os, Indent indent) const;

  virtual void GenerateOutputInformation() {};
  
  void StartMatrixFormReconstruction(void);

  void StartOptimization(void);

  void  GenerateData ();


private:
  MatrixBasedSimulReconRegnMethod(const Self&);   // purposely not implemented
  void operator=(const Self&);                    // purposely not implemented
  
  bool                                            m_FlagInitialised;

  OptimizerPointer                                m_Optimizer;
  MetricPointer                                   m_Metric;
  ProjectionGeometryPointer                       m_ProjectionGeometry;

  MatrixFormReconstructionPointer                 m_VolumeEstimate;
  EulerAffineTransformPointer                     m_EulerAffineEstimate;

  ParametersType                                  m_InitialParameters;
  ParametersType                                  m_LastParameters;
    
  MatrixFormReconstructionSizeType                m_ReconstructedVolumeSize;
  MatrixFormReconstructionSpacingType             m_ReconstructedVolumeSpacing;
  MatrixFormReconstructionPointType               m_ReconstructedVolumeOrigin;

  ReconstructionUpdateCommandPointer              m_ReconstructionUpdateCommand;

};


} // end namespace itk

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

#endif