itkFloodFilledFunctionConditionalConstIterator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 itkFloodFilledFunctionConditionalConstIterator_h
#define itkFloodFilledFunctionConditionalConstIterator_h

#include <queue>
#include <vector>

#include "itkSize.h"
#include "itkConditionalConstIterator.h"
#include "itkImage.h"

namespace itk
{
template< typename TImage, typename TFunction >
class ITK_TEMPLATE_EXPORT FloodFilledFunctionConditionalConstIterator:
  public ConditionalConstIterator< TImage >
{
public:

  using Self = FloodFilledFunctionConditionalConstIterator;

  using FunctionType = TFunction;

  using FunctionInputType = typename TFunction::InputType;

  using IndexType = typename TImage::IndexType;

  using SeedsContainerType = typename std::vector<IndexType>;

  using SizeType = typename TImage::SizeType;

  using RegionType = typename TImage::RegionType;

  using ImageType = TImage;

  using InternalPixelType = typename TImage::InternalPixelType;

  using PixelType = typename TImage::PixelType;

  static constexpr unsigned int NDimensions = TImage::ImageDimension;

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

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

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

  void FindSeedPixel();

  void FindSeedPixels();

  void InitializeIterator();

  ~FloodFilledFunctionConditionalConstIterator() override = default;

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

  Self & operator=(const Self & it)
  {
    if(this != &it)
      {
      this->m_Image = it.m_Image;     // copy the smart pointer
      this->m_Region = it.m_Region;
      this->m_Function = it.m_Function;
      this->m_TemporaryPointer = it.m_TemporaryPointer;
      this->m_Seeds = it.m_Seeds;
      this->m_ImageOrigin = it.m_ImageOrigin;
      this->m_ImageSpacing = it.m_ImageSpacing;
      this->m_ImageRegion = it.m_ImageRegion;
      this->m_IndexStack = it.m_IndexStack;
      this->m_LocationVector = it.m_LocationVector;
      this->m_FoundUncheckedNeighbor = it.m_FoundUncheckedNeighbor;
      this->m_IsValidIndex = it.m_IsValidIndex;
      }
    return *this;
  }

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

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

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

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

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

  virtual const SeedsContainerType &GetSeeds() const
  {
    return m_Seeds;
  }

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

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

    this->m_IsAtEnd = true;
    // Initialize the temporary image
    m_TemporaryPointer->FillBuffer(
      NumericTraits< typename TTempImage::PixelType >::ZeroValue()
      );

    for ( unsigned int i = 0; i < m_Seeds.size(); i++ )
      {
      if ( this->m_Image->GetBufferedRegion().IsInside (m_Seeds[i])
           && this->IsPixelIncluded(m_Seeds[i]) )
        {
        // Push the seed onto the queue
        m_IndexStack.push(m_Seeds[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_TemporaryPointer->SetPixel(m_Seeds[i], 2);
        }
      }
  }

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

  void DoFloodStep();

  virtual SmartPointer< FunctionType > GetFunction() const
  {
    return m_Function;
  }

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

  using TTempImage = Image< unsigned char, Self::NDimensions >;
  typename TTempImage::Pointer m_TemporaryPointer;

  SeedsContainerType m_Seeds;

  typename ImageType::PointType m_ImageOrigin;

  typename ImageType::SpacingType m_ImageSpacing;

  RegionType m_ImageRegion;

  std::queue< IndexType > m_IndexStack;

  FunctionInputType m_LocationVector;

  bool m_FoundUncheckedNeighbor;

  bool m_IsValidIndex;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFloodFilledFunctionConditionalConstIterator.hxx"
#endif

#endif