itkBinaryBallStructuringElement.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 __itkBinaryBallStructuringElement_h
#define __itkBinaryBallStructuringElement_h

#include "itkNeighborhood.h"

namespace itk
{
template< class TPixel, unsigned int VDimension = 2,
          class TAllocator = NeighborhoodAllocator< TPixel > >
class ITK_EXPORT BinaryBallStructuringElement:
  public Neighborhood< TPixel, VDimension, TAllocator >
{
public:
  typedef BinaryBallStructuringElement                   Self;
  typedef Neighborhood< TPixel, VDimension, TAllocator > Superclass;

  typedef TAllocator AllocatorType;

  itkStaticConstMacro(NeighborhoodDimension, unsigned int, VDimension);

  typedef TPixel PixelType;

  typedef typename AllocatorType::iterator       Iterator;
  typedef typename AllocatorType::const_iterator ConstIterator;

  typedef typename Superclass::SizeType      SizeType;
  typedef typename Superclass::SizeValueType SizeValueType;

  typedef typename Superclass::RadiusType RadiusType;

  typedef SliceIterator< TPixel, Self > SliceIteratorType;

  BinaryBallStructuringElement() {}

  virtual ~BinaryBallStructuringElement() {}

  BinaryBallStructuringElement(const Self & other):
    Neighborhood< TPixel, VDimension, TAllocator >(other)
  {}

  Self & operator=(const Self & other)
  {
    Superclass::operator=(other);
    return *this;
  }

  void CreateStructuringElement();

protected:
private:
};
} // namespace itk

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

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

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

#endif