2d/image.hh
Go to the documentation of this file.
1 /* -*- mia-c++ -*-
2  *
3  * This file is part of MIA - a toolbox for medical image analysis
4  * Copyright (c) Leipzig, Madrid 1999-2015 Gert Wollny
5  *
6  * MIA is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with MIA; if not, see <http://www.gnu.org/licenses/>.
18  *
19  */
20 
21 
22 #ifndef mia_2d_2dimage_hh
23 #define mia_2d_2dimage_hh
24 
25 #include <mia/core/attributes.hh>
26 #include <mia/core/pixeltype.hh>
27 #include <mia/core/filter.hh>
28 #include <mia/core/msgstream.hh>
29 #include <mia/core/tools.hh>
30 #include <mia/core/type_traits.hh>
31 #include <mia/2d/vectorfield.hh>
32 
34 
35 #define ATTR_IMAGE_KMEANS_CLASSES "kmeans"
36 
37 
48 public:
51  static const char *data_descr;
52 
55 
57  typedef std::shared_ptr<C2DImage > Pointer;
58 
59  virtual ~C2DImage();
60 
62  EPixelType get_pixel_type() const;
63 
65  const C2DBounds& get_size() const;
66 
68  C2DFVector get_pixel_size() const;
69 
71  void set_pixel_size(const C2DFVector& pixel);
72 
73 
75  C2DFVector get_origin() const;
76 
78  void set_origin(const C2DFVector& origin);
79 
84  virtual C2DImage* clone() const __attribute__((warn_unused_result)) = 0;
85 
86  protected:
89  C2DImage(const C2DBounds& size, EPixelType type);
90 
93  C2DImage(const CAttributedData& attributes, const C2DBounds& size, EPixelType type);
94 
98  C2DImage();
99 
100  private:
101  C2DBounds m_size;
102  EPixelType m_pixel_type;
103 };
104 
106 typedef C2DImage::Pointer P2DImage;
107 
109 typedef std::vector<P2DImage> C2DImageSeries;
110 
111 typedef std::shared_ptr<C2DImageSeries> P2DImageSeries;
112 
113 typedef std::vector<C2DImageSeries> C2DImageSeriesGroup;
114 typedef std::map<std::string, C2DImageSeriesGroup> C2DImageGroupedSeries;
115 
116 
124 template <typename T>
125 class EXPORT_2D T2DImage : public C2DImage {
126 public:
128  typedef C2DImage Super;
129 
131  typedef typename T2DDatafield<T>::iterator iterator;
132  typedef typename T2DDatafield<T>::const_iterator const_iterator;
133  typedef typename T2DDatafield<T>::const_reference const_reference;
134  typedef typename T2DDatafield<T>::reference reference;
135  typedef typename T2DDatafield<T>::const_pointer const_pointer;
136  typedef typename T2DDatafield<T>::pointer pointer;
137  typedef typename T2DDatafield<T>::value_type value_type;
138  typedef typename T2DDatafield<T>::difference_type difference_type;
139  typedef typename T2DDatafield<T>::size_type size_type;
140  typedef typename T2DDatafield<T>::range_iterator range_iterator;
141  typedef typename T2DDatafield<T>::const_range_iterator const_range_iterator;
142  typedef typename T2DDatafield<T>::range_iterator_with_boundary_flag range_iterator_with_boundary_flag;
143  typedef typename T2DDatafield<T>::const_range_iterator_with_boundary_flag const_range_iterator_with_boundary_flag;
144 
145  typedef typename T2DDatafield<T>::data_array data_array;
146 
148 
154  T2DImage(const C2DBounds& size, const T* init_data);
155 
161  T2DImage(const C2DBounds& size, const data_array& init_data);
167  T2DImage(const C2DBounds& size, const CAttributedData& attr);
168 
173  T2DImage(const C2DBounds& size);
174 
178  T2DImage(const T2DImage& orig);
179 
184  T2DImage(const T2DDatafield<T>& orig);
185 
191  T2DImage(const T2DDatafield<T>& orig, const CAttributedData& attr);
192 
193  T2DImage();
194 
198  virtual C2DImage* clone() const __attribute__((warn_unused_result));
199 
201  const_reference operator()(size_t x, size_t y) const {
202  return m_image(x,y);
203  }
204 
206  reference operator()(size_t x, size_t y){
207  return m_image(x,y);
208  }
209 
211  const_reference operator[](size_t idx) const {
212  return m_image[idx];
213  }
214 
216  reference operator[](size_t idx){
217  return m_image[idx];
218  }
219 
221  const_reference operator()(const C2DBounds& l) const{
222  return m_image(l.x,l.y);
223  }
224 
226  reference operator()(const C2DBounds& l){
227  return m_image(l.x,l.y);
228  }
229 
231  const_iterator begin()const {
232  return m_image.begin();
233  }
234 
236  const_iterator end()const {
237  return m_image.end();
238  }
239 
241  iterator begin() {
242  return m_image.begin();
243  }
244 
246  iterator end() {
247  return m_image.end();
248  }
249 
251  const_iterator begin_at(size_t x, size_t y)const {
252  return m_image.begin_at(x, y);
253  }
254 
256  iterator begin_at(size_t x, size_t y) {
257  return m_image.begin_at(x, y);
258  }
259 
261  range_iterator begin_range(const C2DBounds& begin, const C2DBounds& end) {
262  return m_image.begin_range(begin, end);
263  }
264 
266  range_iterator end_range(const C2DBounds& begin, const C2DBounds& end){
267  return m_image.end_range(begin, end);
268  }
269 
271  const_range_iterator begin_range(const C2DBounds& begin, const C2DBounds& end)const {
272  return m_image.begin_range(begin, end);
273  }
274 
276  const_range_iterator end_range(const C2DBounds& begin, const C2DBounds& end) const{
277  return m_image.end_range(begin, end);
278  }
279 
281  size_t size() const;
282 
284  const T2DDatafield<T>& data() const;
285 
287  void get_data_line_x(size_t y, std::vector<T>& buffer) const;
288 
290  void get_data_line_y(size_t x, std::vector<T>& buffer) const;
291 
293  void put_data_line_x(size_t y, const std::vector<T>& buffer);
294 
296  void put_data_line_y(size_t x, const std::vector<T>& buffer);
297 
303  C2DFVector get_gradient(size_t idx) const;
304 
310  C2DFVector get_gradient(const C2DFVector& p) const;
311 private:
312  T2DDatafield<T> m_image;
313 };
314 
319 class CImageComparePrinter: public TFilter<int> {
320 public:
321  template <typename T, typename S>
322  int operator () (const T2DImage<T>& src, const T2DImage<S>& ref) const {
323  typename T2DImage<T>::const_iterator si = src.begin();
324  typename T2DImage<T>::const_iterator se = src.end();
325  typename T2DImage<S>::const_iterator ri = ref.begin();
326 
327  while (si != se)
328  cvdebug() << *si++ << " expect " << *ri++ << "\n";
329  return 0;
330  }
331 };
332 
336 template <typename S>
337 struct plugin_data_type<T2DImage<S> > {
338  typedef C2DImage type;
339 };
341 
351 EXPORT_2D bool operator == (const C2DImage& a, const C2DImage& b);
352 
357 inline bool operator != (const C2DImage& a, const C2DImage& b)
358 {
359  return ! (a == b );
360 }
361 
362 
368 
376 public:
377  template <typename T>
378  P2DImage operator () (const T2DImage<T>& image) const {
379  return P2DImage(new T2DImage<T>(image));
380  }
381 };
382 
385 
388 
391 
394 
397 
400 
403 
404 #ifdef LONG_64BIT
407 
410 #endif
411 
414 
417 
426 template <>
427 struct Binder<C2DImage> {
429  typedef __bind_all<T2DImage> Derived;
430 };
431 
432 //@endcond INTERNAL
433 
445 template <typename O>
446 struct FConvert2DImageToPixeltypeO: public TFilter<T2DImage<O> > {
447 
453  template <typename T>
454  T2DImage<O> operator () (const T2DImage<T> &image) const {
455  T2DImage<O> result(image.get_size(), image);
456  copy(image.begin(), image.end(), result.begin());
457  return result;
458  }
459 
466  T2DImage<O> operator () (const C2DImage &image) const {
467  return filter(*this, image);
468  }
469 
476  T2DImage<O> operator () (P2DImage image) const {
477  return filter(*this, *image);
478  }
479 };
480 
481 
489 
490 
492 
493 #endif
C2DImage::Pointer P2DImage
Shared pointer representation of the 2D Image.
Definition: 2d/image.hh:106
CDebugSink & cvdebug()
Definition: msgstream.hh:216
std::map< std::string, C2DImageSeriesGroup > C2DImageGroupedSeries
Definition: 2d/image.hh:114
T2DImage< signed int > C2DSIImage
2D image with signed 32 bit integer values
Definition: 2d/image.hh:399
functor to convert an image with an abitrary pixel type to single floating point pixels ...
Definition: 2d/image.hh:446
2D Vector field
iterator end()
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:246
std::vector< C2DImageSeries > C2DImageSeriesGroup
Definition: 2d/image.hh:113
EPixelType
Definition: pixeltype.hh:32
functor to copy an image into paointer representation
Definition: 2d/image.hh:375
T2DImage< double > C2DDImage
2D image with double precsion floating point values
Definition: 2d/image.hh:416
base class for all filer type functors.
Definition: core/filter.hh:68
T y
second element
Definition: 2d/vector.hh:56
This is the template version of a 2D image that is used for holding real data.
Definition: 2d/image.hh:125
class EXPORT_CORE CMeans private
#define NS_MIA_BEGIN
conveniance define to start the mia namespace
Definition: defines.hh:43
A collection of attributes.
Definition: attributes.hh:253
T2DImage< unsigned short > C2DUSImage
2D image with unsigned 16 bit integer values
Definition: 2d/image.hh:396
T2DImage< float > C2DFImage
2D image with single precsion floating point values
Definition: 2d/image.hh:413
static F::result_type filter(const F &f, const B &b)
Definition: core/filter.hh:230
const_iterator end() const
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:236
EXPORT_2D bool operator==(const C2DImage &a, const C2DImage &b)
bool operator!=(const C2DImage &a, const C2DImage &b)
Definition: 2d/image.hh:357
range_iterator begin_range(const C2DBounds &begin, const C2DBounds &end)
forwarding function to access the specified range of the underlying T2DDatafield
Definition: 2d/image.hh:261
reference operator[](size_t idx)
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:216
T2DImage< signed short > C2DSSImage
2D image with signed 16 bit integer values
Definition: 2d/image.hh:393
#define EXPORT_2D
Definition: defines2d.hh:37
iterator begin_at(size_t x, size_t y)
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:256
iterator begin()
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:241
const_range_iterator begin_range(const C2DBounds &begin, const C2DBounds &end) const
forwarding function to access the specified range of the underlying T2DDatafield
Definition: 2d/image.hh:271
T2DImage< unsigned int > C2DUIImage
2D image with unsigned 32 bit integer values
Definition: 2d/image.hh:402
EXPORT_2D C2DFVectorfield get_gradient(const C2DImage &image)
const_iterator begin() const
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:231
std::shared_ptr< C2DImage > Pointer
2D Image pointer type
Definition: 2d/image.hh:57
static const char * data_descr
Definition: 2d/image.hh:51
A class to hold data on a regular 2D grid.
Definition: 2d/datafield.hh:53
C2DImage Super
define the super class of this class for generic processing
Definition: 2d/image.hh:128
const_reference operator[](size_t idx) const
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:211
T2DImage< unsigned char > C2DUBImage
2D image with unsigned 8 bit integer values
Definition: 2d/image.hh:390
reference operator()(size_t x, size_t y)
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:206
const_iterator begin_at(size_t x, size_t y) const
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:251
std::shared_ptr< C2DImageSeries > P2DImageSeries
Definition: 2d/image.hh:111
range_iterator end_range(const C2DBounds &begin, const C2DBounds &end)
forwarding function to access the specified range of the underlying T2DDatafield
Definition: 2d/image.hh:266
FConvert2DImageToPixeltypeO< float > FCopy2DImageToFloatRepn
short name for 2DImage to float pixel repn copy functor
Definition: 2d/image.hh:488
const_range_iterator end_range(const C2DBounds &begin, const C2DBounds &end) const
forwarding function to access the specified range of the underlying T2DDatafield
Definition: 2d/image.hh:276
This is the base class for 2D images that can hold generic pixel data.
Definition: 2d/image.hh:47
C2DBounds dimsize_type
a definition of the image dimension type for
Definition: 2d/image.hh:54
T2DImage< bool > C2DBitImage
2D image with binary values
Definition: 2d/image.hh:384
T2DImage< signed char > C2DSBImage
2D image with signed 8 bit integer values
Definition: 2d/image.hh:387
a class to print out the intensity values of two images to compare them
Definition: 2d/image.hh:319
const C2DBounds & get_size() const
::std::vector< T > data_array
type for the flat reprentation of the 2D data field
Definition: 2d/datafield.hh:58
std::vector< P2DImage > C2DImageSeries
helper type for image series
Definition: 2d/image.hh:109
T2DImage< signed long > C2DSLImage
2D image with signed 64 bit integer values
Definition: 2d/image.hh:406
T2DImage< unsigned long > C2DULImage
2D image with unsigned 64 bit integer values
Definition: 2d/image.hh:409
const_reference operator()(const C2DBounds &l) const
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:221
reference operator()(const C2DBounds &l)
forwarding function to access the underlying T2DDatafield
Definition: 2d/image.hh:226
T x
first element
Definition: 2d/vector.hh:53
#define NS_MIA_END
conveniance define to end the mia namespace
Definition: defines.hh:46