itkChainCodePath.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 itkChainCodePath_h
#define itkChainCodePath_h
 
#include "itkPath.h"
#include "itkOffset.h"
#include "itkObjectFactory.h"
 
#include <vector>
 
namespace itk
{
template <unsigned int VDimension>
class ITK_TEMPLATE_EXPORT ChainCodePath : public Path<unsigned int, Offset<VDimension>, VDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ChainCodePath);

  static constexpr unsigned int Dimension = VDimension;

  using Self = ChainCodePath<VDimension>;
  using Superclass = Path<unsigned int, Offset<VDimension>, VDimension>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ChainCodePath);

  using typename Superclass::OutputType;
  using typename Superclass::InputType;

  using OffsetType = OutputType;
  using IndexType = Index<VDimension>;
 
  using ChainCodeType = std::vector<OffsetType>;
 
  using ChainCodeSizeType = typename ChainCodeType::size_type;
 
  // Functions inherited from Path

  OutputType
  Evaluate(const InputType & input) const override
  {
    return m_Chain[input];
  }

  IndexType
  EvaluateToIndex(const InputType & input) const override;

  OffsetType
  IncrementInput(InputType & input) const override;

  InputType
  EndOfInput() const override
  {
    return static_cast<InputType>(NumberOfSteps()); // 0 is before the first step, 1 is after it
  }

  itkNewMacro(Self);

  itkSetMacro(Start, IndexType);
  itkGetConstReferenceMacro(Start, IndexType);

  virtual inline void
  InsertStep(InputType position, OffsetType step)
  {
    m_Chain.insert(m_Chain.begin() + position, step);
    this->Modified();
  }

  virtual inline void
  ChangeStep(InputType position, OffsetType step)
  {
    m_Chain[position] = step;
    this->Modified();
  }

  virtual inline void
  Clear()
  {
    m_Chain.clear();
    this->Modified();
  }

  virtual inline ChainCodeSizeType
  NumberOfSteps() const
  {
    return m_Chain.size();
  }

  void
  Initialize() override
  {
    m_Start = this->GetZeroIndex();
    this->Clear();
  }
 
protected:
  ChainCodePath();
  ~ChainCodePath() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  IndexType     m_Start{}; // origin image index for the path
  ChainCodeType m_Chain{}; // the chain code (vector of offsets)
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkChainCodePath.hxx"
#endif
 
#endif