itkShapeSignedDistanceFunction.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkShapeSignedDistanceFunction_h
#define itkShapeSignedDistanceFunction_h
 
#include "itkSpatialFunction.h"
#include "itkOptimizerParameters.h"
 
namespace itk
{
template <typename TCoordinate, unsigned int VSpaceDimension>
class ITK_TEMPLATE_EXPORT ShapeSignedDistanceFunction
  : public SpatialFunction<double, VSpaceDimension, Point<TCoordinate, VSpaceDimension>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ShapeSignedDistanceFunction);
 
  using Self = ShapeSignedDistanceFunction;
  using Superclass = SpatialFunction<double, VSpaceDimension, Point<TCoordinate, VSpaceDimension>>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkOverrideGetNameOfClassMacro(ShapeSignedDistanceFunction);
 
  using typename Superclass::OutputType;
 
  using typename Superclass::InputType;
 
  static constexpr unsigned int SpaceDimension = VSpaceDimension;
 
  using CoordinateType = TCoordinate;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif
 
  using PointType = InputType;
 
  using ParametersType = OptimizerParameters<double>;
 
  virtual void
  SetParameters(const ParametersType &) = 0;
 
  virtual ParametersType &
  GetParameters()
  {
    return m_Parameters;
  }
  virtual unsigned int
  GetNumberOfShapeParameters() const = 0;
 
  virtual unsigned int
  GetNumberOfPoseParameters() const = 0;
 
  virtual unsigned int
  GetNumberOfParameters() const
  {
    return this->GetNumberOfShapeParameters() + this->GetNumberOfPoseParameters();
  }
 
  OutputType
  Evaluate(const PointType & point) const override = 0;
 
  virtual void
  Initialize()
  {}
 
protected:
  ShapeSignedDistanceFunction() = default;
 
  ~ShapeSignedDistanceFunction() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
    // FIX    os << indent << "Parameters: " << m_Parameters << std::endl;
  }
 
  ParametersType m_Parameters{};
};
} // end namespace itk
 
#endif