r460: no message
[ctsim.git] / include / imagefile.h
1 /*****************************************************************************
2 ** FILE IDENTIFICATION
3 **
4 **      Name:         imagefile.h
5 **      Purpose:      imagefile class header
6 **      Programmer:   Kevin Rosenberg
7 **      Date Started: June 2000
8 **
9 **  This is part of the CTSim program
10 **  Copyright (c) 1983-2001 Kevin Rosenberg
11 **
12 **  $Id: imagefile.h,v 1.31 2001/01/28 19:10:18 kevin Exp $
13 **
14 **  This program is free software; you can redistribute it and/or modify
15 **  it under the terms of the GNU General Public License (version 2) as
16 **  published by the Free Software Foundation.
17 **
18 **  This program is distributed in the hope that it will be useful,
19 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
20 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 **  GNU General Public License for more details.
22 **
23 **  You should have received a copy of the GNU General Public License
24 **  along with this program; if not, write to the Free Software
25 **  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 ******************************************************************************/
27
28 #ifndef IMAGEFILE_H
29 #define IMAGEFILE_H
30
31 #ifndef MSVC
32 #include <unistd.h>
33 #endif
34 #include <string>
35 #include <sys/types.h>
36 #include <fstream>
37 #include <iostream>
38 #include "ctsupport.h"
39 #include "fnetorderstream.h"
40 #include "array2dfile.h"
41
42 #ifdef HAVE_MPI
43 #include <mpi++.h>
44 #endif
45
46 class F32Image : public Array2dFile
47 {
48 public:
49   F32Image (int nx, int ny, int dataType = Array2dFile::DATA_TYPE_REAL);     
50   F32Image (void);
51
52   kfloat32** getArray (void)
53       { return (kfloat32**) (m_arrayData); }
54
55   kfloat32** const getArray (void) const
56        { return (kfloat32** const) (m_arrayData); }
57
58   kfloat32** getImaginaryArray (void)
59       { return (kfloat32**) (m_imaginaryArrayData); }
60
61   kfloat32** const getImaginaryArray (void) const
62        { return (kfloat32** const) (m_imaginaryArrayData); }
63
64 #ifdef HAVE_MPI
65   MPI::Datatype getMPIDataType (void) const
66       { return MPI::FLOAT; }
67 #endif
68
69  private:
70   F32Image (const F32Image& rhs);             //copy constructor
71   F32Image& operator= (const F32Image& rhs);  // assignment operator
72 };
73
74
75 class F64Image : public Array2dFile
76 {
77  public:
78
79    F64Image (int nx, int ny, int dataType = Array2dFile::DATA_TYPE_REAL);
80   F64Image (void);
81
82   kfloat64** getArray (void)
83       { return (kfloat64**) (m_arrayData); }
84
85   kfloat64** const getArray (void) const
86       { return (kfloat64** const) (m_arrayData); }
87
88   kfloat64** getImaginaryArray (void)
89       { return (kfloat64**) (m_imaginaryArrayData); }
90
91   kfloat64** const getImaginaryArray (void) const
92       { return (kfloat64** const) (m_imaginaryArrayData); }
93
94 #ifdef HAVE_MPI
95   MPI::Datatype getMPIDataType (void) const
96       { return MPI::DOUBLE; }
97 #endif
98  private:
99   F64Image (const F64Image& rhs);             //copy constructor
100   F64Image& operator= (const F64Image& rhs);  // assignment operator
101 };
102
103 #undef IMAGEFILE_64_BITS
104 #ifdef IMAGEFILE_64_BITS
105 typedef F64Image   ImageFileBase;
106 typedef kfloat64   ImageFileValue;
107 typedef kfloat64*  ImageFileColumn;
108 typedef kfloat64** ImageFileArray;
109 typedef kfloat64** const ImageFileArrayConst;
110 typedef const kfloat64* ImageFileColumnConst;
111 #else
112 typedef F32Image   ImageFileBase;
113 typedef kfloat32   ImageFileValue;
114 typedef kfloat32*  ImageFileColumn;
115 typedef kfloat32** ImageFileArray;
116 typedef kfloat32** const ImageFileArrayConst;
117 typedef const kfloat32* ImageFileColumnConst;
118 #endif
119
120
121 class ImageFile : public ImageFileBase
122 {
123 private:
124
125   static const char* s_aszFormatName[];
126   static const char* s_aszFormatTitle[];
127   static const int s_iFormatCount;
128
129 public:
130
131   static const int FORMAT_INVALID;
132   static const int FORMAT_PGM;
133   static const int FORMAT_PGMASCII;
134 #if HAVE_PNG
135   static const int FORMAT_PNG;
136   static const int FORMAT_PNG16;
137 #endif
138
139   static const int getFormatCount() {return s_iFormatCount;}
140   static const char** getFormatNameArray() {return s_aszFormatName;}
141   static const char** getFormatTitleArray() {return s_aszFormatTitle;}
142   static int convertFormatNameToID (const char* const formatName);
143   static const char* convertFormatIDToName (const int formatID);
144   static const char* convertFormatIDToTitle (const int formatID);
145
146   ImageFile (int nx, int ny)
147       : ImageFileBase (nx, ny)
148   {}
149
150   ImageFile (void)
151       : ImageFileBase ()
152   {}
153
154   void getCenterCoordinates (unsigned int& iXCenter, unsigned int& iYCenter);
155
156   bool convertRealToComplex ();
157   bool convertComplexToReal ();
158
159   void filterResponse (const char* const domainName, double bw, const char* const filterName, double filt_param, double dInputScale = 1., double dOutputScale = 1.);
160
161   void statistics (double& min, double& max, double& mean, double& mode, double& median, double& stddev) const;
162   void statistics (ImageFileArrayConst v, double& min, double& max, double& mean, double& mode, double& median, double& stddev) const;
163   void getMinMax (double& min, double& max) const;
164   void printStatistics (std::ostream& os) const;
165   bool comparativeStatistics (const ImageFile& imComp, double& d, double& r, double& e) const;
166   bool printComparativeStatistics (const ImageFile& imComp, std::ostream& os) const;
167
168   bool subtractImages (const ImageFile& rRHS, ImageFile& result) const;
169   bool addImages (const ImageFile& rRHS, ImageFile& result) const;
170   bool multiplyImages (const ImageFile& rRHS, ImageFile& result) const;
171   bool divideImages (const ImageFile& rRHS, ImageFile& result) const;
172
173   bool scaleImage (ImageFile& result) const;
174
175   bool invertPixelValues (ImageFile& result) const;
176   bool sqrt (ImageFile& result) const;
177   bool square (ImageFile& result) const;
178   bool log (ImageFile& result) const;
179   bool exp (ImageFile& result) const;
180   bool fourier (ImageFile& result) const;
181   bool inverseFourier (ImageFile& result) const;
182 #ifdef HAVE_FFTW
183   bool fft (ImageFile& result) const;
184   bool ifft (ImageFile& result) const;
185   bool fftRows (ImageFile& result) const;
186   bool ifftRows (ImageFile& result) const;
187   bool fftCols (ImageFile& result) const;
188   bool ifftCols (ImageFile& result) const;
189 #endif
190   bool magnitude (ImageFile& result) const;
191   bool phase (ImageFile& result) const;
192
193   int display (void) const;
194   int displayScaling (const int scaleFactor, ImageFileValue pmin, ImageFileValue pmax) const;
195
196   bool exportImage (const char* const pszFormat, const char* const pszFilename, int nxcell, int nycell, double densmin, double densmax);
197
198 #if HAVE_PNG
199   bool writeImagePNG (const char* const outfile, int bitdepth, int nxcell, int nycell, double densmin, double densmax);
200 #endif
201 #if HAVE_GD
202   bool writeImageGIF (const char* const outfile, int nxcell, int nycell, double densmin, double densmax);
203 #endif
204   bool writeImagePGM (const char* const outfile, int nxcell, int nycell, double densmin, double densmax);
205   bool writeImagePGMASCII (const char* const outfile, int nxcell, int nycell, double densmin, double densmax);
206 };
207
208
209 #endif