iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PixelPainter.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_IMAGEPROC_DRAWING_PIXELPAINTER_H
37 #define INCLUDE_NRT_IMAGEPROC_DRAWING_PIXELPAINTER_H
38 
39 namespace nrt
40 {
41  /*! @defgroup imagedrawingutils General Image Drawing Utils
42  General utilities to assist in Image drawing functions
43 
44  \ingroup imagedrawing
45  \see imagedrawing
46  \see image */
47 
48  /*! @{ */ // **********************************************************************
49 
50  //! The PixelPainter class is a small optimization for drawing on Images.
51  /*! It performs 2 optimizations:
52 
53  - It automatically caches the representation of the drawing color in the destination Image's color space.
54  @code
55  // We have some Image...
56  Image<PixRGB<byte> > myImage(640, 480, ImageInitPolicy::Zeros);
57 
58  // Create a new PixelPainter to help us with drawing an HSV color onto our RGB Image. The PixelPainter will
59  // immediately convert the input HSV color to the destination color (RGB). This ensures that later, when we want
60  // to draw, we can just copy the converted RGB values onto our destination Image.
61  PixelPainter<byte, PixRGB, byte, PixHSV> painter(PixHSV<byte>(240, 255, 134));
62 
63  // Paint our color onto the Image
64  Image<PixRGB<byte> >::iterator it = myImage.begin();
65  for (; it != myImage.end(); ++it) painter.paint(it);
66  @endcode
67 
68  - It completely avoids alpha blending if the source color does not have an alpha channel.
69  @code
70  // We have some Image...
71  Image<PixRGB<byte> > myImage(640, 480, ImageInitPolicy::Zeros);
72 
73  // Create a new PixelPainter to help us with drawing a PixRGBA color (e.g. half opaque red) onto our RGB Image. No
74  // colorspace conversion is necessary here, however the PixelPainter that is created knows that it can't just copy
75  // the input color into the destination Image - it will have to blend the input color with the underlying Image
76  // instead.
77  PixelPainter<byte, PixRGB, byte, PixRGBA> painter(PixRGBA<byte>(255, 0, 0, 128));
78 
79  // Blend the input color onto the Image
80  Image<PixRGB<byte> >::iterator it = myImage.begin();
81  for (; it != myImage.end(); ++it) painter.paint(it);
82  @endcode */
83  template<
84  class T,
85  template<typename> class PixDest,
86  class U,
87  template<typename> class PixSource,
88  class Enable = void
89  >
91  {
92  public:
93  PixelPainter(PixSource<U> const& color);
94  void paint(PixDest<T>* dest);
95  };
96 
97  /*! @} */ // **********************************************************************
98 
100 }
101 
102 #endif // INCLUDE_NRT_IMAGEPROC_DRAWING_PIXELPAINTER_H