DGtal  1.5.beta
CanonicCellEmbedder.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 CanonicCellEmbedder.ih
19  * @author Jacques-Olivier Lachaud (\c jacques-olivier.lachaud@univ-savoie.fr )
20  * Laboratory of Mathematics (CNRS, UMR 5127), University of Savoie, France
21  *
22  * @date 2012/02/28
23  *
24  * Implementation of inline methods defined in CanonicCellEmbedder.h
25  *
26  * This file is part of the DGtal library.
27  */
28 
29 ///////////////////////////////////////////////////////////////////////////////
30 // IMPLEMENTATION of inline methods.
31 ///////////////////////////////////////////////////////////////////////////////
32 
33 //////////////////////////////////////////////////////////////////////////////
34 #include <cstdlib>
35 #include <cmath>
36 #include "DGtal/kernel/NumberTraits.h"
37 //////////////////////////////////////////////////////////////////////////////
38 
39 
40 
41 ///////////////////////////////////////////////////////////////////////////////
42 // Implementation of inline methods //
43 //-----------------------------------------------------------------------------
44 template <typename TKSpace>
45 inline
46 DGtal::CanonicCellEmbedder<TKSpace>::
47 ~CanonicCellEmbedder()
48 {}
49 //-----------------------------------------------------------------------------
50 template <typename TKSpace>
51 inline
52 DGtal::CanonicCellEmbedder<TKSpace>::
53 CanonicCellEmbedder()
54  : myKSpace( 0 )
55 {}
56 //-----------------------------------------------------------------------------
57 template <typename TKSpace>
58 inline
59 DGtal::CanonicCellEmbedder<TKSpace>::
60 CanonicCellEmbedder( ConstAlias<KSpace> aKSpace )
61  : myKSpace( &aKSpace )
62 {}
63 //-----------------------------------------------------------------------------
64 template <typename TKSpace>
65 inline
66 DGtal::CanonicCellEmbedder<TKSpace>::
67 CanonicCellEmbedder( const Self & other )
68  : myKSpace( other.myKSpace )
69 {}
70 //-----------------------------------------------------------------------------
71 template <typename TKSpace>
72 inline
73 typename DGtal::CanonicCellEmbedder<TKSpace>::Self &
74 DGtal::CanonicCellEmbedder<TKSpace>::
75 operator=( const Self & other )
76 {
77  myKSpace = other.myKSpace;
78  return *this;
79 }
80 //-----------------------------------------------------------------------------
81 template <typename TKSpace>
82 inline
83 const typename DGtal::CanonicCellEmbedder<TKSpace>::KSpace &
84 DGtal::CanonicCellEmbedder<TKSpace>::space() const
85 {
86  ASSERT( this->isValid() );
87  return *myKSpace;
88 }
89 //-----------------------------------------------------------------------------
90 template <typename TKSpace>
91 inline
92 typename DGtal::CanonicCellEmbedder<TKSpace>::RealPoint
93 DGtal::CanonicCellEmbedder<TKSpace>::embed( const Cell & cell ) const
94 {
95  return this->operator()( cell );
96 }
97 //-----------------------------------------------------------------------------
98 template <typename TKSpace>
99 inline
100 typename DGtal::CanonicCellEmbedder<TKSpace>::RealPoint
101 DGtal::CanonicCellEmbedder<TKSpace>::operator()( const Cell & cell ) const
102 {
103  ASSERT( this->isValid() );
104  Point dp = myKSpace->uKCoords( cell );
105  RealPoint p;
106  for ( Dimension i = 0; i < dp.size(); ++i )
107  p[ i ] = ( NumberTraits<Integer>::castToDouble( dp[ i ] ) / 2.0 ) - 0.5; /// In Khalimsky Space, 0-Cells have even coordinates, while in the embedding, voxel centers have integer coordinates, we need to shift all coordinates by -1/2
108  return p;
109 }
110 //-----------------------------------------------------------------------------
111 template <typename TKSpace>
112 inline
113 bool
114 DGtal::CanonicCellEmbedder<TKSpace>::isValid( ) const
115 {
116  return myKSpace != 0;
117 }
118 ///////////////////////////////////////////////////////////////////////////////
119 // Implementation of inline functions and external operators //
120 
121 /**
122  * Overloads 'operator<<' for displaying objects of class 'CanonicCellEmbedder'.
123  * @param out the output stream where the object is written.
124  * @param object the object of class 'CanonicCellEmbedder' to write.
125  * @return the output stream after the writing.
126  */
127 template <typename TKSpace>
128 inline
129 std::ostream&
130 DGtal::operator<< ( std::ostream & out,
131  const CanonicCellEmbedder<TKSpace> & object )
132 {
133  object.selfDisplay ( out );
134  return out;
135 }
136 
137 // //
138 ///////////////////////////////////////////////////////////////////////////////
139 
140