itkNarrowBand.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 itkNarrowBand_h
#define itkNarrowBand_h
 
#include "itkLightObject.h"
#include "itkObjectFactory.h"
#include "itkNumericTraits.h"
#include <vector>
 
namespace itk
{
 
template <typename TIndexType, typename TDataType>
class ITK_TEMPLATE_EXPORT BandNode
{
public:
  TDataType   m_Data;
  TIndexType  m_Index;
  signed char m_NodeState{ 0 };
  BandNode()
    : m_Data(TDataType{})
  {}
};

template <typename NodeType>
class ITK_TEMPLATE_EXPORT NarrowBand : public LightObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(NarrowBand);

  using Self = NarrowBand;
  using Superclass = LightObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(NarrowBand);
 
  using NodeContainerType = std::vector<NodeType>;
  using SizeType = typename NodeContainerType::size_type;
  using ConstIterator = typename NodeContainerType::const_iterator;
  using Iterator = typename NodeContainerType::iterator;

  struct RegionType
  {
    Iterator Begin;
    Iterator End;
  };

#if !defined(ITK_WRAPPING_PARSER)
  std::vector<RegionType>
  SplitBand(const SizeType &);
 
#endif
 
  Iterator
  Begin()
  {
    return m_NodeContainer.begin();
  }
 
  ConstIterator
  Begin() const
  {
    return m_NodeContainer.begin();
  }
 
  Iterator
  End()
  {
    return m_NodeContainer.end();
  }
 
  ConstIterator
  End() const
  {
    return m_NodeContainer.end();
  }
 
  SizeType
  Size() const
  {
    return m_NodeContainer.size();
  }
 
  bool
  Empty() const
  {
    return m_NodeContainer.empty();
  }

  void
  Clear()
  {
    m_NodeContainer.clear();
  }
 
  void
  Reserve(SizeType n)
  {
    m_NodeContainer.reserve(n);
  }
 
  void
  PushBack(const NodeType & n)
  {
    m_NodeContainer.push_back(n);
  }
 
  void
  PopBack()
  {
    m_NodeContainer.pop_back();
  }
 
  void
  Resize(SizeType n)
  {
    m_NodeContainer.resize(n);
  }
 
  NodeType &
  operator[](SizeType n)
  {
    return m_NodeContainer[n];
  }
 
  const NodeType &
  operator[](SizeType n) const
  {
    return m_NodeContainer[n];
  }

  void
  SetTotalRadius(const float val)
  {
    m_TotalRadius = val;
  }
 
  float
  GetTotalRadius() const
  {
    return m_TotalRadius;
  }

  void
  SetInnerRadius(const float val)
  {
    m_InnerRadius = val;
  }
 
  float
  GetInnerRadius() const
  {
    return m_InnerRadius;
  }
 
protected:
  NarrowBand() = default;
 
  float m_TotalRadius{ 0.0 };
  float m_InnerRadius{ 0.0 };
 
private:
  NodeContainerType m_NodeContainer{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkNarrowBand.hxx"
#endif
 
#endif