ITK  5.3.0
Insight Toolkit
itkBinaryBallStructuringElement.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkBinaryBallStructuringElement_h
19 #define itkBinaryBallStructuringElement_h
20 
21 #include "itkNeighborhood.h"
22 
23 namespace itk
24 {
61 template <typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
62 class ITK_TEMPLATE_EXPORT BinaryBallStructuringElement : public Neighborhood<TPixel, VDimension, TAllocator>
63 {
64 public:
68 
70  using AllocatorType = TAllocator;
71 
73  static constexpr unsigned int NeighborhoodDimension = VDimension;
74 
76  using PixelType = TPixel;
77 
81  using Iterator = typename AllocatorType::iterator;
82  using ConstIterator = typename AllocatorType::const_iterator;
83 
85  using typename Superclass::SizeType;
86  using typename Superclass::SizeValueType;
87 
89  using typename Superclass::RadiusType;
90 
93 
95  BinaryBallStructuringElement() = default;
96 
98  ~BinaryBallStructuringElement() override = default;
99 
102  : Neighborhood<TPixel, VDimension, TAllocator>(other)
103  {}
104 
106  Self &
107  operator=(const Self & other)
108  {
109  Superclass::operator=(other);
110  return *this;
111  }
113 
115  void
116  CreateStructuringElement();
117 
118 protected:
119 private:
120 };
121 } // namespace itk
122 
123 #ifndef ITK_MANUAL_INSTANTIATION
124 # include "itkBinaryBallStructuringElement.hxx"
125 #endif
126 
127 #endif
itk::BinaryBallStructuringElement
A Neighborhood that represents a ball structuring element (ellipsoid) with binary elements.
Definition: itkBinaryBallStructuringElement.h:62
itk::BinaryBallStructuringElement::BinaryBallStructuringElement
BinaryBallStructuringElement(const Self &other)
Definition: itkBinaryBallStructuringElement.h:101
itk::Size
Represent a n-dimensional size (bounds) of a n-dimensional image.
Definition: itkSize.h:69
itk::SliceIterator
A flexible iterator for itk containers(i.e. itk::Neighborhood) that support pixel access through oper...
Definition: itkSliceIterator.h:48
itk::Neighborhood
A light-weight container object for storing an N-dimensional neighborhood of values.
Definition: itkNeighborhood.h:54
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itkNeighborhood.h
itk::Neighborhood::AllocatorType
TAllocator AllocatorType
Definition: itkNeighborhood.h:61
itk::Neighborhood::Iterator
typename AllocatorType::iterator Iterator
Definition: itkNeighborhood.h:75
itk::Neighborhood::PixelType
TPixel PixelType
Definition: itkNeighborhood.h:70
itk::Neighborhood::ConstIterator
typename AllocatorType::const_iterator ConstIterator
Definition: itkNeighborhood.h:76
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::BinaryBallStructuringElement::operator=
Self & operator=(const Self &other)
Definition: itkBinaryBallStructuringElement.h:107
itk::SizeValueType
unsigned long SizeValueType
Definition: itkIntTypes.h:83