]> Creatis software - clitk.git/blob - common/clitkCommon.h
Merge branch 'master' of git://git.creatis.insa-lyon.fr/clitk
[clitk.git] / common / clitkCommon.h
1 /*=========================================================================
2   Program:   vv                     http://www.creatis.insa-lyon.fr/rio/vv
3
4   Authors belong to: 
5   - University of LYON              http://www.universite-lyon.fr/
6   - Léon Bérard cancer center       http://www.centreleonberard.fr
7   - CREATIS CNRS laboratory         http://www.creatis.insa-lyon.fr
8
9   This software is distributed WITHOUT ANY WARRANTY; without even
10   the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
11   PURPOSE.  See the copyright notices for more information.
12
13   It is distributed under dual licence
14
15   - BSD        See included LICENSE.txt file
16   - CeCILL-B   http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
17 ===========================================================================**/
18
19 #ifndef CLITKCOMMON_H
20 #define CLITKCOMMON_H
21
22 // clitk include
23 #include "clitkPortability.h"
24 #include "clitkDD.h"
25 #include "clitkExceptionObject.h"
26
27 // itk include (include std)
28 #include <itkContinuousIndex.h>
29 #include <itkMacro.h>
30 #include <itkImageRegionConstIterator.h>
31 #include <itkImageRegionIterator.h>
32
33 // std include
34 #include <fstream>
35
36 // Include for "rusage"
37 #include <ctime> 
38 #if defined(unix) || defined(__APPLE__)
39 #  include <sys/time.h>
40 #  include <sys/resource.h>
41 #elif defined(WIN32)
42 #  include <windows.h>
43 #endif
44
45 //--------------------------------------------------------------------
46 namespace clitk {
47
48   typedef unsigned char uchar;
49   typedef unsigned short ushort;
50   typedef unsigned int uint;
51   
52 #define CLITK_TRY_CATCH_EXIT(func) \
53   try { \
54     func; \
55   } \
56   catch (const itk::ExceptionObject& e) { \
57     e.Print(std::cout); \
58     exit(-1);\
59   } \
60   catch (const std::exception& e) { \
61     std::cout << e.what() << std::endl; \
62     exit(-2);\
63   } \
64   catch (...) { \
65     std::cout << "Unknown excpetion" << std::endl; \
66     exit(-3); \
67   }
68     
69
70   //--------------------------------------------------------------------
71   // when everything goes wrong
72 #define WHEREAMI "[ " << __FILE__  << " ] line " << __LINE__
73 #define FATAL(a) std::cerr << "ERROR in " << WHEREAMI << ": " << a; exit(0);
74   
75   //--------------------------------------------------------------------
76   // GGO with modified struct name
77 #define GGO(ggo_filename, args_info)                                    \
78   args_info_##ggo_filename args_info;                                   \
79   cmdline_parser_##ggo_filename##2(argc, argv, &args_info, 1, 1, 0);                    \
80   if (args_info.config_given)                                           \
81     cmdline_parser_##ggo_filename##_configfile (args_info.config_arg, &args_info, 0, 0, 1); \
82   else cmdline_parser_##ggo_filename(argc, argv, &args_info);  
83
84   //--------------------------------------------------------------------
85   // skip line with #
86   void skipComment(std::istream & is);
87
88   //--------------------------------------------------------------------
89   // linear (rough) conversion from Hounsfield Unit to density
90   double HU2density(double HU);
91
92   //--------------------------------------------------------------------
93   // Return filename extension
94   std::string GetExtension(const std::string& filename);
95   
96   //--------------------------------------------------------------------
97   // Convert float, double ... to string
98   template<class T> std::string toString(const T & t);
99   template<class T> std::string toStringVector(const T * t, const int n);
100   template<class T> std::string toStringVector(const T & t, const int n);
101   template<class T> std::string toStringVector(const std::vector<T> & t);
102   template <class T> bool fromString(T& t, 
103                                      const std::string& s, 
104                                      std::ios_base& (*f)(std::ios_base&)=std::dec);
105
106   //--------------------------------------------------------------------
107   // Display a progress %
108   void VerboseInProgress(const int nb, const int current, const int percentage);
109   void VerboseInProgressInPercentage(const int nb, const int current, const int percentage);
110
111   //--------------------------------------------------------------------
112   // Convert a pixel type to another (downcast)
113   template<class TPixelUp, class TPixelDown>
114   TPixelDown PixelTypeDownCast(const TPixelUp & x);
115   template<>
116   float PixelTypeDownCast(const double & x);
117
118   //--------------------------------------------------------------------
119   // Return the indexes of sorted values in a vector
120   template<class Type> struct vectorComparisonLowerThan;
121   template<class Type> struct vectorComparisonGreaterThan;
122   template<class Type>
123   void GetSortedIndex(const std::vector<Type> & toSort, std::vector<int> & index, bool increasing=true);
124
125   //--------------------------------------------------------------------
126   // Return the name of a type as a string
127   template<class TPixel>
128   std::string GetTypeAsString();
129   
130   //--------------------------------------------------------------------
131   // Convert radian / degree
132   double rad2deg(double anglerad);
133   double deg2rad(double anglerad);
134
135   //--------------------------------------------------------------------
136   int GetTypeSizeFromString(const std::string & type);
137
138   //--------------------------------------------------------------------
139   // Special case to handle "signed_char = schar" ...
140   template<class T>
141   bool IsSameType(std::string t) { return (t==GetTypeAsString<T>()); }
142   template<> bool IsSameType<char>(std::string t);
143   template<> bool IsSameType<signed char>(std::string t);
144   template<> bool IsSameType<unsigned char>(std::string t);
145   template<> bool IsSameType<unsigned short>(std::string t);
146
147   //--------------------------------------------------------------------
148   template<class T1>
149   std::string CreateListOfTypes(bool last=true) {
150     return GetTypeAsString<T1>();
151   }
152   
153   template<class T1, class T2>
154   std::string CreateListOfTypes(bool last=true) {
155     if (last) return CreateListOfTypes<T1>()+" and "+CreateListOfTypes<T2>();
156     else return CreateListOfTypes<T1>()+", "+CreateListOfTypes<T2>();
157   }
158   
159   template<class T1, class T2, class T3>
160   std::string CreateListOfTypes(bool last=true) {
161     if (last) return CreateListOfTypes<T1,T2>(false)+" and "+CreateListOfTypes<T3>();
162     else return CreateListOfTypes<T1,T2>(false)+", "+CreateListOfTypes<T3>();
163   }
164
165   template<class T1, class T2, class T3, class T4>
166   std::string CreateListOfTypes(bool last=true) {
167     if (last) return CreateListOfTypes<T1,T2,T3>(false)+" and "+CreateListOfTypes<T4>();
168     else return CreateListOfTypes<T1,T2,T3>(false)+", "+CreateListOfTypes<T4>();
169   }
170
171   template<class T1, class T2, class T3, class T4, class T5>
172   std::string CreateListOfTypes(bool last=true) {
173     if (last) return CreateListOfTypes<T1,T2,T3,T4>(false)+" and "+CreateListOfTypes<T5>();
174     else return CreateListOfTypes<T1,T2,T3,T4>(false)+", "+CreateListOfTypes<T5>();
175   }
176
177   template<class T1, class T2, class T3, class T4, class T5, class T6>
178   std::string CreateListOfTypes(bool last=true) {
179     if (last) return CreateListOfTypes<T1,T2,T3,T4,T5>(false)+" and "+CreateListOfTypes<T6>();
180     else return CreateListOfTypes<T1,T2,T3,T4,T5>(false)+", "+CreateListOfTypes<T6>();
181   }
182
183   template<class T1, class T2, class T3, class T4, class T5, class T6, class T7>
184   std::string CreateListOfTypes(bool last=true) {
185     if (last) return CreateListOfTypes<T1,T2,T3,T4,T5,T6>(false)+" and "+CreateListOfTypes<T7>();
186     else return CreateListOfTypes<T1,T2,T3,T4,T5,T6>(false)+", "+CreateListOfTypes<T7>();
187   }
188
189   template<class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8>
190   std::string CreateListOfTypes(bool last=true) {
191     if (last) return CreateListOfTypes<T1,T2,T3,T4,T5,T6,T7>(false)+" and "+CreateListOfTypes<T8>();
192     else return CreateListOfTypes<T1,T2,T3,T4,T5,T6,T7>(false)+", "+CreateListOfTypes<T8>();
193   }
194   //--------------------------------------------------------------------
195   
196   //--------------------------------------------------------------------
197   void FindAndReplace(std::string & line, const std::string & tofind, const std::string & replacement);
198   void FindAndReplace(std::string & line, const std::vector<std::string> & tofind, const std::vector<std::string> & toreplace);
199   void FindAndReplace(std::ifstream & in, const std::vector<std::string> & tofind, const std::vector<std::string> & toreplace, std::ofstream & out);
200   //--------------------------------------------------------------------
201
202   //--------------------------------------------------------------------
203   double ComputeEuclideanDistanceFromPointToPlane(const itk::ContinuousIndex<double, 3> point, 
204                                                   const itk::ContinuousIndex<double, 3> pointInPlane, 
205                                                   const itk::ContinuousIndex<double, 3> normalPlane);
206
207   //--------------------------------------------------------------------
208   // Open a File for reading/writing
209   void openFileForReading(std::ifstream & is, const std::string & filename);
210   void openFileForWriting(std::ofstream & os, const std::string & filename);
211
212   //--------------------------------------------------------------------
213   void readDoubleFromFile(const std::string & filename, std::vector<double> & list);
214
215   //--------------------------------------------------------------------
216   double cotan(double i);
217   double invcotan(double i);
218
219   //--------------------------------------------------------------------
220   void disableStdCerr();
221   void enableStdCerr();
222
223   //--------------------------------------------------------------------
224   template<class ImageType>
225   void CloneImage(const typename ImageType::Pointer & input, typename ImageType::Pointer & output);
226
227   //--------------------------------------------------------------------
228   void PrintMemoryUsed();
229
230   //--------------------------------------------------------------------
231   // Convert a map to a vector
232   template <typename M, typename V> 
233   void MapToVecFirst(const M & m, V & v);
234   template <typename M, typename V> 
235   void MapToVecSecond(const M & m, V & v);
236
237 #include "clitkCommon.txx"
238
239 } // end namespace
240
241 #endif /* end #define CLITKCOMMON_H */
242