itkNeighborhood.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 itkNeighborhood_h
#define itkNeighborhood_h
 
#include <iostream>
#include "itkNeighborhoodAllocator.h"
#include "itkIndent.h"
#include "itkSliceIterator.h"
#include "vnl/vnl_vector.h"
#include "itkOffset.h"
#include <vector>
 
namespace itk
{
 
template <typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
class ITK_TEMPLATE_EXPORT Neighborhood
{
public:
  using Self = Neighborhood;

  using AllocatorType = TAllocator;

  static constexpr unsigned int NeighborhoodDimension = VDimension;

  itkVirtualGetNameOfClassMacro(Neighborhood);

  using PixelType = TPixel;

  using Iterator = typename AllocatorType::iterator;
  using ConstIterator = typename AllocatorType::const_iterator;

  using SizeType = itk::Size<VDimension>;
  using SizeValueType = typename SizeType::SizeValueType;

  using RadiusType = itk::Size<VDimension>;

  using OffsetType = Offset<VDimension>;

  using SliceIteratorType = SliceIterator<TPixel, Self>;

  using DimensionValueType = unsigned int;

  using NeighborIndexType = SizeValueType;

  Neighborhood() = default;

  virtual ~Neighborhood() = default;

  Neighborhood(const Self &) = default;

  Neighborhood(Self &&) = default;

  Self &
  operator=(const Self &) = default;

  Self &
  operator=(Self &&) = default;

  bool
  operator==(const Self & other) const
  {
    return (m_Radius == other.m_Radius && m_Size == other.m_Size && m_DataBuffer == other.m_DataBuffer);
  }
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self);

  const SizeType
  GetRadius() const
  {
    return m_Radius;
  }

  SizeValueType
  GetRadius(DimensionValueType n) const
  {
    return m_Radius.at(n);
  }

  SizeValueType
  GetSize(DimensionValueType n) const
  {
    return m_Size.at(n);
  }

  SizeType
  GetSize() const
  {
    return m_Size;
  }

  OffsetValueType
  GetStride(DimensionValueType axis) const
  {
    return (axis < VDimension) ? m_StrideTable[axis] : 0;
  }

  Iterator
  End()
  {
    return m_DataBuffer.end();
  }
  Iterator
  Begin()
  {
    return m_DataBuffer.begin();
  }
  ConstIterator
  End() const
  {
    return m_DataBuffer.end();
  }
  ConstIterator
  Begin() const
  {
    return m_DataBuffer.begin();
  }


  NeighborIndexType
  Size() const
  {
    return m_DataBuffer.size();
  }

  TPixel &
  operator[](NeighborIndexType i)
  {
    return m_DataBuffer[i];
  }
  const TPixel &
  operator[](NeighborIndexType i) const
  {
    return m_DataBuffer[i];
  }
  TPixel &
  GetElement(NeighborIndexType i)
  {
    return m_DataBuffer[i];
  }


  TPixel
  GetCenterValue() const
  {
    return (this->operator[]((this->Size()) >> 1));
  }

  void
  SetRadius(const SizeType &);

  void
  SetRadius(const SizeValueType * rad)
  {
    SizeType s;
    std::copy_n(rad, VDimension, s.m_InternalArray);
    this->SetRadius(s);
  }


  void
  SetRadius(const SizeValueType);

  void
  Print(std::ostream & os) const
  {
    this->PrintSelf(os, Indent(0));
  }

  AllocatorType &
  GetBufferReference()
  {
    return m_DataBuffer;
  }
  const AllocatorType &
  GetBufferReference() const
  {
    return m_DataBuffer;
  }


  TPixel &
  operator[](const OffsetType & o)
  {
    return this->operator[](this->GetNeighborhoodIndex(o));
  }
  const TPixel &
  operator[](const OffsetType & o) const
  {
    return this->operator[](this->GetNeighborhoodIndex(o));
  }


  OffsetType
  GetOffset(NeighborIndexType i) const
  {
    return m_OffsetTable[i];
  }
 
  virtual NeighborIndexType
  GetNeighborhoodIndex(const OffsetType &) const;
 
  NeighborIndexType
  GetCenterNeighborhoodIndex() const
  {
    return static_cast<NeighborIndexType>(this->Size() / 2);
  }
 
  std::slice
  GetSlice(unsigned int) const;
 
protected:
  void
  SetSize()
  {
    for (DimensionValueType i = 0; i < VDimension; ++i)
    {
      m_Size[i] = m_Radius[i] * 2 + 1;
    }
  }


  virtual void
  Allocate(NeighborIndexType i)
  {
    m_DataBuffer.set_size(i);
  }

  virtual void
  PrintSelf(std::ostream &, Indent) const;

  virtual void
  ComputeNeighborhoodStrideTable();

  virtual void
  ComputeNeighborhoodOffsetTable();
 
private:
  SizeType m_Radius{ { 0 } };

  SizeType m_Size{ { 0 } };

  AllocatorType m_DataBuffer{};

  OffsetValueType m_StrideTable[VDimension]{ 0 };

  std::vector<OffsetType> m_OffsetTable{};
};
 
template <typename TPixel, unsigned int VDimension, typename TContainer>
std::ostream &
operator<<(std::ostream & os, const Neighborhood<TPixel, VDimension, TContainer> & neighborhood)
{
  os << "Neighborhood: " << std::endl;
  os << "    Radius: " << neighborhood.GetRadius() << std::endl;
  os << "    Size: " << neighborhood.GetSize() << std::endl;
  os << "    DataBuffer: " << neighborhood.GetBufferReference() << std::endl;
 
  return os;
}
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkNeighborhood.hxx"
#endif
 
#endif