itkShapePriorMAPCostFunctionBase.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 itkShapePriorMAPCostFunctionBase_h
#define itkShapePriorMAPCostFunctionBase_h

#include "itkSingleValuedCostFunction.h"
#include "itkLevelSet.h"
#include "itkShapeSignedDistanceFunction.h"

namespace itk
{
template< typename TFeatureImage, typename TOutputPixel >
class ITK_TEMPLATE_EXPORT ShapePriorMAPCostFunctionBase:
  public SingleValuedCostFunction
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ShapePriorMAPCostFunctionBase);

  using Self = ShapePriorMAPCostFunctionBase;
  using Superclass = SingleValuedCostFunction;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(ShapePriorMAPCostFunctionBase, SingleValuedCostFunction);

  using MeasureType = typename Superclass::MeasureType;

  using DerivativeType = typename Superclass::DerivativeType;

  using ParametersType = typename Superclass::ParametersType;

  using FeatureImageType = TFeatureImage;
  using FeatureImagePointer = typename FeatureImageType::ConstPointer;

  static constexpr unsigned int ImageDimension = TFeatureImage::ImageDimension;

  using PixelType = TOutputPixel;

  using NodeType = LevelSetNode< PixelType, Self::ImageDimension >;

  using NodeContainerType = VectorContainer< unsigned int, NodeType >;
  using NodeContainerPointer = typename NodeContainerType::ConstPointer;

  using ShapeFunctionType = ShapeSignedDistanceFunction< double,
                                       Self::ImageDimension >;
  using ShapeFunctionPointer = typename ShapeFunctionType::Pointer;

  itkSetObjectMacro(ShapeFunction, ShapeFunctionType);
  itkGetModifiableObjectMacro(ShapeFunction, ShapeFunctionType);

  itkSetConstObjectMacro(ActiveRegion, NodeContainerType);
  itkGetConstObjectMacro(ActiveRegion, NodeContainerType);

  itkSetConstObjectMacro(FeatureImage, FeatureImageType);
  itkGetConstObjectMacro(FeatureImage, FeatureImageType);

  MeasureType GetValue(const ParametersType & parameters) const override;

  void GetDerivative(const ParametersType &, DerivativeType &) const override
  { itkExceptionMacro(<< "This function is currently not supported."); }

  unsigned int GetNumberOfParameters() const override
  { return m_ShapeFunction->GetNumberOfParameters(); }

  virtual MeasureType ComputeLogInsideTerm(const ParametersType &) const = 0;

  virtual MeasureType ComputeLogGradientTerm(const ParametersType &) const = 0;

  virtual MeasureType ComputeLogShapePriorTerm(const ParametersType &) const = 0;

  virtual MeasureType ComputeLogPosePriorTerm(const ParametersType &) const = 0;

  virtual void Initialize();

protected:
  ShapePriorMAPCostFunctionBase();
  ~ShapePriorMAPCostFunctionBase() override = default;

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

  ShapeFunctionPointer m_ShapeFunction;
  NodeContainerPointer m_ActiveRegion;

  FeatureImagePointer m_FeatureImage;
};
} // end namespace itk

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

#endif