itkAnnulusOperator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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"

namespace itk
{
template< class TPixel, unsigned int TDimension = 2,
          class TAllocator = NeighborhoodAllocator< TPixel > >
class ITK_EXPORT AnnulusOperator:
  public NeighborhoodOperator< TPixel, TDimension, TAllocator >
{
public:

  typedef AnnulusOperator                                        Self;
  typedef NeighborhoodOperator< TPixel, TDimension, TAllocator > Superclass;

  typedef typename Superclass::SizeType      SizeType;
  typedef typename Superclass::OffsetType    OffsetType;
  typedef Vector< double, TDimension >       SpacingType;

  itkTypeMacro(AnnulusOperator, NeighborhoodOperator);

  AnnulusOperator():
    NeighborhoodOperator< TPixel, TDimension, TAllocator >(),
    m_Normalize(false), m_BrightCenter(false),
    m_InteriorValue(NumericTraits< PixelType >::Zero),
    m_AnnulusValue(NumericTraits< PixelType >::One),
    m_ExteriorValue(NumericTraits< PixelType >::Zero)
  { m_Spacing.Fill(1.0); }

  AnnulusOperator(const Self & other):
    NeighborhoodOperator< TPixel, TDimension, TAllocator >(other)
  {
    m_InnerRadius = other.m_InnerRadius;
    m_Thickness = other.m_Thickness;
    m_Spacing = other.m_Spacing;
    m_InteriorValue = other.m_InteriorValue;
    m_AnnulusValue = other.m_AnnulusValue;
    m_ExteriorValue = other.m_ExteriorValue;
    m_Normalize = other.m_Normalize;
    m_BrightCenter = other.m_BrightCenter;
  }

  void CreateOperator();

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

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

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

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

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

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

  Self & operator=(const Self & other)
  {
    Superclass::operator=(other);
    m_InnerRadius = other.m_InnerRadius;
    m_Thickness = other.m_Thickness;
    m_Spacing = other.m_Spacing;
    m_InteriorValue = other.m_InteriorValue;
    m_AnnulusValue = other.m_AnnulusValue;
    m_ExteriorValue = other.m_ExteriorValue;
    m_Normalize = other.m_Normalize;
    m_BrightCenter = other.m_BrightCenter;
    return *this;
  }

  virtual void PrintSelf(std::ostream & os, Indent i) const
  {
    os << i << "AnnulusOperator { this=" << this
       << ", m_InnerRadius = " << m_InnerRadius
       << ", m_Thickness = " << m_Thickness
       << ", m_Spacing = " << m_Spacing
       << ", m_Normalize = " << m_Normalize
       << ", m_BrightCenter = " << m_BrightCenter
       << ", m_InteriorValue = " << m_InteriorValue
       << ", m_ExteriorValue = " << m_ExteriorValue
       << "}" << std::endl;
    Superclass::PrintSelf( os, i.GetNextIndent() );
  }

protected:

  typedef typename Superclass::CoefficientVector CoefficientVector;
  typedef typename Superclass::PixelType         PixelType;

  CoefficientVector GenerateCoefficients();

  void Fill(const CoefficientVector & c);

private:

  double      m_InnerRadius;
  double      m_Thickness;
  bool        m_Normalize;
  bool        m_BrightCenter;
  PixelType   m_InteriorValue;
  PixelType   m_AnnulusValue;
  PixelType   m_ExteriorValue;
  SpacingType m_Spacing;
};
} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_AnnulusOperator(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                   \
  {                                                               \
  _( 2 ( class EXPORT AnnulusOperator< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                             \
  {                                                               \
  typedef AnnulusOperator< ITK_TEMPLATE_2 TypeX >                 \
  AnnulusOperator##TypeY;                                       \
  }                                                               \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkAnnulusOperator+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkAnnulusOperator.hxx"
#endif

#endif