itkWatershedSegmentTree.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 itkWatershedSegmentTree_h
#define itkWatershedSegmentTree_h
 
#include "itkProcessObject.h"
#include <deque>
#include <functional>
 
namespace itk
{
namespace watershed
{
template <typename TScalar>
class ITK_TEMPLATE_EXPORT SegmentTree : public DataObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SegmentTree);

  using Self = SegmentTree;
  using Superclass = DataObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  itkNewMacro(Self);
  itkOverrideGetNameOfClassMacro(SegmentTree);
  using ScalarType = TScalar;

  struct merge_t
  {
    IdentifierType from;
    IdentifierType to;
    ScalarType     saliency;
  };


  using DequeType = std::deque<merge_t>;
  using Iterator = typename DequeType::iterator;
  using ConstIterator = typename DequeType::const_iterator;
  using ValueType = typename DequeType::value_type;

  struct merge_comp
  {
    merge_comp() = default;
    bool
    operator()(const merge_t & a, const merge_t & b)
    {
      return b.saliency < a.saliency;
    }
  };


  struct sort_comp
  {
    bool
    operator()(const merge_t & a, const merge_t & b)
    {
      return a.saliency < b.Saliency;
    }
  };

  typename DequeType::size_type
  Size() const
  {
    return m_Deque.size();
  }

  bool
  Empty() const
  {
    return m_Deque.empty();
  }

  const merge_t &
  Front() const
  {
    return m_Deque.front();
  }

  const merge_t &
  Back() const
  {
    return m_Deque.back();
  }

  merge_t &
  Front()
  {
    return m_Deque.front();
  }

  merge_t &
  Back()
  {
    return m_Deque.back();
  }

  void
  PushFront(const ValueType & t)
  {
    m_Deque.push_front(t);
  }

  void
  PushBack(const ValueType & t)
  {
    m_Deque.push_back(t);
  }

  void
  PopFront()
  {
    m_Deque.pop_front();
  }

  void
  PopBack()
  {
    m_Deque.pop_back();
  }

  Iterator
  Begin()
  {
    return m_Deque.begin();
  }

  ConstIterator
  Begin() const
  {
    return m_Deque.begin();
  }

  Iterator
  End()
  {
    return m_Deque.end();
  }

  ConstIterator
  End() const
  {
    return m_Deque.end();
  }

  void
  Clear()
  {
    m_Deque.clear();
  }

  void
  Initialize() override;
 
protected:
  SegmentTree() = default;
  ~SegmentTree() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  DequeType m_Deque{};
};
} // end namespace watershed
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkWatershedSegmentTree.hxx"
#endif
 
#endif