itkWarpHarmonicEnergyCalculator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkWarpHarmonicEnergyCalculator_h
#define itkWarpHarmonicEnergyCalculator_h

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

namespace itk
{
template< typename TInputImage >
class ITK_TEMPLATE_EXPORT WarpHarmonicEnergyCalculator:public Object
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(WarpHarmonicEnergyCalculator);

  using Self = WarpHarmonicEnergyCalculator;
  using Superclass = Object;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(WarpHarmonicEnergyCalculator, Object);

  using ImageType = TInputImage;

  using ImagePointer = typename TInputImage::Pointer;

  using ImageConstPointer = typename TInputImage::ConstPointer;

  using PixelType = typename TInputImage::PixelType;

  using IndexType = typename TInputImage::IndexType;

  using RegionType = typename TInputImage::RegionType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  static constexpr unsigned int VectorDimension = PixelType::Dimension;

  using ConstNeighborhoodIteratorType = ConstNeighborhoodIterator< ImageType >;
  using RadiusType = typename ConstNeighborhoodIteratorType::RadiusType;

  void SetUseImageSpacing(bool);
  itkGetConstMacro(UseImageSpacing, bool);
  itkBooleanMacro(UseImageSpacing);

  using WeightsType = FixedArray< double, ImageDimension >;

  itkSetMacro(DerivativeWeights, WeightsType);
  itkGetConstReferenceMacro(DerivativeWeights, WeightsType);

  itkSetConstObjectMacro(Image, ImageType);

  void Compute();

  itkGetConstMacro(HarmonicEnergy, double);

  void SetRegion(const RegionType & region);

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

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

  double EvaluateAtNeighborhood(ConstNeighborhoodIteratorType & it) const;

private:
  double            m_HarmonicEnergy;
  ImageConstPointer m_Image;

  RegionType m_Region;
  bool       m_RegionSetByUser;

  bool m_UseImageSpacing;

  WeightsType m_DerivativeWeights;

  RadiusType m_NeighborhoodRadius;
};
} // end namespace itk

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

#endif /* itkWarpHarmonicEnergyCalculator_h */