ITK  4.2.0
Insight Segmentation and Registration Toolkit
itkSumOfSquaresImageFunction.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 __itkSumOfSquaresImageFunction_h
19 #define __itkSumOfSquaresImageFunction_h
20 
21 #include "itkImageFunction.h"
22 #include "itkNumericTraits.h"
23 #include "itkNeighborhood.h"
24 
25 namespace itk
26 {
43 template< class TInputImage, class TCoordRep = float >
44 class ITK_EXPORT SumOfSquaresImageFunction:
45  public ImageFunction< TInputImage, typename NumericTraits< typename TInputImage::PixelType >::RealType,
46  TCoordRep >
47 {
48 public:
49 
53  TCoordRep > Superclass;
54 
57 
60 
62  itkNewMacro(Self);
63 
65  typedef TInputImage InputImageType;
66 
68  typedef typename Superclass::OutputType OutputType;
69 
71  typedef typename Superclass::IndexType IndexType;
72 
74  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
75 
77  typedef typename Superclass::PointType PointType;
78 
80  itkStaticConstMacro(ImageDimension, unsigned int,
81  InputImageType::ImageDimension);
82 
86 
88  virtual RealType EvaluateAtIndex(const IndexType & index) const;
89 
91  virtual RealType Evaluate(const PointType & point) const
92  {
93  IndexType index;
94 
95  this->ConvertPointToNearestIndex(point, index);
96  return this->EvaluateAtIndex(index);
97  }
98 
99  virtual RealType EvaluateAtContinuousIndex(
100  const ContinuousIndexType & cindex) const
101  {
102  IndexType index;
103 
104  this->ConvertContinuousIndexToNearestIndex(cindex, index);
105  return this->EvaluateAtIndex(index);
106  }
107 
110  itkGetConstReferenceMacro(NeighborhoodRadius, unsigned int);
111 
112  void SetNeighborhoodRadius(unsigned int radius)
113  {
114  m_NeighborhoodRadius = radius;
115 
116  m_NeighborhoodSize = 1;
117  long twoRPlus1 = 2 * m_NeighborhoodRadius + 1;
118  for ( unsigned int i = 0; i < ImageDimension; i++ )
119  {
120  m_NeighborhoodSize *= twoRPlus1;
121  }
122  }
123 
124  itkGetConstReferenceMacro(NeighborhoodSize, unsigned int);
125 protected:
128  void PrintSelf(std::ostream & os, Indent indent) const;
129 
130 private:
131  SumOfSquaresImageFunction(const Self &); //purposely not implemented
132  void operator=(const Self &); //purposely not implemented
133 
134  unsigned int m_NeighborhoodRadius;
135  unsigned int m_NeighborhoodSize;
136 };
137 } // end namespace itk
138 
139 // Define instantiation macro for this template.
140 #define ITK_TEMPLATE_SumOfSquaresImageFunction(_, EXPORT, TypeX, TypeY) \
141  namespace itk \
142  { \
143  _( 2 ( class EXPORT SumOfSquaresImageFunction< ITK_TEMPLATE_2 TypeX > ) ) \
144  namespace Templates \
145  { \
146  typedef SumOfSquaresImageFunction< ITK_TEMPLATE_2 TypeX > \
147  SumOfSquaresImageFunction##TypeY; \
148  } \
149  }
150 
151 #if ITK_TEMPLATE_EXPLICIT
152 #include "Templates/itkSumOfSquaresImageFunction+-.h"
153 #endif
154 
155 #if ITK_TEMPLATE_TXX
156 #include "itkSumOfSquaresImageFunction.hxx"
157 #endif
158 
159 #endif
160