itkHilbertPath.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 itkHilbertPath_h
#define itkHilbertPath_h
 
#include "itkPath.h"
 
#include "itkNumericTraits.h"
 
namespace itk
{
template <typename TIndexValue = unsigned int, unsigned int VDimension = 3>
class ITK_TEMPLATE_EXPORT HilbertPath : public Path<TIndexValue, Index<VDimension>, VDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HilbertPath);

  using Self = HilbertPath<TIndexValue, VDimension>;
  using Superclass = Path<unsigned int, Index<VDimension>, VDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(HilbertPath);

  itkNewMacro(Self);

  static constexpr unsigned int Dimension = VDimension;

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

  using PathIndexType = InputType;
  using IndexType = OutputType;
  using HilbertOrderType = unsigned int;
  using HilbertPathType = std::vector<IndexType>;
  using HilbertPathSizeType = typename HilbertPathType::size_type;
  using typename Superclass::OffsetType;
 
  // Functions inherited from Path

  OutputType
  Evaluate(const PathIndexType & input) const override
  {
    return this->m_HilbertPath[input];
  }
 
  OutputType
  EvaluateToIndex(const PathIndexType & input) const override
  {
    return this->m_HilbertPath[input];
  }

  virtual InputType
  EvaluateInverse(const IndexType & input)
  {
    return this->TransformMultiDimensionalIndexToPathIndex(input);
  }

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

  OffsetType
  IncrementInput(InputType & itkNotUsed(input)) const override
  {
    itkExceptionMacro("Not implemented.");
  }

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


  virtual inline HilbertPathSizeType
  NumberOfSteps() const
  {
    return m_HilbertPath.size();
  }

  void
  Initialize() override
  {
    this->Clear();
    this->ConstructHilbertPath();
  }


  itkSetClampMacro(HilbertOrder, HilbertOrderType, 1, NumericTraits<HilbertOrderType>::max());
  itkGetConstMacro(HilbertOrder, HilbertOrderType);

  IndexType
  TransformPathIndexToMultiDimensionalIndex(const PathIndexType id);

  PathIndexType
  TransformMultiDimensionalIndexToPathIndex(const IndexType & index);
 
protected:
  HilbertPath();
  ~HilbertPath() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  void
  ConstructHilbertPath();
 
  PathIndexType
  GetTransform(const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType);
 
  PathIndexType
  GetInverseTransform(const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType);
 
  PathIndexType
  GetGrayCode(const PathIndexType);
 
  PathIndexType
  GetInverseGrayCode(const PathIndexType);
 
  PathIndexType
  SetBit(const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType);
 
  PathIndexType
  GetRightBitRotation(PathIndexType, PathIndexType, const PathIndexType);
 
  PathIndexType
  GetLeftBitRotation(PathIndexType, PathIndexType, const PathIndexType);
 
  PathIndexType
  GetTrailingSetBits(const PathIndexType, const PathIndexType);
 
  PathIndexType
  GetDirection(const PathIndexType, const PathIndexType);
 
  PathIndexType
  GetEntry(const PathIndexType);
 
  PathIndexType
  GetBitRange(const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType);
 
  HilbertOrderType m_HilbertOrder{ 1 };
  HilbertPathType  m_HilbertPath{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkHilbertPath.hxx"
#endif
 
#endif