itkImageRandomNonRepeatingConstIteratorWithIndex.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 __itkImageRandomNonRepeatingConstIteratorWithIndex_h
#define __itkImageRandomNonRepeatingConstIteratorWithIndex_h

#include "itkImageConstIteratorWithIndex.h"
#include <algorithm>
#include <iostream>
#include "itkMersenneTwisterRandomVariateGenerator.h"

namespace itk
{
class NodeOfPermutation
{
public:
  SizeValueType m_Priority;
  SizeValueType m_Index;
  double        m_Value;

  NodeOfPermutation ()
  {
    m_Priority = 0;
    m_Index = 0;
    m_Value = 0.0;
  }

  bool operator<(const NodeOfPermutation & b) const
  {
    if ( m_Priority == b.m_Priority )
      {
      return m_Value < b.m_Value;
      }
    else
      {
      return m_Priority < b.m_Priority;
      }
  }
};

class RandomPermutation
{
public:
  typedef Statistics::MersenneTwisterRandomVariateGenerator::Pointer GeneratorPointer;
  NodeOfPermutation *m_Permutation;
  GeneratorPointer   m_Generator;
  SizeValueType      m_Size;

  RandomPermutation(SizeValueType sz)
  {
    m_Size = sz;
    m_Permutation = new NodeOfPermutation[m_Size];
    m_Generator = Statistics::MersenneTwisterRandomVariateGenerator::GetInstance();
    this->Shuffle();
  }

  void Dump()
  {
    for ( SizeValueType i = 0; i < m_Size; i++ )
      {
      std::cout << m_Permutation[i].m_Value << " " << m_Permutation[i].m_Priority
                << " " << m_Permutation[i].m_Index << ";";
      std::cout << std::endl;
      }
  }

  void SetPriority(SizeValueType i, SizeValueType priority)
  {
    if ( i > m_Size )
      {
      std::cerr << "Error - i dont have " << i << " elements" << std::endl;
      }
    else
      {
      m_Permutation[i].m_Priority = priority;
      }
  }

  void Shuffle()
  {
    for ( SizeValueType i = 0; i < m_Size; i++ )
      {
      m_Permutation[i].m_Value = m_Generator->GetVariateWithClosedRange (1.0);
      m_Permutation[i].m_Index = i;
      }
    std::sort(m_Permutation, m_Permutation + m_Size);
  }

  SizeValueType operator[](SizeValueType i)
  {
    return m_Permutation[i].m_Index;
  }

  ~RandomPermutation()
  {
    delete[] m_Permutation;
  }

  void ReinitializeSeed()
  {
    m_Generator->Initialize();
  }

  void ReinitializeSeed(int seed)
  {
    m_Generator->SetSeed (seed);
  }
};

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

  typedef typename Superclass::IndexType             IndexType;
  typedef typename Superclass::SizeType              SizeType;
  typedef typename Superclass::OffsetType            OffsetType;
  typedef typename Superclass::RegionType            RegionType;
  typedef typename Superclass::ImageType             ImageType;
  typedef typename Superclass::PixelContainer        PixelContainer;
  typedef typename Superclass::PixelContainerPointer PixelContainerPointer;
  typedef typename Superclass::InternalPixelType     InternalPixelType;
  typedef typename Superclass::PixelType             PixelType;
  typedef typename Superclass::AccessorType          AccessorType;
  typedef typename Superclass::IndexValueType        IndexValueType;
  typedef typename Superclass::OffsetValueType       OffsetValueType;
  typedef typename Superclass::SizeValueType         SizeValueType;

  ImageRandomNonRepeatingConstIteratorWithIndex();
  ~ImageRandomNonRepeatingConstIteratorWithIndex()
  {
    if ( m_Permutation )
      {
      delete m_Permutation;
      }
  }

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

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

    m_Permutation = NULL;
  }

  Self & operator=(const Self & it);

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

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

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

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

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

  typedef itk::Image< SizeValueType, itkGetStaticConstMacro(ImageDimension) > PriorityImageType;

  void SetPriorityImage(const PriorityImageType *priorityImage);

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

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

  void SetNumberOfSamples(SizeValueType number);

  SizeValueType GetNumberOfSamples(void) const;

  void ReinitializeSeed();

  void ReinitializeSeed(int);

private:
  void UpdatePosition();

  SizeValueType      m_NumberOfSamplesRequested;
  SizeValueType      m_NumberOfSamplesDone;
  SizeValueType      m_NumberOfPixelsInRegion;
  RandomPermutation *m_Permutation;
};
} // end namespace itk

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

#endif