itkAnnulusOperator.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 itkAnnulusOperator_h
#define itkAnnulusOperator_h
 
#include "itkNeighborhoodOperator.h"
#include "itkVector.h"
#include "itkPrintHelper.h"
 
namespace itk
{
template <typename TPixel, unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel, TDimension, TAllocator>
{
public:
  using Self = AnnulusOperator;
  using Superclass = NeighborhoodOperator<TPixel, TDimension, TAllocator>;

  using PixelType = TPixel;
  using typename Superclass::SizeType;
  using typename Superclass::OffsetType;
  using SpacingType = Vector<double, TDimension>;

  itkOverrideGetNameOfClassMacro(AnnulusOperator);

  void
  CreateOperator();

  void
  SetInnerRadius(double r)
  {
    m_InnerRadius = r;
  }
  [[nodiscard]] double
  GetInnerRadius() const
  {
    return m_InnerRadius;
  }

  void
  SetThickness(double t)
  {
    m_Thickness = t;
  }
  [[nodiscard]] double
  GetThickness() const
  {
    return m_Thickness;
  }

  void
  SetSpacing(SpacingType & s)
  {
    m_Spacing = s;
  }
  [[nodiscard]] const SpacingType &
  GetSpacing() const
  {
    return m_Spacing;
  }

  void
  SetNormalize(bool b)
  {
    m_Normalize = b;
  }
  [[nodiscard]] bool
  GetNormalize() const
  {
    return m_Normalize;
  }
  void
  NormalizeOn()
  {
    this->SetNormalize(true);
  }
  void
  NormalizeOff()
  {
    this->SetNormalize(false);
  }

  void
  SetBrightCenter(bool b)
  {
    m_BrightCenter = b;
  }
  [[nodiscard]] bool
  GetBrightCenter() const
  {
    return m_BrightCenter;
  }
  void
  BrightCenterOn()
  {
    this->SetBrightCenter(true);
  }
  void
  BrightCenterOff()
  {
    this->SetBrightCenter(false);
  }

  void
  SetInteriorValue(TPixel v)
  {
    m_InteriorValue = v;
  }
  [[nodiscard]] TPixel
  GetInteriorValue() const
  {
    return m_InteriorValue;
  }
  void
  SetAnnulusValue(TPixel v)
  {
    m_AnnulusValue = v;
  }
  [[nodiscard]] TPixel
  GetAnnulusValue() const
  {
    return m_AnnulusValue;
  }
  void
  SetExteriorValue(TPixel v)
  {
    m_ExteriorValue = v;
  }
  [[nodiscard]] TPixel
  GetExteriorValue() const
  {
    return m_ExteriorValue;
  }

  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
 
    os << indent << "InnerRadius: " << m_InnerRadius << std::endl;
    os << indent << "Thickness: " << m_Thickness << std::endl;
    os << indent << "Normalize: " << m_Normalize << std::endl;
    os << indent << "BrightCenter: " << m_BrightCenter << std::endl;
    print_helper::PrintNumericTrait(os, indent, "InteriorValue", m_InteriorValue);
    print_helper::PrintNumericTrait(os, indent, "AnnulusValue", m_AnnulusValue);
    print_helper::PrintNumericTrait(os, indent, "ExteriorValue", m_ExteriorValue);
    print_helper::PrintNumericTrait(os, indent, "Spacing", m_Spacing);
  }
 
protected:
  using typename Superclass::CoefficientVector;

  CoefficientVector
  GenerateCoefficients() override;

  void
  Fill(const CoefficientVector & coeff) override;
 
private:
  double      m_InnerRadius{ 1.0 };
  double      m_Thickness{ 1.0 };
  bool        m_Normalize{ false };
  bool        m_BrightCenter{ false };
  PixelType   m_InteriorValue{};
  PixelType   m_AnnulusValue{ NumericTraits<PixelType>::OneValue() };
  PixelType   m_ExteriorValue{};
  SpacingType m_Spacing{ MakeFilled<SpacingType>(1.0) };
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkAnnulusOperator.hxx"
#endif
#endif