itkImageToNeighborhoodSampleAdaptor.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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:
  ITK_DISALLOW_COPY_AND_MOVE(ImageToNeighborhoodSampleAdaptor);

  using Self = ImageToNeighborhoodSampleAdaptor;
 
  using Superclass = ListSample<std::vector<ConstNeighborhoodIterator<TImage, TBoundaryCondition>>>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ImageToNeighborhoodSampleAdaptor);

  itkNewMacro(Self);

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

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

  using MeasurementVectorType = typename std::vector<ConstNeighborhoodIterator<TImage, TBoundaryCondition>>;
  using ValueType = typename MeasurementVectorType::value_type;
  using MeasurementType = ValueType;
 
  using typename Superclass::AbsoluteFrequencyType;
  using typename Superclass::TotalAbsoluteFrequencyType;
  using typename Superclass::MeasurementVectorSizeType;
  using typename Superclass::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 override;

  const MeasurementVectorType &
  GetMeasurementVector(InstanceIdentifier id) const override;

  AbsoluteFrequencyType
  GetFrequency(InstanceIdentifier id) const override;

  TotalAbsoluteFrequencyType
  GetTotalFrequency() const override;

  class ConstIterator
  {
    friend class ImageToNeighborhoodSampleAdaptor;
 
  public:
    ConstIterator() = delete;
 
    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) = default;
 
    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) const
    {
      return (m_MeasurementVectorCache[0] == it.m_MeasurementVectorCache[0]);
    }
 
    ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(ConstIterator);
 
  protected:
    // This method should only be available to the ListSample class
    ConstIterator(NeighborhoodIteratorType iter, InstanceIdentifier iid)
      : m_InstanceIdentifier(iid)
    {
      this->m_MeasurementVectorCache.clear();
      this->m_MeasurementVectorCache.push_back(iter);
    }
 
  private:
    mutable MeasurementVectorType m_MeasurementVectorCache;
    InstanceIdentifier            m_InstanceIdentifier;
  };

  class Iterator : public ConstIterator
  {
 
    friend class ImageToNeighborhoodSampleAdaptor;
 
  public:
    Iterator() = delete;
    Iterator(const Self * adaptor) = delete;
    Iterator(const ConstIterator & it) = delete;
    ConstIterator &
    operator=(const ConstIterator & it) = delete;
 
    Iterator(Self * adaptor)
      : ConstIterator(adaptor)
    {}
 
    Iterator(const Iterator & iter)
      : ConstIterator(iter)
    {}
 
    Iterator &
    operator=(const Iterator & iter)
    {
      this->ConstIterator::operator=(iter);
      return *this;
    }
 
  protected:
    // This copy constructor is actually used in Iterator Begin()!
    Iterator(NeighborhoodIteratorType iter, InstanceIdentifier iid)
      : ConstIterator(iter, iid)
    {}
  };

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

  Iterator
  End()
  {
    NeighborhoodIteratorType nIterator(m_Radius, m_Image, m_Region);
    nIterator.GoToEnd();
    const 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();
  ~ImageToNeighborhoodSampleAdaptor() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  ImageConstPointer             m_Image{};
  mutable MeasurementVectorType m_MeasurementVectorInternal{};
  mutable InstanceIdentifier    m_InstanceIdentifierInternal{};
  mutable IndexType             m_NeighborIndexInternal{};
  NeighborhoodRadiusType        m_Radius{};
  RegionType                    m_Region{};
  bool                          m_UseImageRegion{ true };
  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