itkImageToNeighborhoodSampleAdaptor.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 itkImageToNeighborhoodSampleAdaptor_h
#define itkImageToNeighborhoodSampleAdaptor_h

#include <typeinfo>
#include <vector>
#include <iostream>

#include "itkImage.h"
#include "itkListSample.h"
#include "itkSmartPointer.h"
#include "itkImageRegionIteratorWithIndex.h"
#include "itkMacro.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkNeighborhoodIterator.h"

namespace itk {
namespace Statistics {

  template < typename TImage, typename TBoundaryCondition >
class ITK_TEMPLATE_EXPORT ImageToNeighborhoodSampleAdaptor :
  public ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >
{
public:
  typedef ImageToNeighborhoodSampleAdaptor               Self;

  typedef ListSample< std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > > >
                                                         Superclass;

  typedef SmartPointer< Self >                           Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  itkTypeMacro(ImageToNeighborhoodSampleAdaptor, ListSample);

  itkNewMacro(Self);

  typedef TImage                                          ImageType;
  typedef typename ImageType::Pointer                     ImagePointer;
  typedef typename ImageType::ConstPointer                ImageConstPointer;
  typedef typename ImageType::IndexType                   IndexType;
  typedef typename ImageType::OffsetType                  OffsetType;
  typedef typename ImageType::OffsetValueType             OffsetValueType;
  typedef typename ImageType::PixelType                   PixelType;
  typedef typename ImageType::PixelContainerConstPointer  PixelContainerConstPointer;
  typedef typename ImageType::RegionType                  RegionType;
  typedef typename RegionType::OffsetTableType            OffsetTableType;
  typedef typename ImageType::SizeType                    SizeType;
  typedef ImageRegionIteratorWithIndex< TImage >          ImageIteratorType;

  typedef ConstNeighborhoodIterator< TImage, TBoundaryCondition > NeighborhoodIteratorType;
  typedef NeighborhoodIterator< TImage, TBoundaryCondition >      NonConstNeighborhoodIteratorType;
  typedef typename NeighborhoodIteratorType::NeighborhoodType     NeighborhoodType;
  typedef typename NeighborhoodIteratorType::RadiusType           NeighborhoodRadiusType;
  typedef typename NeighborhoodIteratorType::IndexType            NeighborhoodIndexType;
  typedef typename NeighborhoodIteratorType::SizeType             NeighborhoodSizeType;

  typedef typename std::vector< ConstNeighborhoodIterator< TImage, TBoundaryCondition > >
                                                     MeasurementVectorType;
  typedef typename MeasurementVectorType::value_type ValueType;
  typedef ValueType                                  MeasurementType;

  typedef typename Superclass::AbsoluteFrequencyType      AbsoluteFrequencyType;
  typedef typename Superclass::TotalAbsoluteFrequencyType TotalAbsoluteFrequencyType;
  typedef typename Superclass::MeasurementVectorSizeType  MeasurementVectorSizeType;
  typedef typename Superclass::InstanceIdentifier         InstanceIdentifier;

  void SetImage(const TImage* image);

  const TImage* GetImage() const;

  void SetRadius(const NeighborhoodRadiusType& radius);

  NeighborhoodRadiusType GetRadius() const;

  void SetRegion(const RegionType& region);

  RegionType GetRegion() const;

  void SetUseImageRegion(const bool& flag);

  itkGetConstMacro( UseImageRegion, bool );

  itkBooleanMacro( UseImageRegion );


  InstanceIdentifier Size() const ITK_OVERRIDE;

  virtual const MeasurementVectorType & GetMeasurementVector(InstanceIdentifier id) const ITK_OVERRIDE;

  AbsoluteFrequencyType GetFrequency(InstanceIdentifier  id) const ITK_OVERRIDE;

  TotalAbsoluteFrequencyType GetTotalFrequency() const ITK_OVERRIDE;

  class ConstIterator
    {
    friend class ImageToNeighborhoodSampleAdaptor;
    public:

    ConstIterator( const ImageToNeighborhoodSampleAdaptor * adaptor )
      {
      *this = adaptor->Begin();
      }

    ConstIterator(const ConstIterator &iter)
      {
        m_MeasurementVectorCache = iter.m_MeasurementVectorCache;
        m_InstanceIdentifier = iter.m_InstanceIdentifier;
      }

    ConstIterator& operator=( const ConstIterator & iter )
      {
        m_MeasurementVectorCache = iter.m_MeasurementVectorCache;
        m_InstanceIdentifier = iter.m_InstanceIdentifier;
        return *this;
      }

    AbsoluteFrequencyType GetFrequency() const
      {
      return 1;
      }

    const MeasurementVectorType & GetMeasurementVector() const
      {
        return this->m_MeasurementVectorCache;
      }

    InstanceIdentifier GetInstanceIdentifier() const
      {
      return m_InstanceIdentifier;
      }

    ConstIterator& operator++()
      {
        ++(m_MeasurementVectorCache[0]);
        ++m_InstanceIdentifier;
      return *this;
      }

    bool operator!=(const ConstIterator &it)
      {
      return (m_MeasurementVectorCache[0] != it.m_MeasurementVectorCache[0]);
      }

    bool operator==(const ConstIterator &it)
      {
      return (m_MeasurementVectorCache[0] == it.m_MeasurementVectorCache[0]);
      }

  protected:
    // This method should only be available to the ListSample class
    ConstIterator(
      NeighborhoodIteratorType iter,
      InstanceIdentifier iid)
      {
        this->m_MeasurementVectorCache.clear();
        this->m_MeasurementVectorCache.push_back(iter);
        m_InstanceIdentifier = iid;
      }

  private:
    ConstIterator() ITK_DELETED_FUNCTION;
    mutable MeasurementVectorType     m_MeasurementVectorCache;
    InstanceIdentifier                m_InstanceIdentifier;
    };

  class Iterator : public ConstIterator
  {

  friend class ImageToNeighborhoodSampleAdaptor;

  public:

    Iterator(Self * adaptor):ConstIterator(adaptor)
      {
      }

    Iterator(const Iterator &iter):ConstIterator( iter )
      {
      }

    Iterator& operator =(const Iterator & iter)
      {
      this->ConstIterator::operator=( iter );
      return *this;
      }

#if !(defined(_MSC_VER) && (_MSC_VER <= 1200))
  protected:
#endif
    //This copy constructor is actually used in Iterator Begin()!
    Iterator(NeighborhoodIteratorType iter, InstanceIdentifier iid):ConstIterator( iter, iid )
      {
      }

  private:
    // To ensure const-correctness these method must not be in the public API.
    // The are not implemented, since they should never be called.
    Iterator() ITK_DELETED_FUNCTION;
    Iterator(const Self * adaptor) ITK_DELETED_FUNCTION;
    Iterator(const ConstIterator & it) ITK_DELETED_FUNCTION;
    ConstIterator& operator=(const ConstIterator& it) ITK_DELETED_FUNCTION;
  };

  Iterator Begin()
    {
    NeighborhoodIteratorType nIterator( m_Radius, m_Image, m_Region);
    nIterator.GoToBegin();
    Iterator iter(nIterator, 0);
    return iter;
    }

  Iterator End()
    {
    NeighborhoodIteratorType nIterator( m_Radius, m_Image, m_Region);
    nIterator.GoToEnd();
    Iterator iter(nIterator, m_Region.GetNumberOfPixels());
    return iter;
    }


  ConstIterator Begin() const
    {
    NeighborhoodIteratorType nIterator( m_Radius, m_Image, m_Region);
    nIterator.GoToBegin();
    ConstIterator iter(nIterator, 0);
    return iter;
    }

  ConstIterator End() const
    {
    NeighborhoodIteratorType nIterator( m_Radius, m_Image, m_Region);
    nIterator.GoToEnd();
    ConstIterator iter(nIterator, m_Region.GetNumberOfPixels());
    return iter;
    }

protected:
  ImageToNeighborhoodSampleAdaptor();
  virtual ~ImageToNeighborhoodSampleAdaptor() ITK_OVERRIDE {}
  void PrintSelf(std::ostream& os, Indent indent) const ITK_OVERRIDE;

private:
  ITK_DISALLOW_COPY_AND_ASSIGN(ImageToNeighborhoodSampleAdaptor);

  ImageConstPointer                  m_Image;
  mutable MeasurementVectorType      m_MeasurementVectorInternal;
  mutable InstanceIdentifier         m_InstanceIdentifierInternal;
  mutable IndexType                  m_NeighborIndexInternal;
  NeighborhoodRadiusType             m_Radius;
  RegionType                         m_Region;
  bool                               m_UseImageRegion;
  OffsetTableType                    m_OffsetTable;

}; // end of class ImageToNeighborhoodSampleAdaptor

} // end of namespace Statistics

template <typename TImage, typename TBoundaryCondition>
  std::ostream & operator<<(std::ostream &os,
                            const std::vector< itk::ConstNeighborhoodIterator<TImage, TBoundaryCondition> > &mv);

} // end of namespace itk

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

#endif