ITK  4.6.0
Insight Segmentation and Registration Toolkit
itkNeighborhoodOperator.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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 __itkNeighborhoodOperator_h
19 #define __itkNeighborhoodOperator_h
20 
21 #include "itkNeighborhood.h"
22 #include "itkNumericTraits.h"
23 #include <vector>
24 
25 namespace itk
26 {
64 template< typename TPixel, unsigned int VDimension,
65  typename TAllocator = NeighborhoodAllocator< TPixel > >
67  public Neighborhood< TPixel, VDimension, TAllocator >
68 {
69 public:
73 
75  typedef typename Superclass::SizeType SizeType;
76 
78  typedef TPixel PixelType;
79 
82 
85  { m_Direction = 0; }
86 
88  NeighborhoodOperator(const Self & orig):
89  Neighborhood< TPixel, VDimension, TAllocator >(orig)
90  { m_Direction = orig.m_Direction; }
91 
93  Self & operator=(const Self & orig)
94  {
96  m_Direction = orig.m_Direction;
97  return *this;
98  }
100 
102  void SetDirection(const unsigned long & direction)
103  { m_Direction = direction; }
104 
106  unsigned long GetDirection() const
107  { return m_Direction; }
108 
113  virtual void CreateDirectional();
114 
119  virtual void CreateToRadius(const SizeType &);
120 
125  virtual void CreateToRadius(const SizeValueType);
126 
129  virtual void FlipAxes();
130 
132  virtual void PrintSelf(std::ostream & os, Indent i) const
133  {
134  os << i << "NeighborhoodOperator { this=" << this
135  << " Direction = " << m_Direction << " }" << std::endl;
137  }
139 
141 
145 
146 protected:
149  typedef std::vector< PixelRealType > CoefficientVector;
150 
154 
157  virtual void Fill(const CoefficientVector &) = 0;
158 
164  virtual void FillCenteredDirectional(const CoefficientVector &);
165 
168  {
169  for ( unsigned int i = 0; i < this->Size(); ++i )
170  {
172  }
173  }
175 
176 private:
178  unsigned long m_Direction;
179 };
180 } // namespace itk
181 
182 #ifndef ITK_MANUAL_INSTANTIATION
183 #include "itkNeighborhoodOperator.hxx"
184 #endif
185 
186 /*
187 #ifndef ITK_MANUAL_INSTANTIATION
188 #include "itkNeighborhoodOperator.hxx"
189 #endif
190 */
191 #endif
void ScaleCoefficients(PixelRealType)
Neighborhood< TPixel, VDimension, TAllocator > Superclass
virtual void CreateDirectional()
virtual CoefficientVector GenerateCoefficients()=0
A light-weight container object for storing an N-dimensional neighborhood of values.
virtual void Fill(const CoefficientVector &)=0
Self & operator=(const Self &other)
TPixel & operator[](NeighborIndexType i)
unsigned long GetDirection() const
unsigned long SizeValueType
Definition: itkIntTypes.h:143
void SetDirection(const unsigned long &direction)
NumericTraits< TPixel >::RealType PixelRealType
std::vector< PixelRealType > CoefficientVector
Virtual class that defines a common interface to all neighborhood operator subtypes.
NeighborIndexType Size() const
virtual void PrintSelf(std::ostream &, Indent) const
virtual void PrintSelf(std::ostream &os, Indent i) const
typedef::itk::Size< VDimension > SizeType
virtual void CreateToRadius(const SizeType &)
A flexible iterator for itk containers(i.e. itk::Neighborhood) that support pixel access through oper...
SliceIterator< TPixel, Self > SliceIteratorType
virtual void FillCenteredDirectional(const CoefficientVector &)
Self & operator=(const Self &orig)
Control indentation during Print() invocation.
Definition: itkIndent.h:49
Define additional traits for native types such as int or float.
Indent GetNextIndent()
NeighborhoodOperator(const Self &orig)