ITK  4.8.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< typename TImage >
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 
99 
101 
103  void SetImage(const TImage *image);
104 
106  const TImage * GetImage() const;
107 
109  InstanceIdentifier Size() const ITK_OVERRIDE;
110 
112  virtual const MeasurementVectorType & GetMeasurementVector(InstanceIdentifier id) const ITK_OVERRIDE;
113 
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  {
122  }
123  else
124  {
125  return m_Image->GetNumberOfComponentsPerPixel();
126  }
127  }
128 
131 
133  TotalAbsoluteFrequencyType GetTotalFrequency() const ITK_OVERRIDE;
134 
140  {
142 
143  public:
144 
146  {
147  *this = adaptor->Begin();
148  }
149 
150  ConstIterator(const ConstIterator & iter) :
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 
163  {
164  return 1;
165  }
166 
168  {
169  MeasurementVectorTraits::Assign( this->m_MeasurementVectorCache, m_Iter.Get() );
170  return this->m_MeasurementVectorCache;
171  }
172 
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
198  m_Iter(iter),
199  m_InstanceIdentifier(iid)
200  {}
201 
202  // This method is purposely not implemented
203  ConstIterator();
204 
205  private:
209  };
210 
215  class Iterator:
216  public ConstIterator
217  {
219 
220  public:
221 
222  Iterator(Self *adaptor) :
223  ConstIterator(adaptor)
224  {}
225 
226  Iterator(const Iterator & iter):
227  ConstIterator(iter)
228  {}
229 
230  Iterator & operator=(const Iterator & iter)
231  {
232  this->ConstIterator::operator=(iter);
233  return *this;
234  }
235 
236  protected:
237  // To ensure const-correctness these method must not be in the public API.
238  // The are purposly not implemented, since they should never be called.
239  Iterator();
240  Iterator(const Self *adaptor);
242  Iterator(const ConstIterator & it);
243  ConstIterator & operator=(const ConstIterator & it);
244 
246  ConstIterator(iter, iid)
247  {}
248 
249  private:
250  };
251 
254  {
255  ImagePointer nonConstImage = const_cast< ImageType * >( m_Image.GetPointer() );
256  ImageIteratorType imageIterator( nonConstImage, nonConstImage->GetLargestPossibleRegion() );
257  imageIterator.GoToBegin();
258  Iterator iter(imageIterator, 0);
259  return iter;
260  }
262 
265  {
266  ImagePointer nonConstImage = const_cast< ImageType * >( m_Image.GetPointer() );
267  const typename ImageType::RegionType & largestRegion = nonConstImage->GetLargestPossibleRegion();
268  ImageIteratorType imageIterator( nonConstImage, largestRegion );
269  imageIterator.GoToEnd();
270  Iterator iter( imageIterator, largestRegion.GetNumberOfPixels() );
272 
273  return iter;
274  }
275 
278  {
279  ImageConstIteratorType imageConstIterator( m_Image, m_Image->GetLargestPossibleRegion() );
280  imageConstIterator.GoToBegin();
281  ConstIterator iter(imageConstIterator, 0);
283 
284  return iter;
285  }
286 
289  {
290  const typename ImageType::RegionType & largestRegion = m_Image->GetLargestPossibleRegion();
291  ImageConstIteratorType imageConstIterator( m_Image, largestRegion );
292  imageConstIterator.GoToEnd();
293  ConstIterator iter( imageConstIterator, largestRegion.GetNumberOfPixels() );
295 
296  return iter;
297  }
298 
299 protected:
302  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
303 
304 private:
305  ImageToListSampleAdaptor(const Self &); //purposely not implemented
306  void operator=(const Self &); //purposely not implemented
307 
310 
311 }; // end of class ImageToListSampleAdaptor
312 } // end of namespace Statistics
313 } // end of namespace itk
314 
315 #ifndef ITK_MANUAL_INSTANTIATION
316 #include "itkImageToListSampleAdaptor.hxx"
317 #endif
318 
319 #endif
AbsoluteFrequencyType GetFrequency(InstanceIdentifier id) const override
MeasurementVectorTraitsType::ValueType MeasurementType
virtual const MeasurementVectorType & GetMeasurementVector(InstanceIdentifier id) const override
virtual MeasurementVectorSizeType GetMeasurementVectorSize() const override
Superclass::TotalAbsoluteFrequencyType TotalAbsoluteFrequencyType
Definition: itkListSample.h:71
ImageRegionConstIterator< ImageType > ImageConstIteratorType
ImageRegionIterator< ImageType > ImageIteratorType
static void Assign(TArrayType &m, const TArrayType &v)
Traits for a pixel that define the dimension and component type.
MeasurementVectorTraitsTypes< MeasurementVectorType > MeasurementVectorTraitsType
Superclass::AbsoluteFrequencyType AbsoluteFrequencyType
Definition: itkListSample.h:70
Superclass::AbsoluteFrequencyType AbsoluteFrequencyType
Superclass::InstanceIdentifier InstanceIdentifier
Definition: itkListSample.h:72
MeasurementPixelTraitsType::MeasurementVectorType MeasurementVectorType
Iterator(const ImageIteratorType &iter, InstanceIdentifier iid)
Superclass::TotalAbsoluteFrequencyType TotalAbsoluteFrequencyType
InstanceIdentifier Size() const override
TotalAbsoluteFrequencyType GetTotalFrequency() const override
Superclass::MeasurementVectorSizeType MeasurementVectorSizeType
Definition: itkListSample.h:68
virtual MeasurementVectorSizeType GetMeasurementVectorSize() const
Superclass::MeasurementVectorSizeType MeasurementVectorSizeType
void PrintSelf(std::ostream &os, Indent indent) const override
ListSample< typename MeasurementVectorPixelTraits< typename TImage::PixelType >::MeasurementVectorType > Superclass
This class is the native implementation of the a Sample with an STL container.
Definition: itkListSample.h:51
Control indentation during Print() invocation.
Definition: itkIndent.h:49
void SetImage(const TImage *image)
This class provides ListSample interface to ITK Image.
PixelTraits< typename TImage::PixelType > PixelTraitsType
Base class for all data objects in ITK.
MeasurementVectorPixelTraits< PixelType > MeasurementPixelTraitsType
A multi-dimensional iterator templated over image type that walks a region of pixels.
ConstIterator(const ImageConstIteratorType &iter, InstanceIdentifier iid)
ImageType::PixelContainerConstPointer PixelContainerConstPointer