itkImageReconstructionMetric.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 itkImageReconstructionMetric_h
#define itkImageReconstructionMetric_h

#include <itkImageToImageFilter.h>
#include <itkConceptChecking.h>
#include <itkSingleValuedCostFunction.h>
#include <itkForwardAndBackProjectionDifferenceFilter.h>


namespace itk
{
  
template <class IntensityType = float>
class ITK_EXPORT ImageReconstructionMetric : public SingleValuedCostFunction
{
public:

  typedef ImageReconstructionMetric    Self;
  typedef SingleValuedCostFunction     Superclass;
  typedef SmartPointer<Self>           Pointer;
  typedef SmartPointer<const Self>     ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ImageReconstructionMetric, SingleValuedCostFunction);

  typedef itk::ForwardAndBackProjectionDifferenceFilter<IntensityType> ForwardAndBackProjectionDifferenceFilterType;
  typedef typename ForwardAndBackProjectionDifferenceFilterType::Pointer ForwardAndBackProjectionDifferenceFilterPointerType;

  typedef typename ForwardAndBackProjectionDifferenceFilterType::InputVolumeType    InputVolumeType;
  typedef typename ForwardAndBackProjectionDifferenceFilterType::InputVolumePointer InputVolumePointer;

  typedef typename ForwardAndBackProjectionDifferenceFilterType::InputProjectionVolumeType InputProjectionVolumeType;
  typedef typename ForwardAndBackProjectionDifferenceFilterType::InputProjectionVolumePointer InputProjectionVolumePointer;

  typedef typename ForwardAndBackProjectionDifferenceFilterType::ProjectionGeometryType ProjectionGeometryType;
  typedef typename ForwardAndBackProjectionDifferenceFilterType::ProjectionGeometryPointer ProjectionGeometryPointer;

  typedef typename ForwardAndBackProjectionDifferenceFilterType::OutputBackProjectedDifferencesType OutputBackProjectedDifferencesType;
  typedef typename ForwardAndBackProjectionDifferenceFilterType::OutputBackProjectedDifferencesPointer OutputBackProjectedDifferencesPointer;
  

  typedef typename SingleValuedCostFunction::ParametersType ParametersType;
  typedef typename SingleValuedCostFunction::MeasureType    MeasureType;
  typedef typename SingleValuedCostFunction::DerivativeType DerivativeType;

  void SetInputVolume( InputVolumeType *im3D );

  void SetInputProjectionVolume( InputProjectionVolumeType *im2D );

  void SetProjectionGeometry( ProjectionGeometryType *projGeometry );

  unsigned int GetNumberOfParameters(void) const override;

  const InputVolumeType *GetReconstructedVolume(void) {
    return m_FwdAndBackProjDiffFilter->GetPointerToInputVolume();
  }

  void SetParametersAddress( const ParametersType & parameters ) const;
  void SetDerivativesAddress( const DerivativeType & derivatives ) const;

  void SetParameters( const ParametersType & parameters ) const;

  void SetIterativeReconEstimateFile( std::string filename ) {
    fileOutputCurrentEstimate = filename;
  }

  void SetIterativeReconEstimateSuffix( std::string suffix ) {
    suffixOutputCurrentEstimate = suffix;
  }

  void Initialise(void) {m_FwdAndBackProjDiffFilter->Initialise();}

  virtual void GetValueAndDerivative( const ParametersType & parameters,
                                      MeasureType & value,
                                      DerivativeType & derivative ) const override;

  virtual MeasureType GetValue( const ParametersType & parameters ) const override;

  virtual void GetDerivative( const ParametersType & parameters,
                              DerivativeType & derivative ) const override;


protected:

  ImageReconstructionMetric();
  virtual ~ImageReconstructionMetric() {};

  void PrintSelf(std::ostream& os, Indent indent) const override;

  std::string fileOutputCurrentEstimate;
  std::string suffixOutputCurrentEstimate;

  ForwardAndBackProjectionDifferenceFilterPointerType m_FwdAndBackProjDiffFilter;


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

} // end namespace itk

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

#endif