itkAttributeMorphologyBaseImageFilter.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 itkAttributeMorphologyBaseImageFilter_h
#define itkAttributeMorphologyBaseImageFilter_h
 
#include "itkImageToImageFilter.h"
#include <vector>
#include <memory> // For unique_ptr.
 
namespace itk
{
 
template <typename TInputImage, typename TOutputImage, typename TAttribute, typename TFunction>
class ITK_TEMPLATE_EXPORT AttributeMorphologyBaseImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  using Self = AttributeMorphologyBaseImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;

  using typename Superclass::InputImagePointer;

  using OutputPixelType = typename TOutputImage::PixelType;
  using OutputInternalPixelType = typename TOutputImage::InternalPixelType;
  using InputPixelType = typename TInputImage::PixelType;
  using InputInternalPixelType = typename TInputImage::InternalPixelType;
  using IndexType = typename TInputImage::IndexType;
  using OffsetType = typename TInputImage::OffsetType;
  using SizeType = typename TInputImage::SizeType;
 
  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  //   using IndexType = typename TInputImage::IndexType;
  //   using SizeType = typename TInputImage::SizeType;
  using RegionType = typename TOutputImage::RegionType;
  using ListType = std::list<IndexType>;
  using AttributeType = TAttribute;

  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(AttributeMorphologyBaseImageFilter);

  itkNewMacro(Self);

  itkSetMacro(FullyConnected, bool);
  itkGetConstReferenceMacro(FullyConnected, bool);
  itkBooleanMacro(FullyConnected);

  itkSetMacro(Lambda, AttributeType);
  itkGetConstMacro(Lambda, AttributeType);
 
protected:
  AttributeMorphologyBaseImageFilter()
  {
    m_FullyConnected = false;
    m_AttributeValuePerPixel = 1;
    m_Lambda = 0;
  }
 
  ~AttributeMorphologyBaseImageFilter() override = default;
  AttributeMorphologyBaseImageFilter(const Self &) {}
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;

  void
  GenerateInputRequestedRegion() override;

  void
  EnlargeOutputRequestedRegion(DataObject * itkNotUsed(output)) override;
 
  AttributeType m_AttributeValuePerPixel{};
 
private:
  bool          m_FullyConnected{};
  AttributeType m_Lambda{};
 
  // some constants used several times in the code
  static constexpr OffsetValueType INACTIVE = -1;
  static constexpr OffsetValueType ACTIVE = -2;
 
  // Just used for area/volume openings at the moment
  std::unique_ptr<AttributeType[]> m_AuxData;
 
  using OffsetVecType = std::vector<OffsetType>;
  // offset in the linear array.
  using OffsetDirectVecType = std::vector<OffsetValueType>;
 
  void
  SetupOffsetVec(OffsetDirectVecType & PosOffsets, OffsetVecType & Offsets);
 
  // m_SortPixels contains offsets into the raw image
  // it is sorted with a stable sort by grey level as the
  // first step in the algorithm. The sorting step avoids
  // the need to explicitly locate regional extrema.
  std::unique_ptr<OffsetValueType[]> m_SortPixels;
  std::unique_ptr<OffsetValueType[]> m_Parent;
 
  // This is a bit ugly, but I can't see an easy way around
  std::unique_ptr<InputPixelType[]> m_Raw;
 
  class CompareOffsetType
  {
  public:
    TFunction m_TFunction;
    // buf contains the raw data, which is what
    // we want to sort by. i.e. the first value in
    // the sorted buffer will be the location of the
    // largest or smallest pixel.
    InputPixelType * buf;
    bool
    operator()(const OffsetValueType & l, const OffsetValueType & r) const
    {
      return (m_TFunction(buf[l], buf[r]));
    }
  };
 
  CompareOffsetType m_CompareOffset{};
  // version from PAMI. Note - using the AuxData array rather than the
  // parent array to store area
  void
  MakeSet(OffsetValueType x)
  {
    m_Parent[x] = ACTIVE;
    m_AuxData[x] = m_AttributeValuePerPixel;
  }
 
  OffsetValueType
  FindRoot(OffsetValueType x)
  {
    if (m_Parent[x] >= 0)
    {
      m_Parent[x] = FindRoot(m_Parent[x]);
      return (m_Parent[x]);
    }
    else
    {
      return (x);
    }
  }
 
  bool
  Criterion(OffsetValueType x, OffsetValueType y)
  {
    return ((m_Raw[x] == m_Raw[y]) || (m_AuxData[x] < m_Lambda));
  }
 
  void
  Union(OffsetValueType n, OffsetValueType p)
  {
    OffsetValueType r = FindRoot(n);
 
    if (r != p)
    {
      if (Criterion(r, p))
      {
        m_AuxData[p] += m_AuxData[r];
        m_Parent[r] = p;
      }
      else
      {
        m_AuxData[p] = m_Lambda;
      }
    }
  }
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkAttributeMorphologyBaseImageFilter.hxx"
#endif
 
#endif