cmtkRegionIndexIterator.h

Go to the documentation of this file.

/*
//
//  Copyright 2010 SRI International
//
//  Copyright 2010 Torsten Rohlfing
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2455 $
//
//  $LastChangedDate: 2010-10-18 13:35:29 -0700 (Mon, 18 Oct 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkRegionIndexIterator_h_included_
#define __cmtkRegionIndexIterator_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkRegion.h>
#include <Base/cmtkFixedVector.h>

#include <System/cmtkSmartPtr.h>
#include <System/cmtkSmartConstPtr.h>

namespace
cmtk
{
template<size_t NDIM,typename T=int>
class RegionIndexIterator
{
public:
  typedef RegionIndexIterator<NDIM,T> Self;

  typedef Region<NDIM,T> RegionType;

  typedef FixedVector<NDIM,T> IndexType;

  typedef SmartPointer<Self> SmartPtr;

  typedef SmartConstPointer<Self> SmartConstPtr;

  RegionIndexIterator( const typename Self::RegionType& region )
    : m_Region( region ),
      m_Index( region.begin() )
  {}

  Self& operator++()
  {
    for ( size_t idx = NDIM; idx > 0; )
      {
      --idx;
      if ( (++this->m_Index[idx]) >= this->m_Region.To()[idx] )
        {
        this->m_Index[idx] = this->m_Region.From()[idx];
        }
      else
        break;
      }
  }
  
  const typename Self::IndexType& Index() const
  {
    return this->m_Index;
  }

  Self& operator=( const typename Self::IndexType& index )
  {
    this->m_Index = index;
    return *this;
  }

  bool operator==( const typename Self::IndexType& index )
  {
    return (this->m_Index == index);
  }

  bool operator!=( const typename Self::IndexType& index )
  {
    return (this->m_Index != index);
  }

private:
  typename Self::RegionType m_Region;

  typename Self::IndexType m_Index;
};

} // namespace cmtk

#endif // #ifndef __cmtkRegionIndexIterator_h_included_