r2088: *** empty log message ***
[ctsim.git] / libctsim / array2dfile.cpp
1 /*****************************************************************************
2 ** FILE IDENTIFICATION
3 **
4 **      Name:         array2dfile.cpp
5 **      Purpose:      2-dimension array file class
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: array2dfile.cpp,v 1.29 2002/05/28 18:43:16 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 #include "array2dfile.h"
29 #include <ctime>
30 #ifdef MSVC
31 typedef long off_t;
32 #endif
33
34
35 const kuint16 Array2dFile::m_signature = ('I'*256+'F');
36
37 ///////////////////////////////////////////////////////////////////////////
38 // CLASS IMPLEMENTATION
39 //
40 //     Name: Array2dFileLabel
41 //     Purpose: Labels for Array2dFiles
42 ///////////////////////////////////////////////////////////////////////////
43
44 void
45 Array2dFileLabel::init (void)
46 {
47   m_calcTime = 0;
48   m_labelType = L_EMPTY;
49   time_t t = time(0);
50   tm* lt = localtime(&t);
51   m_year = lt->tm_year;
52   m_month = lt->tm_mon;
53   m_day = lt->tm_mday;
54   m_hour = lt->tm_hour;
55   m_minute = lt->tm_min;
56   m_second = lt->tm_sec;
57 }
58
59 Array2dFileLabel::Array2dFileLabel() 
60 {
61   init();
62 }
63
64 Array2dFileLabel::Array2dFileLabel(const char* const str, double ctime)
65 : m_strLabel (str)
66 {
67   init();
68   
69   m_labelType = L_USER;
70   m_calcTime = ctime;
71 }
72
73 Array2dFileLabel::Array2dFileLabel(const int type, const char* const str, double ctime)
74 :  m_strLabel (str)
75 {
76   init();
77   
78   m_labelType = type;
79   m_calcTime = ctime;
80 }
81
82 Array2dFileLabel::~Array2dFileLabel()
83 {
84 }
85
86 void 
87 Array2dFileLabel::setDateTime (int year, int month, int day, int hour, int minute, int second)
88 {
89   m_year = year;
90   m_month = month;
91   m_day = day;
92   m_hour = hour;
93   m_minute = minute;
94   m_second = second;
95 }
96
97 void 
98 Array2dFileLabel::getDateTime (int& year, int& month, int& day, int& hour, int& minute, int& second) const
99 {
100   year = m_year;
101   month = m_month;
102   day = m_day;
103   hour = m_hour;
104   minute = m_minute;
105   second = m_second;
106 }
107
108 const std::string& 
109 Array2dFileLabel::getDateString (void) const
110 {
111   char szDate [128];
112   snprintf (szDate, sizeof(szDate), "%2d/%02d/%4d %02d:%02d:%02d",
113     m_month + 1, m_day, m_year + 1900, m_hour, m_minute, m_second);
114   m_strDate = szDate;
115   return m_strDate;
116 }
117
118
119 Array2dFileLabel::Array2dFileLabel (const Array2dFileLabel& rhs)
120 {
121   m_calcTime = rhs.m_calcTime;
122   m_labelType = rhs.m_labelType;
123   m_strLabel = rhs.m_strLabel;
124   m_year = rhs.m_year; m_month = rhs.m_month; m_day = rhs.m_day;
125   m_hour = rhs.m_hour; m_minute = rhs.m_minute; m_second = rhs.m_second;
126 }
127
128 Array2dFileLabel&
129 Array2dFileLabel::operator= (const Array2dFileLabel& rhs)
130 {
131   m_calcTime = rhs.m_calcTime;
132   m_labelType = rhs.m_labelType;
133   m_strLabel = rhs.m_strLabel;
134   m_year = rhs.m_year; m_month = rhs.m_month; m_day = rhs.m_day;
135   m_hour = rhs.m_hour; m_minute = rhs.m_minute; m_second = rhs.m_second;
136   
137   return (*this);
138 }
139
140 void
141 Array2dFileLabel::print (std::ostream& os) const
142 {
143   if (m_labelType == L_HISTORY) {
144     os << "History: " << std::endl;
145     os << "  " << m_strLabel << std::endl;
146     os << "  calc time = " << m_calcTime << " secs" << std::endl;
147     os << "  Timestamp = " << getDateString() << std::endl;
148   } else if (m_labelType == L_USER) {
149     os << "Note: " <<  m_strLabel << std::endl;
150     os << "  Timestamp = %s" << getDateString() << std::endl;
151   } else {
152     os << "Unknown (" << m_labelType << "): " <<  m_strLabel << std::endl;
153     os << "  Timestamp = %s" << getDateString() << std::endl;
154   }
155 }
156
157 void
158 Array2dFileLabel::printBrief (std::ostream& os) const
159 {
160   if (m_labelType == L_HISTORY) {
161     os << "History (";
162     if (m_calcTime > 0)
163       os << m_calcTime << " secs, ";
164     os << getDateString() << "): " << m_strLabel << std::endl;
165   } else if (m_labelType == L_USER) {
166     os << "Note (" <<  getDateString() << "): " << m_strLabel << std::endl;
167   } else {
168     os << "Unknown (" << getDateString() << "): " << m_strLabel << std::endl;
169   }
170 }
171
172 void
173 Array2dFileLabel::printBrief (std::ostringstream& os) const
174 {
175   if (m_labelType == L_HISTORY) {
176     os << "History (";
177     if (m_calcTime > 0)
178       os << m_calcTime << " secs, ";
179     os << getDateString().c_str() << "): " << m_strLabel.c_str() << "\n";
180   } else if (m_labelType == L_USER) {
181     os << "Note (" <<  getDateString() << "): " << m_strLabel << "\n";
182   } else {
183     os << "Unknown (" << getDateString() << "): " << m_strLabel << "\n";
184   }
185 }
186
187
188 ///////////////////////////////////////////////////////////////////////////
189 // CLASS IMPLEMENTATION
190 //
191 //     Name: Array2dFile
192 //     Purpose: Array2dFiles
193 ///////////////////////////////////////////////////////////////////////////
194
195
196 Array2dFile::Array2dFile (int x, int y, int pixelSize, int pixelFormat, int dataType)
197 {
198   init();
199   setArraySize (x, y, pixelSize, pixelFormat, dataType);
200 }
201
202 Array2dFile::~Array2dFile (void)
203 {
204   freeArrays ();
205   for (labelIterator l = m_labels.begin(); l != m_labels.end(); l++)
206     delete *l;
207 }
208
209 Array2dFile::Array2dFile (void)
210 {
211   init();
212 }
213
214 void
215 Array2dFile::init (void)
216 {
217   m_pixelSize = 0;
218   m_pixelFormat = PIXEL_INVALID;
219   m_arrayData = NULL;
220   m_imaginaryArrayData = NULL;
221   m_dataType = DATA_TYPE_INVALID;
222   m_nx = 0;
223   m_ny = 0;
224   m_headersize = 0;
225   m_axisIncrementKnown = false;
226   m_axisIncrementX = m_axisIncrementY = 0;
227   m_axisExtentKnown = false;
228   m_minX = m_maxX = m_minY = m_maxY = 0;
229   m_offsetPV = 0;
230   m_scalePV = 1;
231 }
232
233
234 void
235 Array2dFile::setArraySize (int x, int y, int pixelSize, int pixelFormat, int dataType)
236 {
237   m_pixelSize = pixelSize;
238   m_pixelFormat = pixelFormat;
239   m_dataType = dataType;
240   setArraySize (x, y);
241 }
242
243 void
244 Array2dFile::setArraySize (int x, int y)
245 {
246   m_nx = x;
247   m_ny = y;
248   allocArrays ();
249 }
250
251 bool
252 Array2dFile::reallocComplexToReal ()
253 {
254   if (m_dataType != DATA_TYPE_COMPLEX)
255     return false;
256
257   freeArray (m_imaginaryArrayData);
258   m_dataType = DATA_TYPE_REAL;
259
260   return true;
261 }
262
263
264 bool
265 Array2dFile::reallocRealToComplex ()
266 {
267   if (m_dataType != DATA_TYPE_REAL)
268     return false;
269
270   allocArray (m_imaginaryArrayData);
271   m_dataType = DATA_TYPE_COMPLEX;
272
273   return true;
274 }
275
276
277
278 void 
279 Array2dFile::allocArrays ()
280 {
281   if (m_arrayData) 
282     freeArray (m_arrayData);
283   if (m_imaginaryArrayData)
284     freeArray (m_imaginaryArrayData);
285
286   allocArray (m_arrayData);
287   if (m_dataType == DATA_TYPE_COMPLEX)
288     allocArray (m_imaginaryArrayData);
289 }
290
291 void
292 Array2dFile::allocArray (unsigned char**& rppData)
293 {
294   m_arraySize = m_nx * m_ny * m_pixelSize;
295   rppData = new unsigned char* [m_nx];
296   int columnBytes = m_ny * m_pixelSize;
297   for (unsigned int i = 0; i < m_nx; i++)
298     rppData[i] = new unsigned char [columnBytes];
299 }
300
301 void 
302 Array2dFile::freeArrays ()
303 {
304   if (m_arrayData) 
305     freeArray (m_arrayData);
306   
307   if (m_imaginaryArrayData) 
308     freeArray (m_imaginaryArrayData);
309   
310 }
311
312 void
313 Array2dFile::freeArray (unsigned char**& rppData)
314 {
315    for (unsigned int i = 0; i < m_nx; i++)
316       delete rppData[i];
317     delete rppData;
318     rppData = NULL;
319 }
320
321
322 bool
323 Array2dFile::fileWrite (const std::string& filename)
324 {
325   return fileWrite (filename.c_str());
326 }
327
328 bool
329 Array2dFile::fileWrite (const char* const filename)
330 {
331   m_filename = filename;
332   
333   frnetorderstream fs (m_filename.c_str(), std::ios::out | std::ios::in | std::ios::trunc | std::ios::binary);
334   if (fs.fail()) {
335     sys_error (ERR_WARNING, "Error opening file %s for writing [fileCreate]", m_filename.c_str());
336     return false;
337   }
338   if (! headerWrite(fs))
339     return false;
340   
341   if (! arrayDataWrite (fs))
342     return false;
343   
344   if (! labelsWrite (fs))
345     return false;
346   
347   return true;
348 }
349
350 bool
351 Array2dFile::fileRead (const std::string& filename)
352 {
353   return fileRead (filename.c_str());
354 }
355
356 bool
357 Array2dFile::fileRead (const char* const filename)
358 {
359   m_filename = filename;
360   
361   frnetorderstream fs (m_filename.c_str(), std::ios::out | std::ios::in | std::ios::binary);
362
363   if (fs.fail()) {
364     sys_error (ERR_WARNING, "Unable to open file %s [fileRead]", m_filename.c_str());
365     return false;
366   }
367   
368   if (! headerRead(fs))
369     return false;
370   
371   allocArrays ();
372   
373   if (! arrayDataRead(fs))
374     return false;;
375   
376   if (! labelsRead (fs))
377     return false;
378   
379   return true;
380 }
381
382 void
383 Array2dFile::setAxisIncrement (double incX, double incY)
384 {
385   m_axisIncrementKnown = true;
386   m_axisIncrementX = incX;
387   m_axisIncrementY = incY;
388 }
389
390 void 
391 Array2dFile::setAxisExtent (double minX, double maxX, double minY, double maxY)
392 {
393   m_axisExtentKnown = true;
394   m_minX = minX;
395   m_maxY = maxX;
396   m_minX = minX;
397   m_maxY = maxY;
398 }
399
400 bool
401 Array2dFile::headerRead (frnetorderstream& fs)
402 {
403   if (! fs) {
404     sys_error (ERR_WARNING, "Tried to read header with file closed [headerRead]");
405     return false;
406   }
407   
408   fs.seekg (0);
409   kuint16 file_signature;
410   
411   fs.readInt16 (m_headersize);
412   fs.readInt16 (file_signature);
413   fs.readInt16 (m_pixelFormat);
414   fs.readInt16 (m_pixelSize);
415   fs.readInt16 (m_numFileLabels);
416   fs.readInt32 (m_nx);
417   fs.readInt32 (m_ny);
418   fs.readInt16 (m_dataType);
419   fs.readInt16 (m_axisIncrementKnown);
420   fs.readFloat64 (m_axisIncrementX);
421   fs.readFloat64 (m_axisIncrementY);
422   fs.readInt16 (m_axisExtentKnown);
423   fs.readFloat64 (m_minX);
424   fs.readFloat64 (m_maxX);
425   fs.readFloat64 (m_minY);
426   fs.readFloat64 (m_maxY);
427   fs.readFloat64 (m_offsetPV);
428   fs.readFloat64 (m_scalePV);
429   
430   int read_m_headersize = fs.tellg();
431   if (read_m_headersize != m_headersize) {
432     sys_error (ERR_WARNING, "Read m_headersize %d != file m_headersize %d", read_m_headersize, m_headersize);
433     return false;
434   }
435   if (file_signature != m_signature) {
436     sys_error (ERR_WARNING, "File signature %d != true signature %d", file_signature, m_signature);
437     return false;
438   }
439   
440   return ! fs.fail();
441 }
442
443
444 bool
445 Array2dFile::headerWrite (frnetorderstream& fs)
446 {
447   if (! fs) {
448     sys_error (ERR_WARNING, "Tried to write header with ! fs");
449     return false;
450   }
451   
452   m_numFileLabels = m_labels.size();
453   
454   fs.seekp (0);
455   fs.writeInt16 (m_headersize);
456   fs.writeInt16 (m_signature);
457   fs.writeInt16 (m_pixelFormat);
458   fs.writeInt16 (m_pixelSize);
459   fs.writeInt16 (m_numFileLabels);
460   fs.writeInt32 (m_nx);
461   fs.writeInt32 (m_ny);
462   fs.writeInt16 (m_dataType);
463   fs.writeInt16 (m_axisIncrementKnown);
464   fs.writeFloat64 (m_axisIncrementX);
465   fs.writeFloat64 (m_axisIncrementY);
466   fs.writeInt16 (m_axisExtentKnown);
467   fs.writeFloat64 (m_minX);
468   fs.writeFloat64 (m_maxX);
469   fs.writeFloat64 (m_minY);
470   fs.writeFloat64 (m_maxY);
471   fs.writeFloat64 (m_offsetPV);
472   fs.writeFloat64 (m_scalePV);
473   
474   m_headersize = static_cast<kuint16>(fs.tellp());
475   fs.seekp (0);
476   fs.writeInt16 (m_headersize);
477   
478   return ! fs.fail();
479 }
480
481
482 bool
483 Array2dFile::arrayDataWrite (frnetorderstream& fs)
484 {
485   if (! fs) {
486     sys_error (ERR_WARNING, "Tried to arrayDataWrite with !fs");
487     return false;
488   }
489   
490   if (! m_arrayData) 
491     return false;
492   
493   fs.seekp (m_headersize);
494   int columnSize = m_ny * m_pixelSize;
495   for (unsigned int ix = 0; ix < m_nx; ix++) {
496     unsigned char* ptrColumn = m_arrayData[ix];
497     if (NativeBigEndian()) {
498       for (unsigned int iy = 0; iy < m_ny; iy++) {
499         ConvertReverseNetworkOrder (ptrColumn, m_pixelSize);
500         fs.write (reinterpret_cast<const char*>(ptrColumn), m_pixelSize);
501         ptrColumn += m_pixelSize;
502       }
503     } else 
504       fs.write (reinterpret_cast<const char*>(ptrColumn), columnSize);
505   }
506   if (m_dataType == DATA_TYPE_COMPLEX) {
507     for (unsigned int ix = 0; ix < m_nx; ix++) {
508       unsigned char* ptrColumn = m_imaginaryArrayData[ix];
509       if (NativeBigEndian()) {
510         for (unsigned int iy = 0; iy < m_ny; iy++) {
511           ConvertReverseNetworkOrder (ptrColumn, m_pixelSize);
512           fs.write (reinterpret_cast<const char*>(ptrColumn), m_pixelSize);
513           ptrColumn += m_pixelSize;
514         }
515       } else 
516         fs.write (reinterpret_cast<const char*>(ptrColumn), columnSize);
517     }
518   }
519   
520   return true;
521 }
522
523
524 bool
525 Array2dFile::arrayDataRead (frnetorderstream& fs)
526 {
527   if (! fs) {
528     sys_error (ERR_WARNING, "Tried to arrayDataRead with ! fs");
529     return false;
530   }
531   
532   if (! m_arrayData)
533     return false;
534   
535   fs.seekg (m_headersize);
536   int columnSize = m_ny * m_pixelSize;
537   for (unsigned int ix = 0; ix < m_nx; ix++) {
538     unsigned char* ptrColumn = m_arrayData[ix];
539     if (NativeBigEndian()) {
540       for (unsigned int iy = 0; iy < m_ny; iy++) {
541         fs.read (reinterpret_cast<char*>(ptrColumn), m_pixelSize);
542         ConvertReverseNetworkOrder (ptrColumn, m_pixelSize);
543         ptrColumn += m_pixelSize;
544       } 
545     } else
546       fs.read (reinterpret_cast<char*>(ptrColumn), columnSize);
547   }
548   if (m_dataType == DATA_TYPE_COMPLEX) {
549     for (unsigned int ix = 0; ix < m_nx; ix++) {
550       unsigned char* ptrColumn = m_imaginaryArrayData[ix];
551       if (NativeBigEndian()) {
552         for (unsigned int iy = 0; iy < m_ny; iy++) {
553           fs.read (reinterpret_cast<char*>(ptrColumn), m_pixelSize);
554           ConvertReverseNetworkOrder (ptrColumn, m_pixelSize);
555           ptrColumn += m_pixelSize;
556         } 
557       } else
558         fs.read (reinterpret_cast<char*>(ptrColumn), columnSize);
559     }
560   }
561   
562   return true;
563 }
564
565 bool
566 Array2dFile::labelsRead (frnetorderstream& fs)
567 {
568   off_t pos = m_headersize + m_arraySize;
569   fs.seekg (pos);
570   if (fs.fail())
571     return false;
572   
573   for (int i = 0; i < m_numFileLabels; i++) {
574     kuint16 labelType, year, month, day, hour, minute, second;
575     kfloat64 calcTime;
576     
577     fs.readInt16 (labelType);
578     fs.readInt16 (year);
579     fs.readInt16 (month);
580     fs.readInt16 (day);
581     fs.readInt16 (hour);
582     fs.readInt16 (minute);
583     fs.readInt16 (second);
584     fs.readFloat64 (calcTime);
585     
586     kuint16 strLength;
587     fs.readInt16 (strLength);
588     char* pszLabelStr = new char [strLength+1];
589     fs.read (pszLabelStr, strLength);
590     pszLabelStr[strLength] = 0;
591     
592     Array2dFileLabel* pLabel = new Array2dFileLabel (labelType, pszLabelStr, calcTime);
593     delete pszLabelStr;
594     
595     pLabel->setDateTime (year, month, day, hour, minute, second);
596     m_labels.push_back (pLabel);
597   }
598   
599   return true;
600 }
601
602 bool
603 Array2dFile::labelsWrite (frnetorderstream& fs)
604 {
605   off_t pos = m_headersize + m_arraySize;
606   fs.seekp (pos);
607   
608   for (constLabelIterator l = m_labels.begin(); l != m_labels.end(); l++) {
609     const Array2dFileLabel& label = **l;
610     kuint16 labelType = label.getLabelType();
611     kfloat64 calcTime = label.getCalcTime();
612     const char* const labelString = label.getLabelString().c_str();
613     int year, month, day, hour, minute, second;
614     kuint16 yearBuf, monthBuf, dayBuf, hourBuf, minuteBuf, secondBuf;
615     
616     label.getDateTime (year, month, day, hour, minute, second);
617     yearBuf = year; monthBuf = month; dayBuf = day;
618     hourBuf = hour; minuteBuf = minute; secondBuf = second;
619     
620     fs.writeInt16 (labelType);
621     fs.writeInt16 (yearBuf);
622     fs.writeInt16 (monthBuf);
623     fs.writeInt16 (dayBuf);
624     fs.writeInt16 (hourBuf);
625     fs.writeInt16 (minuteBuf);
626     fs.writeInt16 (secondBuf);
627     fs.writeFloat64 (calcTime);
628     kuint16 strlength = strlen (labelString);
629     fs.writeInt16 (strlength);
630     fs.write (labelString, strlength);
631   }
632   
633   return true;
634 }
635
636 void
637 Array2dFile::labelAdd (const char* const lstr, double calc_time)
638 {
639   labelAdd (Array2dFileLabel::L_HISTORY, lstr, calc_time);
640 }
641
642
643 void
644 Array2dFile::labelAdd (int type, const char* const lstr, double calc_time)
645 {
646   Array2dFileLabel label (type, lstr, calc_time);
647   
648   labelAdd (label);
649 }
650
651
652 void
653 Array2dFile::labelAdd (const Array2dFileLabel& label)
654 {
655   Array2dFileLabel* pLabel = new Array2dFileLabel(label);
656   
657   m_labels.push_back (pLabel);
658 }
659
660 void
661 Array2dFile::labelsCopy (const Array2dFile& copyFile, const char* const pszId)
662 {
663   std::string id;
664   if (pszId)
665     id = pszId;
666   for (unsigned int i = 0; i < copyFile.getNumLabels(); i++) {
667     Array2dFileLabel l (copyFile.labelGet (i));
668     std::string lstr = l.getLabelString();
669     lstr = id + lstr;
670     l.setLabelString (lstr);
671     labelAdd (l);
672   }
673 }
674
675 void 
676 Array2dFile::arrayDataClear (void)
677 {
678   if (m_arrayData) {
679     int columnSize = m_ny * m_pixelSize;
680     for (unsigned int ix = 0; ix < m_nx; ix++)
681       memset (m_arrayData[ix], 0, columnSize);
682   }
683   if (m_imaginaryArrayData) {
684     int columnSize = m_ny * m_pixelSize;
685     for (unsigned int ix = 0; ix < m_nx; ix++)
686       memset (m_arrayData[ix], 0, columnSize);
687   }
688 }
689
690 void
691 Array2dFile::printLabels (std::ostream& os) const
692 {
693   for (constLabelIterator l = m_labels.begin(); l != m_labels.end(); l++) {
694     const Array2dFileLabel& label = **l;
695     
696     label.print (os);
697     os << std::endl;
698   }
699 }
700
701 void
702 Array2dFile::printLabelsBrief (std::ostream& os) const
703 {
704   for (constLabelIterator l = m_labels.begin(); l != m_labels.end(); l++) {
705     const Array2dFileLabel& label = **l;
706     
707     label.printBrief (os);
708   }
709 }
710
711 void
712 Array2dFile::printLabelsBrief (std::ostringstream& os) const
713 {
714   for (constLabelIterator l = m_labels.begin(); l != m_labels.end(); l++) {
715     const Array2dFileLabel& label = **l;
716     
717     label.printBrief (os);
718   }
719 }
720
721
722 const Array2dFileLabel&
723 Array2dFile::labelGet (int i) const
724 {
725   return *m_labels[i];
726 }