itkWarpHarmonicEnergyCalculator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkWarpHarmonicEnergyCalculator.h,v $
  Language:  C++
  Date:      $Date: 2008-09-30 18:07:03 $
  Version:   $Revision: 1.3 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

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

#ifndef __itkWarpHarmonicEnergyCalculator_h
#define __itkWarpHarmonicEnergyCalculator_h

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkImage.h"
#include "itkVector.h"

namespace itk
{

template <class TInputImage>
class ITK_EXPORT WarpHarmonicEnergyCalculator : public Object
{
public:
  typedef WarpHarmonicEnergyCalculator          Self;
  typedef Object                                Superclass;
  typedef SmartPointer<Self>                    Pointer;
  typedef SmartPointer<const Self>              ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(WarpHarmonicEnergyCalculator, Object);

  typedef TInputImage                           ImageType;

  typedef typename TInputImage::Pointer         ImagePointer;

  typedef typename TInputImage::ConstPointer    ImageConstPointer;

  typedef typename TInputImage::PixelType PixelType;

  typedef typename TInputImage::IndexType IndexType;

  typedef typename TInputImage::RegionType RegionType;

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

  itkStaticConstMacro(VectorDimension, unsigned int,
                      PixelType::Dimension);

  typedef ConstNeighborhoodIterator<ImageType> ConstNeighborhoodIteratorType;
  typedef typename ConstNeighborhoodIteratorType::RadiusType RadiusType;

  void SetUseImageSpacingOn()
    {
    this->SetUseImageSpacing(true);
    }

  void SetUseImageSpacingOff()
    {
    this->SetUseImageSpacing(false);
    }

  void SetUseImageSpacing(bool);
  itkGetMacro(UseImageSpacing, bool);

  void SetDerivativeWeights(double data[]);
  itkGetVectorMacro(DerivativeWeights, const double, ::itk::GetImageDimension<TInputImage>::ImageDimension);

  itkSetConstObjectMacro(Image,ImageType);

  void Compute(void);

  itkGetMacro(HarmonicEnergy,double);

  void SetRegion( const RegionType & region );

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

  itkGetConstReferenceMacro( NeighborhoodRadius, RadiusType );
  itkSetMacro( NeighborhoodRadius, RadiusType );

  double EvaluateAtNeighborhood( ConstNeighborhoodIteratorType &it ) const;

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

  double               m_HarmonicEnergy;
  ImageConstPointer    m_Image;

  RegionType           m_Region;
  bool                 m_RegionSetByUser;

  bool m_UseImageSpacing;

  double m_DerivativeWeights[::itk::GetImageDimension<TInputImage>::ImageDimension];

  RadiusType    m_NeighborhoodRadius;
};

} // end namespace itk

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

#endif /* __itkWarpHarmonicEnergyCalculator_h */