itkWatershedSegmentTable.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkWatershedSegmentTable.h,v $
  Language:  C++
  Date:      $Date: 2009-01-27 19:30:18 $
  Version:   $Revision: 1.13 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkWatershedSegmentTable_h
#define __itkWatershedSegmentTable_h

#if defined(_MSC_VER)
#pragma warning ( disable : 4786 )
#endif

#include "itkObjectFactory.h"
#include "itkDataObject.h"
#include "itkProcessObject.h"
#include "itk_hash_map.h"
#include <list>
#include "itkOneWayEquivalencyTable.h"

namespace itk
{
namespace watershed
{
template <class TScalarType> 
class ITK_EXPORT SegmentTable : public DataObject
{
public:
  typedef SegmentTable             Self;
  typedef DataObject               Superclass;
  typedef SmartPointer<Self>       Pointer;
  typedef SmartPointer<const Self> ConstPointer;
  typedef TScalarType              ScalarType;
  itkNewMacro(Self);
  itkTypeMacro(WatershedSegmentTable, DataObject);

  struct edge_pair_t
    {
    edge_pair_t() {}
    edge_pair_t(unsigned long l, ScalarType s) : label(l), height(s) {}
    unsigned long label;
    ScalarType height;

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

    };
  
  typedef std::list<edge_pair_t>  edge_list_t;

  struct segment_t
  {
    ScalarType    min;
    edge_list_t   edge_list;
  };

  typedef itk::hash_map<unsigned long, segment_t, itk::hash<unsigned long> >
                                               HashMapType;
  typedef typename HashMapType::iterator       Iterator;
  typedef typename HashMapType::const_iterator ConstIterator;
  typedef typename HashMapType::value_type     ValueType;
  typedef typename HashMapType::data_type      DataType;

  bool Add(unsigned long a, const segment_t &t);

  void PruneEdgeLists(ScalarType maximum_saliency);

  segment_t *Lookup(const unsigned long a)
  {
    Iterator result = m_HashMap.find(a);
    if ( result == m_HashMap.end() ) return 0;
    else return &((*result).second);
  }

  const segment_t *Lookup(const unsigned long a) const
  {
    ConstIterator result = m_HashMap.find(a);
    if ( result == m_HashMap.end() ) return 0;
    else return &((*result).second);
  }

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

  void Erase(const unsigned long 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 unsigned long from, const unsigned long 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() {}
  virtual ~SegmentTable() {}

  HashMapType m_HashMap;
  ScalarType  m_MaximumDepth;
  
private:
  void operator=(const Self&) {}
  
};

}// end namespace watershed
}// end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkWatershedSegmentTable.txx"
#endif

#endif