itkJointDomainImageToListSampleAdaptor.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 itkJointDomainImageToListSampleAdaptor_h
#define itkJointDomainImageToListSampleAdaptor_h
 
#include "itkPoint.h"
#include "itkPixelTraits.h"
#include "itkImageRegionConstIteratorWithIndex.h"
#include "itkImageRegionIterator.h"
#include "itkListSample.h"
 
namespace itk
{
namespace Statistics
{
template <typename TImage>
struct ImageJointDomainTraits
{
  using Self = ImageJointDomainTraits;
  using PixelTraitsType = PixelTraits<typename TImage::PixelType>;
  using RangeDomainMeasurementType = typename PixelTraitsType::ValueType;
 
  static constexpr unsigned int ImageDimension = TImage::ImageDimension;
  static constexpr unsigned int Dimension = TImage::ImageDimension + PixelTraitsType::Dimension;
 
  using CoordinateRepType = float;
  using PointType = Point<CoordinateRepType, Self::ImageDimension>;
  using JoinTraitsType = JoinTraits<RangeDomainMeasurementType, CoordinateRepType>;
  using MeasurementType = typename JoinTraitsType::ValueType;
 
  using MeasurementVectorType = FixedArray<MeasurementType, Self::Dimension>;
}; // end of ImageJointDomainTraits

 
template <typename TImage>
class ITK_TEMPLATE_EXPORT JointDomainImageToListSampleAdaptor
  : public ListSample<typename ImageJointDomainTraits<TImage>::MeasurementVectorType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(JointDomainImageToListSampleAdaptor);

  using Self = JointDomainImageToListSampleAdaptor;
 
  using Superclass = ListSample<typename ImageJointDomainTraits<TImage>::MeasurementVectorType>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using ImageJointDomainTraitsType = ImageJointDomainTraits<TImage>;
 
  using MeasurementVectorType = typename ImageJointDomainTraitsType::MeasurementVectorType;
  using MeasurementType = typename ImageJointDomainTraitsType::MeasurementType;
  using RangeDomainMeasurementType = typename ImageJointDomainTraitsType::RangeDomainMeasurementType;
  using PointType = typename ImageJointDomainTraitsType::PointType;
  using CoordinateRepType = typename ImageJointDomainTraitsType::CoordinateRepType;

  itkOverrideGetNameOfClassMacro(JointDomainImageToListSampleAdaptor);

  itkNewMacro(Self);

  static constexpr unsigned int MeasurementVectorSize = ImageJointDomainTraitsType::Dimension;
 
  using typename Superclass::MeasurementVectorSizeType;

  using typename Superclass::AbsoluteFrequencyType;
  using typename Superclass::TotalAbsoluteFrequencyType;
  using typename Superclass::InstanceIdentifier;

  using ImageType = TImage;
  using ImageIteratorType = ImageRegionIterator<ImageType>;
  using ImageConstIteratorType = ImageRegionConstIterator<ImageType>;
 
  using ImagePointer = typename ImageType::Pointer;
  using ImageConstPointer = typename ImageType::ConstPointer;
  using PixelType = typename ImageType::PixelType;
  using PixelContainerConstPointer = typename ImageType::PixelContainerConstPointer;
  using ImageIndexType = typename ImageType::IndexType;
  using ImageSizeType = typename ImageType::SizeType;
  using ImageRegionType = typename ImageType::RegionType;
  using ValueType = MeasurementVectorType;

  void
  SetImage(const TImage * image);

  const TImage *
  GetImage() const;

  InstanceIdentifier
  Size() const override;

  AbsoluteFrequencyType
  GetFrequency(InstanceIdentifier id) const override;

  TotalAbsoluteFrequencyType
  GetTotalFrequency() const override;
 
  static constexpr unsigned int RangeDomainDimension = itk::PixelTraits<typename TImage::PixelType>::Dimension;
 
  using RangeDomainMeasurementVectorType = FixedArray<RangeDomainMeasurementType, Self::RangeDomainDimension>;
 
  using InstanceIdentifierVectorType = std::vector<InstanceIdentifier>;
  using NormalizationFactorsType = FixedArray<float, Self::MeasurementVectorSize>;

  void
  SetNormalizationFactors(NormalizationFactorsType & factors);

  const MeasurementVectorType &
  GetMeasurementVector(InstanceIdentifier id) const override;

  itkSetMacro(UsePixelContainer, bool);
  itkGetConstMacro(UsePixelContainer, bool);
  itkBooleanMacro(UsePixelContainer);
 
  //  void PrintSelf(std::ostream& os, Indent indent) const override;

  class ConstIterator
  {
    friend class JointDomainImageToListSampleAdaptor;
 
  public:
    ConstIterator() = delete;
 
    ConstIterator(const JointDomainImageToListSampleAdaptor * adaptor) { *this = adaptor->Begin(); }
 
    ConstIterator(const ConstIterator & iter)
    {
      m_InstanceIdentifier = iter.m_InstanceIdentifier;
      m_Adaptor = iter.m_Adaptor;
    }
 
    ConstIterator &
    operator=(const ConstIterator & iter)
    {
      m_InstanceIdentifier = iter.m_InstanceIdentifier;
      return *this;
    }
 
    AbsoluteFrequencyType
    GetFrequency() const
    {
      return 1;
    }
 
    const MeasurementVectorType &
    GetMeasurementVector() const
    {
      m_MeasurementVectorCache = m_Adaptor->GetMeasurementVector(m_InstanceIdentifier);
      return this->m_MeasurementVectorCache;
    }
 
    InstanceIdentifier
    GetInstanceIdentifier() const
    {
      return m_InstanceIdentifier;
    }
 
    ConstIterator &
    operator++()
    {
      ++m_InstanceIdentifier;
      return *this;
    }
 
    bool
    operator==(const ConstIterator & it) const
    {
      return (m_InstanceIdentifier == it.m_InstanceIdentifier);
    }
 
    ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(ConstIterator);
 
  protected:
    // This method should only be available to the ListSample class
    ConstIterator(const JointDomainImageToListSampleAdaptor * adaptor, InstanceIdentifier iid)
    {
      m_Adaptor = adaptor;
      m_InstanceIdentifier = iid;
    }
 
  private:
    mutable MeasurementVectorType               m_MeasurementVectorCache;
    InstanceIdentifier                          m_InstanceIdentifier;
    const JointDomainImageToListSampleAdaptor * m_Adaptor;
  };

  class Iterator : public ConstIterator
  {
    friend class JointDomainImageToListSampleAdaptor;
 
  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:
    Iterator(const JointDomainImageToListSampleAdaptor * adaptor, InstanceIdentifier iid)
      : ConstIterator(adaptor, iid)
    {}
  };

  Iterator
  Begin()
  {
    const Iterator iter(this, 0);
 
    return iter;
  }

  Iterator
  End()
  {
    const Iterator iter(this, m_Image->GetPixelContainer()->Size());
 
    return iter;
  }

  ConstIterator
  Begin() const
  {
    ConstIterator iter(this, 0);
 
    return iter;
  }

  ConstIterator
  End() const
  {
    ConstIterator iter(this, m_Image->GetPixelContainer()->Size());
 
    return iter;
  }
 
protected:
  JointDomainImageToListSampleAdaptor();
  ~JointDomainImageToListSampleAdaptor() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  NormalizationFactorsType                 m_NormalizationFactors{};
  mutable MeasurementVectorType            m_TempVector{};
  mutable PointType                        m_TempPoint{};
  mutable ImageIndexType                   m_TempIndex{};
  mutable RangeDomainMeasurementVectorType m_TempRangeVector{};
  ImageConstPointer                        m_Image{};
  bool                                     m_UsePixelContainer{};
 
  PixelContainerConstPointer m_PixelContainer{};
}; // end of class JointDomainImageToListSampleAdaptor
} // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkJointDomainImageToListSampleAdaptor.hxx"
#endif
 
#endif