itkPath.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 itkPath_h
#define itkPath_h
 
#include "itkDataObject.h"
#include "itkIndex.h"
#include "itkNumericTraits.h"
 
namespace itk
{
template <typename TInput, typename TOutput, unsigned int VDimension>
class ITK_TEMPLATE_EXPORT Path : public DataObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(Path);

  using Self = Path;
  using Superclass = DataObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  static constexpr unsigned int PathDimension = VDimension;

  itkOverrideGetNameOfClassMacro(Path);

  using InputType = TInput;

  using OutputType = TOutput;

  using IndexType = Index<VDimension>;
  using OffsetType = Offset<VDimension>;

  virtual inline InputType
  StartOfInput() const
  {
    return InputType{};
  }

  virtual inline InputType
  EndOfInput() const
  {
    return NumericTraits<InputType>::OneValue();
  }

  virtual OutputType
  Evaluate(const InputType & input) const = 0;

  virtual IndexType
  EvaluateToIndex(const InputType & input) const = 0;

  virtual OffsetType
  IncrementInput(InputType & input) const = 0;
 
protected:
  Path();
  ~Path() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  itkGetConstMacro(ZeroOffset, OffsetType);
  itkGetConstMacro(ZeroIndex, IndexType);
 
private:
  // These "constants" are initialized in the constructor
  OffsetType m_ZeroOffset{}; // = 0 for all dimensions
  IndexType  m_ZeroIndex{};  // = 0 for all dimensions
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPath.hxx"
#endif
 
#endif