itkImageRandomConstIteratorWithIndex.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageRandomConstIteratorWithIndex.h,v $
  Language:  C++
  Date:      $Date: 2008-10-18 21:13:25 $
  Version:   $Revision: 1.14 $

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

#include "itkImageConstIteratorWithIndex.h"
#include "itkMersenneTwisterRandomVariateGenerator.h"

namespace itk
{

template<typename TImage>
class ITK_EXPORT ImageRandomConstIteratorWithIndex : public ImageConstIteratorWithIndex<TImage>
{
public:
  typedef ImageRandomConstIteratorWithIndex       Self;
  typedef ImageConstIteratorWithIndex<TImage>     Superclass;

  typedef typename TImage::IndexType   IndexType;

  typedef typename TImage::RegionType RegionType;

  typedef TImage ImageType;

  typedef typename TImage::PixelContainer       PixelContainer;
  typedef typename PixelContainer::Pointer      PixelContainerPointer;

  ImageRandomConstIteratorWithIndex();
  ~ImageRandomConstIteratorWithIndex() {};

  ImageRandomConstIteratorWithIndex(const ImageType *ptr, const RegionType& region);

  ImageRandomConstIteratorWithIndex( const ImageConstIteratorWithIndex<TImage> &it)
    { this->ImageConstIteratorWithIndex<TImage>::operator=(it); }

  void GoToBegin(void)
    {
    this->RandomJump();
    m_NumberOfSamplesDone = 0L;
    }

  void GoToEnd(void)
    {
    this->RandomJump();
    m_NumberOfSamplesDone = m_NumberOfSamplesRequested;
    }

  bool IsAtBegin(void) const
    { return (m_NumberOfSamplesDone == 0L); }

  bool IsAtEnd(void) const
    { return (m_NumberOfSamplesDone >= m_NumberOfSamplesRequested);  }

  Self & operator++()
    {
    this->RandomJump();
    m_NumberOfSamplesDone++;
    return *this;
    }

  Self & operator--()
    {
    this->RandomJump();
    m_NumberOfSamplesDone--;
    return *this;
    }

  void SetNumberOfSamples( unsigned long number );
  unsigned long GetNumberOfSamples( void ) const;

  void ReinitializeSeed();
  void ReinitializeSeed(int);

private:
  void RandomJump();
  typedef Statistics::MersenneTwisterRandomVariateGenerator::Pointer  GeneratorPointer;
  GeneratorPointer  m_Generator;
  unsigned long     m_NumberOfSamplesRequested;
  unsigned long     m_NumberOfSamplesDone;
  unsigned long     m_NumberOfPixelsInRegion;
};

} // end namespace itk

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

#endif