itkShapedFloodFilledFunctionConditionalConstIterator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkShapedFloodFilledFunctionConditionalConstIterator.h,v $
  Language:  C++
  Date:      $Date: 2009-04-28 16:16:25 $
  Version:   $Revision: 1.2 $

  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 __itkShapedFloodFilledFunctionConditionalConstIterator_h
#define __itkShapedFloodFilledFunctionConditionalConstIterator_h

#include <queue>
#include <vector>

#include "itkIndex.h"
#include "itkSize.h"
#include "itkConditionalConstIterator.h"
#include "itkShapedNeighborhoodIterator.h"
#include "itkConnectedComponentAlgorithm.h"
#include "itkImage.h"

namespace itk
{

template<class TImage, class TFunction>
class ITK_EXPORT ShapedFloodFilledFunctionConditionalConstIterator:
    public ConditionalConstIterator<TImage>
{
public:

  typedef ShapedFloodFilledFunctionConditionalConstIterator Self;

  typedef TFunction FunctionType;

  typedef typename TFunction::InputType FunctionInputType;

  typedef typename TImage::IndexType IndexType;

  typedef typename TImage::OffsetType OffsetType;

  typedef typename TImage::SizeType SizeType;

  typedef typename TImage::RegionType RegionType;

  typedef TImage ImageType;

  typedef typename TImage::InternalPixelType InternalPixelType;

  typedef typename TImage::PixelType   PixelType;  

  typedef typename itk::ShapedNeighborhoodIterator<ImageType> NeighborhoodIteratorType;

  itkStaticConstMacro(NDimensions, unsigned int, TImage::ImageDimension);

  ShapedFloodFilledFunctionConditionalConstIterator(const ImageType *imagePtr,
                                     FunctionType *fnPtr,
                                     IndexType startIndex);

  ShapedFloodFilledFunctionConditionalConstIterator(const ImageType *imagePtr,
                                     FunctionType *fnPtr,
                                     std::vector<IndexType> & startIndices);

  ShapedFloodFilledFunctionConditionalConstIterator(const ImageType *imagePtr,
                                              FunctionType *fnPtr);

  void FindSeedPixel();

  void FindSeedPixels();

  void InitializeIterator();

  virtual ~ShapedFloodFilledFunctionConditionalConstIterator() {};

  virtual bool IsPixelIncluded(const IndexType & index) const = 0;

  Self &operator=(const Self& it)
    {
    this->m_Image = it.m_Image;     // copy the smart pointer
    this->m_Region = it.m_Region;
    return *this;
    } 

  static unsigned int GetIteratorDimension() 
    {return TImage::ImageDimension;}

  const IndexType GetIndex()
    { return m_IndexStack.front();}

  const PixelType & Get(void) const
    { return this->m_Image->GetPixel(m_IndexStack.front() ); }

  bool IsAtEnd()
    { return this->m_IsAtEnd; }

  void AddSeed ( const IndexType seed )
    {
    m_StartIndices.push_back ( seed );
    }

  void ClearSeeds ()
    {
    m_StartIndices.clear();
    }

  void GoToBegin()
    {
    // Clear the queue
    while (!m_IndexStack.empty())
      {
      m_IndexStack.pop();
      }

    this->m_IsAtEnd = true;
    // Initialize the temporary image
    m_TempPtr->FillBuffer(
      NumericTraits<ITK_TYPENAME TTempImage::PixelType>::Zero
      );
    
    for ( unsigned int i = 0; i < m_StartIndices.size(); i++ )
      {
      if( this->m_Image->GetBufferedRegion().IsInside ( m_StartIndices[i] ) &&
          this->IsPixelIncluded(m_StartIndices[i]) )
        {
        // Push the seed onto the queue
        m_IndexStack.push(m_StartIndices[i]);
        
        // Obviously, we're at the beginning
        this->m_IsAtEnd = false;
        
        // Mark the start index in the temp image as inside the
        // function, neighbor check incomplete
        m_TempPtr->SetPixel(m_StartIndices[i], 2);
        }
      }
    }

  void operator++()
    { this->DoFloodStep(); }

  void DoFloodStep();
  
  virtual SmartPointer<FunctionType> GetFunction() const
    {
    return m_Function;
    }
    
  void SetFullyConnected(const bool _arg);
  bool GetFullyConnected() const;
  itkBooleanMacro(FullyConnected);


protected: //made protected so other iterators can access 
  SmartPointer<FunctionType> m_Function;

  typedef Image<unsigned char, itkGetStaticConstMacro(NDimensions)> TTempImage;

  typename TTempImage::Pointer m_TempPtr;
  
  std::vector<IndexType> m_StartIndices;

  typename ImageType::PointType m_ImageOrigin;

  typename ImageType::SpacingType m_ImageSpacing;

  NeighborhoodIteratorType m_NeighborhoodIterator;

  RegionType   m_ImageRegion;

  std::queue<IndexType> m_IndexStack;

  FunctionInputType m_LocationVector;

  bool m_FoundUncheckedNeighbor;

  bool m_IsValidIndex;

  bool m_FullyConnected;
};

} // end namespace itk

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

#endif