DGtal  1.5.beta
ImageCache.ih
1 /**
2  * This program is free software: you can redistribute it and/or modify
3  * it under the terms of the GNU Lesser General Public License as
4  * published by the Free Software Foundation, either version 3 of the
5  * License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program. If not, see <http://www.gnu.org/licenses/>.
14  *
15  **/
16 
17 /**
18  * @file ImageCache.ih
19  * @author Martial Tola (\c martial.tola@liris.cnrs.fr )
20  * Laboratoire d'InfoRmatique en Image et Systèmes d'information - LIRIS (CNRS, UMR 5205), CNRS, France
21  *
22  * @date 2013/01/24
23  *
24  * Implementation of inline methods defined in ImageCache.h
25  *
26  * This file is part of the DGtal library.
27  */
28 
29 
30 //////////////////////////////////////////////////////////////////////////////
31 #include <cstdlib>
32 
33 //////////////////////////////////////////////////////////////////////////////
34 
35 ///////////////////////////////////////////////////////////////////////////////
36 // IMPLEMENTATION of inline methods.
37 ///////////////////////////////////////////////////////////////////////////////
38 
39 ///////////////////////////////////////////////////////////////////////////////
40 // ----------------------- Standard services ------------------------------
41 
42 
43 ///////////////////////////////////////////////////////////////////////////////
44 // Interface - public :
45 
46 /**
47  * Writes/Displays the object on an output stream.
48  * @param out the output stream where the object is written.
49  */
50 template <typename TImageContainer, typename TImageFactory, typename TReadPolicy, typename TWritePolicy>
51 inline
52 void
53 DGtal::ImageCache<TImageContainer, TImageFactory, TReadPolicy, TWritePolicy>::selfDisplay ( std::ostream & out ) const
54 {
55  out << "[ImageCache] ";
56 }
57 
58 template <typename TImageContainer, typename TImageFactory, typename TReadPolicy, typename TWritePolicy>
59 inline
60 bool
61 DGtal::ImageCache<TImageContainer, TImageFactory, TReadPolicy, TWritePolicy>::read(const Point & aPoint, Value &aValue) const
62 {
63  ImageContainer *myImagePtr = myReadPolicy->getPage(aPoint);
64  if (myImagePtr)
65  {
66  aValue = myImagePtr->operator()(aPoint);
67  return true;
68  }
69 
70  return false;
71 }
72 
73 template <typename TImageContainer, typename TImageFactory, typename TReadPolicy, typename TWritePolicy>
74 inline
75 TImageContainer *
76 DGtal::ImageCache<TImageContainer, TImageFactory, TReadPolicy, TWritePolicy>::getPage(const Domain & aDomain) const
77 {
78  return myReadPolicy->getPage(aDomain);
79 }
80 
81 template <typename TImageContainer, typename TImageFactory, typename TReadPolicy, typename TWritePolicy>
82 inline
83 bool
84 DGtal::ImageCache<TImageContainer, TImageFactory, TReadPolicy, TWritePolicy>::write(const Point & aPoint, const Value &aValue)
85 {
86  ImageContainer *myImagePtr = myReadPolicy->getPage(aPoint);
87  if (myImagePtr)
88  {
89  myWritePolicy->writeInPage(myImagePtr, aPoint, aValue);
90  return true;
91  }
92 
93  return false;
94 }
95 
96 template <typename TImageContainer, typename TImageFactory, typename TReadPolicy, typename TWritePolicy>
97 inline
98 void
99 DGtal::ImageCache<TImageContainer, TImageFactory, TReadPolicy, TWritePolicy>::update(const Domain &aDomain)
100 {
101  ImageContainer *myImagePtr = myReadPolicy->getPageToDetach();
102 
103  if (myImagePtr)
104  {
105  myWritePolicy->flushPage(myImagePtr);
106 
107  myImageFactoryPtr->detachImage(myImagePtr);
108  }
109 
110  myReadPolicy->updateCache(aDomain);
111 }
112 
113 ///////////////////////////////////////////////////////////////////////////////
114 // Implementation of inline functions //
115 
116 template <typename TImageContainer, typename TImageFactory, typename TReadPolicy, typename TWritePolicy>
117 inline
118 std::ostream&
119 DGtal::operator<< ( std::ostream & out,
120  const ImageCache<TImageContainer, TImageFactory, TReadPolicy, TWritePolicy> & object )
121 {
122  object.selfDisplay( out );
123  return out;
124 }
125 
126 // //
127 ///////////////////////////////////////////////////////////////////////////////
128 
129