itkMovingHistogramImageFilterBase.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 itkMovingHistogramImageFilterBase_h
#define itkMovingHistogramImageFilterBase_h
 
#include "itkKernelImageFilter.h"
#include "itkLexicographicCompare.h"
#include <list>
#include <map>
#include <set>
 
namespace itk
{
 
template <typename TInputImage, typename TOutputImage, typename TKernel>
class ITK_TEMPLATE_EXPORT MovingHistogramImageFilterBase : public KernelImageFilter<TInputImage, TOutputImage, TKernel>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MovingHistogramImageFilterBase);

  using Self = MovingHistogramImageFilterBase;
  using Superclass = KernelImageFilter<TInputImage, TOutputImage, TKernel>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MovingHistogramImageFilterBase);

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using RegionType = typename TInputImage::RegionType;
  using SizeType = typename TInputImage::SizeType;
  using IndexType = typename TInputImage::IndexType;
  using PixelType = typename TInputImage::PixelType;
  using OffsetType = typename TInputImage::OffsetType;
  using typename Superclass::OutputImageRegionType;
  using OutputPixelType = typename TOutputImage::PixelType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using KernelType = TKernel;

  using KernelIteratorType = typename KernelType::ConstIterator;

  using RadiusType = typename KernelType::SizeType;
 
  using OffsetListType = typename std::list<OffsetType>;
 
  using OffsetMapType = typename std::map<OffsetType, OffsetListType, Functor::LexicographicCompare>;

  void
  SetKernel(const KernelType & kernel) override;
 
  itkGetConstMacro(PixelsPerTranslation, SizeValueType);
 
protected:
  MovingHistogramImageFilterBase();
  ~MovingHistogramImageFilterBase() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GetDirAndOffset(const IndexType LineStart,
                  const IndexType PrevLineStart,
                  OffsetType &    LineOffset,
                  OffsetType &    Changes,
                  int &           LineDirection);
 
  // store the added and removed pixel offset in a list
  OffsetMapType m_AddedOffsets{};
  OffsetMapType m_RemovedOffsets{};
 
  // store the offset of the kernel to initialize the histogram
  OffsetListType m_KernelOffsets{};
 
  FixedArray<int, Self::ImageDimension> m_Axes{};
 
  SizeValueType m_PixelsPerTranslation{};
 
private:
  class DirectionCost
  {
  public:
    DirectionCost(int dimension, int count)
      : m_Dimension(dimension)
      , m_Count(count)
    {}

    inline bool
    operator<(const DirectionCost & dc) const
    {
      if (m_Count > dc.m_Count)
      {
        return true;
      }
      if (m_Count < dc.m_Count)
      {
        return false;
      }
      else // if (m_Count == dc.m_Count)
      {
        return m_Dimension > dc.m_Dimension;
      }
    }
 
    int m_Dimension;
    int m_Count;
  };
}; // end of class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMovingHistogramImageFilterBase.hxx"
#endif
 
#endif