itkFlatStructuringElement.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 itkFlatStructuringElement_h
#define itkFlatStructuringElement_h
 
#include "itkNeighborhood.h"
#include <vector>
#include "itkVector.h"
#include "itkImage.h"
 
namespace itk
{
 
template <unsigned int VDimension>
class ITK_TEMPLATE_EXPORT FlatStructuringElement : public Neighborhood<bool, VDimension>
{
public:
  using Self = FlatStructuringElement<VDimension>;
  using Superclass = Neighborhood<bool, VDimension>;

  using typename Superclass::PixelType;

  using typename Superclass::Iterator;
  using typename Superclass::ConstIterator;

  using typename Superclass::SizeType;
  using typename Superclass::OffsetType;

  using typename Superclass::RadiusType;

  using typename Superclass::SliceIteratorType;

  static constexpr unsigned int NeighborhoodDimension = VDimension;
 
  using LType = Vector<float, VDimension>;
  using DecompType = std::vector<LType>;

  using ImageType = itk::Image<PixelType, VDimension>;

  ~FlatStructuringElement() override = default;
 
  FlatStructuringElement(const FlatStructuringElement &) = default;
  FlatStructuringElement(FlatStructuringElement &&) = default;
  FlatStructuringElement &
  operator=(const FlatStructuringElement &) = default;
  FlatStructuringElement &
  operator=(FlatStructuringElement &&) = default;

  FlatStructuringElement() = default;


  static Self
  Box(RadiusType radius);

  static Self
  Ball(RadiusType radius, bool radiusIsParametric = false);

  static Self
  Cross(RadiusType radius);

  static Self
  Annulus(RadiusType radius, unsigned int thickness = 1, bool includeCenter = false, bool radiusIsParametric = false);

  static Self
  Polygon(RadiusType radius, unsigned int lines);

  [[nodiscard]] bool
  GetDecomposable() const
  {
    return m_Decomposable;
  }
  void
  SetDecomposable(bool v)
  {
    m_Decomposable = v;
  }

  [[nodiscard]] const DecompType &
  GetLines() const
  {
    return m_Lines;
  }
  void
  AddLine(LType l)
  {
    m_Lines.push_back(l);
  }

  [[nodiscard]] bool
  CheckParallel(LType NewVec) const;

  void
  ComputeBufferFromLines();

  [[nodiscard]] bool
  GetRadiusIsParametric() const
  {
    return m_RadiusIsParametric;
  }
  void
  SetRadiusIsParametric(bool flag)
  {
    m_RadiusIsParametric = flag;
  }
  itkBooleanMacro(RadiusIsParametric);
  static Self
  FromImage(const ImageType * image);
 
protected:
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  bool m_Decomposable{};
 
  DecompType m_Lines{};
 
  template <unsigned int VDimension3>
  struct StructuringElementFacet
  {
    Vector<float, VDimension3> P1, P2, P3;
  };
  using FacetType = StructuringElementFacet<VDimension>;
 
  template <typename TStructuringElement, typename TRadius>
  static void
  GeneratePolygon(TStructuringElement & res, TRadius radius, unsigned int lines);
  static void
  GeneratePolygon(itk::FlatStructuringElement<2> & res, itk::Size<2> radius, unsigned int lines);
  static void
  GeneratePolygon(itk::FlatStructuringElement<3> & res, itk::Size<3> radius, unsigned int lines);
 
  using LType2 = Vector<float, 2>;
 
  using LType3 = Vector<float, 3>;
  using FacetType3 = StructuringElementFacet<3>;
 
  bool m_RadiusIsParametric{};

  static RadiusType
  CheckImageSize(const ImageType * image);
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFlatStructuringElement.hxx"
#endif
 
#endif