ITK  4.2.0
Insight Segmentation and Registration Toolkit
itkImageToListSampleAdaptor.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 __itkImageToListSampleAdaptor_h
19 #define __itkImageToListSampleAdaptor_h
20 
21 #include <typeinfo>
22 
23 #include "itkImage.h"
24 #include "itkPixelTraits.h"
25 #include "itkListSample.h"
26 #include "itkSmartPointer.h"
27 #include "itkImageRegionIterator.h"
29 
30 namespace itk
31 {
32 namespace Statistics
33 {
52 template< class TImage >
53 class ITK_EXPORT ImageToListSampleAdaptor:
54  public ListSample< typename MeasurementVectorPixelTraits< typename TImage::PixelType >::MeasurementVectorType >
55 {
56 public:
59 
60  typedef ListSample< typename MeasurementVectorPixelTraits<
61  typename TImage::PixelType >::MeasurementVectorType >
63 
66 
68  itkTypeMacro(ImageToListSampleAdaptor, ListSample);
69 
71  itkNewMacro(Self);
72 
74  typedef TImage ImageType;
75  typedef typename ImageType::Pointer ImagePointer;
76  typedef typename ImageType::ConstPointer ImageConstPointer;
77  typedef typename ImageType::IndexType IndexType;
78  typedef typename ImageType::PixelType PixelType;
79  typedef typename ImageType::PixelContainerConstPointer PixelContainerConstPointer;
80 
85 
86 
91 
94 
95  typedef typename Superclass::AbsoluteFrequencyType AbsoluteFrequencyType;
96  typedef typename Superclass::TotalAbsoluteFrequencyType TotalAbsoluteFrequencyType;
97  typedef typename Superclass::MeasurementVectorSizeType MeasurementVectorSizeType;
98  typedef typename Superclass::InstanceIdentifier InstanceIdentifier;
99 
101 
103  void SetImage(const TImage *image);
104 
106  const TImage * GetImage() const;
107 
109  InstanceIdentifier Size() const;
110 
112  virtual const MeasurementVectorType & GetMeasurementVector(InstanceIdentifier id) const;
113 
114  virtual MeasurementVectorSizeType GetMeasurementVectorSize() const
115  {
116  // some filter are expected that this method returns something even if the
117  // input is not set. This won't be the right value for a variable length vector
118  // but it's better than an exception.
119  if( m_Image.IsNull() )
120  {
121  return Superclass::GetMeasurementVectorSize();
122  }
123  else
124  {
125  return m_Image->GetNumberOfComponentsPerPixel();
126  }
127  }
128 
130  AbsoluteFrequencyType GetFrequency(InstanceIdentifier id) const;
131 
133  TotalAbsoluteFrequencyType GetTotalFrequency() const;
134 
140  {
142 public:
143 
145  {
146  *this = adaptor->Begin();
147  }
148 
150  {
151  m_Iter = iter.m_Iter;
152  m_InstanceIdentifier = iter.m_InstanceIdentifier;
153  }
154 
155  ConstIterator & operator=(const ConstIterator & iter)
156  {
157  m_Iter = iter.m_Iter;
158  m_InstanceIdentifier = iter.m_InstanceIdentifier;
159  return *this;
160  }
161 
162  AbsoluteFrequencyType GetFrequency() const
163  {
164  return 1;
165  }
166 
167  const MeasurementVectorType & GetMeasurementVector() const
168  {
169  MeasurementVectorTraits::Assign( this->m_MeasurementVectorCache, m_Iter.Get() );
170  return this->m_MeasurementVectorCache;
171  }
172 
173  InstanceIdentifier GetInstanceIdentifier() const
174  {
175  return m_InstanceIdentifier;
176  }
177 
178  ConstIterator & operator++()
179  {
180  ++m_Iter;
181  ++m_InstanceIdentifier;
182  return *this;
183  }
184 
185  bool operator!=(const ConstIterator & it)
186  {
187  return ( m_Iter != it.m_Iter );
188  }
189 
190  bool operator==(const ConstIterator & it)
191  {
192  return ( m_Iter == it.m_Iter );
193  }
194 
195 protected:
196  // This method should only be available to the ListSample class
199  InstanceIdentifier iid)
200  {
201  m_Iter = iter;
202  m_InstanceIdentifier = iid;
203  }
204 
205  // This method is purposely not implemented
206  ConstIterator();
207 private:
211  };
212 
217  class Iterator:public ConstIterator
218  {
220 public:
221 
222  Iterator(Self *adaptor):ConstIterator(adaptor)
223  {}
224 
225  Iterator(const Iterator & iter):ConstIterator(iter)
226  {}
227 
228  Iterator & operator=(const Iterator & iter)
229  {
230  this->ConstIterator::operator=(iter);
231  return *this;
232  }
233 
234 protected:
235  // To ensure const-correctness these method must not be in the public API.
236  // The are purposly not implemented, since they should never be called.
237  Iterator();
238  Iterator(const Self *adaptor);
240  Iterator(const ConstIterator & it);
241  ConstIterator & operator=(const ConstIterator & it);
242 
244  {}
245 
246 private:
247  };
248 
250  Iterator Begin()
251  {
252  ImagePointer nonConstImage = const_cast< ImageType * >( m_Image.GetPointer() );
253  ImageIteratorType imageIterator( nonConstImage, nonConstImage->GetLargestPossibleRegion() );
254  imageIterator.GoToBegin();
255  Iterator iter(imageIterator, 0);
256  return iter;
257  }
259 
261  Iterator End()
262  {
263  ImagePointer nonConstImage = const_cast< ImageType * >( m_Image.GetPointer() );
264  ImageIteratorType imageIterator( nonConstImage, nonConstImage->GetLargestPossibleRegion() );
265  imageIterator.GoToEnd();
266  Iterator iter( imageIterator, m_Image->GetPixelContainer()->Size() );
268 
269  return iter;
270  }
271 
273  ConstIterator Begin() const
274  {
275  ImageConstIteratorType imageConstIterator( m_Image, m_Image->GetLargestPossibleRegion() );
276  imageConstIterator.GoToBegin();
277  ConstIterator iter(imageConstIterator, 0);
279 
280  return iter;
281  }
282 
284  ConstIterator End() const
285  {
286  ImageConstIteratorType imageConstIterator( m_Image, m_Image->GetLargestPossibleRegion() );
287  imageConstIterator.GoToEnd();
288  ConstIterator iter( imageConstIterator, m_Image->GetPixelContainer()->Size() );
290 
291  return iter;
292  }
293 
294 protected:
297  void PrintSelf(std::ostream & os, Indent indent) const;
298 
299 private:
300  ImageToListSampleAdaptor(const Self &); //purposely not implemented
301  void operator=(const Self &); //purposely not implemented
302 
305 
306 }; // end of class ImageToListSampleAdaptor
307 } // end of namespace Statistics
308 } // end of namespace itk
309 
310 #ifndef ITK_MANUAL_INSTANTIATION
311 #include "itkImageToListSampleAdaptor.hxx"
312 #endif
313 
314 #endif
315