itkParametricPath.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 itkParametricPath_h
#define itkParametricPath_h
 
#include "itkImageBase.h"
#include "itkPath.h"
#include "itkContinuousIndex.h"
#include "itkOffset.h"
#include "itkVector.h"
 
namespace itk
{
template <unsigned int VDimension>
class ITK_TEMPLATE_EXPORT ParametricPath
  : public Path<double, ContinuousIndex<SpacePrecisionType, VDimension>, VDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ParametricPath);

  using Self = ParametricPath;

  using ContinuousIndexType = ContinuousIndex<SpacePrecisionType, VDimension>;
  using Superclass = Path<double, ContinuousIndexType, VDimension>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ParametricPath);

  using typename Superclass::InputType;

  using typename Superclass::OutputType;
 
  using IndexType = Index<VDimension>;
  using OffsetType = Offset<VDimension>;
  using VectorType = Vector<double, VDimension>;

  IndexType
  EvaluateToIndex(const InputType & input) const override;

  OffsetType
  IncrementInput(InputType & input) const override;

  virtual VectorType
  EvaluateDerivative(const InputType & input) const;
 
  itkSetMacro(DefaultInputStepSize, InputType);
  itkGetConstReferenceMacro(DefaultInputStepSize, InputType);
 
protected:
  ParametricPath();
  ~ParametricPath() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  InputType m_DefaultInputStepSize{};
};

 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkParametricPath.hxx"
#endif
 
#endif // itkParametricPath.h