itkWatershedSegmentTable.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 itkWatershedSegmentTable_h
#define itkWatershedSegmentTable_h
 
 
#include "itkDataObject.h"
#include <list>
#include "itkOneWayEquivalencyTable.h"
 
namespace itk
{
namespace watershed
{
template <typename TScalar>
class ITK_TEMPLATE_EXPORT SegmentTable : public DataObject
{
public:

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

  struct edge_pair_t
  {
    edge_pair_t() = default;
    edge_pair_t(IdentifierType l, ScalarType s)
      : label(l)
      , height(s)
    {}
 
    IdentifierType label;
    ScalarType     height;

    bool
    operator<(const edge_pair_t & o) const
    {
      if (this->height < o.height)
      {
        return true;
      }
 
      return false;
    }
  };

  using edge_list_t = std::list<edge_pair_t>;

  struct segment_t
  {
    ScalarType  min;
    edge_list_t edge_list;
  };

  using HashMapType = std::unordered_map<IdentifierType, segment_t>;
  using Iterator = typename HashMapType::iterator;
  using ConstIterator = typename HashMapType::const_iterator;
  using ValueType = typename HashMapType::value_type;
  using DataType = typename HashMapType::mapped_type;

  bool
  Add(IdentifierType a, const segment_t & t);

  void
  PruneEdgeLists(ScalarType maximum_saliency);

  segment_t *
  Lookup(const IdentifierType a)
  {
    auto result = m_HashMap.find(a);
 
    if (result == m_HashMap.end())
    {
      return nullptr;
    }
 
    return &(result->second);
  }

  const segment_t *
  Lookup(const IdentifierType a) const
  {
    ConstIterator result = m_HashMap.find(a);
 
    if (result == m_HashMap.end())
    {
      return 0;
    }
 
    return &(result->second);
  }

  bool
  IsEntry(const IdentifierType a) const
  {
    if (m_HashMap.find(a) == m_HashMap.end())
    {
      return false;
    }
 
    return true;
  }

  void
  Erase(const IdentifierType a)
  {
    m_HashMap.erase(a);
  }

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

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

  void
  SortEdgeLists();

  typename HashMapType::size_type
  Size() const
  {
    return m_HashMap.size();
  }

  //  void Merge(const IdentifierType from, const IdentifierType to);

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

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

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

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

  unsigned int
  GetSegmentMemorySize() const
  {
    return sizeof(segment_t);
  }
 
  //  void PrintHashTable() const;

  void
  SetMaximumDepth(ScalarType s)
  {
    m_MaximumDepth = s;
    this->Modified();
  }

 
  ScalarType
  GetMaximumDepth() const
  {
    return m_MaximumDepth;
  }

  void
  Copy(const Self & o)
  {
    m_HashMap = o.m_HashMap;
    m_MaximumDepth = o.m_MaximumDepth;
  }
 
protected:
  SegmentTable()
    : m_MaximumDepth(0)
  {}
  ~SegmentTable() override = default;
 
  HashMapType m_HashMap{};
 
  ScalarType m_MaximumDepth{};
 
private:
  void
  operator=(const Self &)
  {}
};
} // end namespace watershed
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkWatershedSegmentTable.hxx"
#endif
 
#endif