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-2000 Kevin Rosenberg
  11 **
  12 **  $Id: array2dfile.cpp,v 1.1 2000/06/26 21:15:24 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 #include <sstream>
  31
  32 using namespace std;
  33
  34
  35 ///////////////////////////////////////////////////////////////////////////
  36 // CLASS IMPLEMENTATION
  37 //
  38 //     Name: Array2dFileLabel
  39 //     Purpose: Labels for Array2dFiles
  40 ///////////////////////////////////////////////////////////////////////////
  41
  42 void
  43 Array2dFileLabel::init (void)
  44 {
  45     m_calcTime = 0;
  46     m_labelType = L_EMPTY;
  47     time_t t = time(0);
  48     tm* lt = localtime(&t);
  49     m_year = lt->tm_year + 1900;
  50     m_month = lt->tm_mon + 1;
  51     m_day = lt->tm_mday;
  52     m_hour = lt->tm_hour;
  53     m_minute = lt->tm_min;
  54     m_second = lt->tm_sec;
  55 }
  56
  57 Array2dFileLabel::Array2dFileLabel()
  58 {
  59     init();
  60 }
  61
  62 Array2dFileLabel::Array2dFileLabel(const char* const str, double ctime = 0.)
  63   : m_strLabel (str)
  64 {
  65     init();
  66
  67     m_labelType = L_USER;
  68     m_calcTime = ctime;
  69 }
  70
  71 Array2dFileLabel::Array2dFileLabel(const int type, const char* const str, double ctime = 0.)
  72   :  m_strLabel (str)
  73 {
  74     init();
  75
  76     m_labelType = type;
  77     m_calcTime = ctime;
  78 }
  79
  80 Array2dFileLabel::~Array2dFileLabel()
  81 {
  82 }
  83
  84 void
  85 Array2dFileLabel::setDateTime (int year, int month, int day, int hour, int minute, int second)
  86 {
  87   m_year = year;
  88   m_month = month;
  89   m_day = day;
  90   m_hour = hour;
  91   m_minute = minute;
  92   m_second = second;
  93 }
  94
  95 void
  96 Array2dFileLabel::getDateTime (int& year, int& month, int& day, int& hour, int& minute, int& second) const
  97 {
  98   year = m_year;
  99   month = m_month;
 100   day = m_day;
 101   hour = m_hour;
 102   minute = m_minute;
 103   second = m_second;
 104 }
 105
 106 const string&
 107 Array2dFileLabel::getDateString (void) const
 108 {
 109   ostringstream oss;
 110   oss <<  m_month <<"/"<< m_day <<"/"<< m_year << " " << m_hour <<":"<<  m_minute <<":"<< m_second;
 111   m_strDate = oss.str();
 112   return m_strDate;
 113 }
 114
 115
 116 ///////////////////////////////////////////////////////////////////////////
 117 // CLASS IMPLEMENTATION
 118 //
 119 //     Name: Array2dFile
 120 //     Purpose: Array2dFiles
 121 ///////////////////////////////////////////////////////////////////////////
 122
 123
 124 Array2dFile::Array2dFile (int x, int y, int pixelSize, int pixelFormat)
 125 {
 126     init();
 127     setArraySize (x, y, pixelSize, pixelFormat);
 128 }
 129
 130 Array2dFile::~Array2dFile (void)
 131 {
 132     freeArray ();
 133     for (labelIterator l = m_labels.begin(); l != m_labels.end(); l++)
 134         delete *l;
 135 }
 136
 137 Array2dFile::Array2dFile (void)
 138 {
 139     init();
 140 }
 141
 142 void
 143 Array2dFile::init (void)
 144 {
 145   m_pixelSize = 0;
 146   m_pixelFormat = PIXEL_INVALID;
 147   m_arrayData = NULL;
 148   m_nx = 0;
 149   m_ny = 0;
 150   m_headersize = 0;
 151   m_axisIncrementKnown = false;
 152   m_axisIncrementX = m_axisIncrementY = 0;
 153   m_axisExtentKnown = false;
 154   m_minX = m_maxX = m_minY = m_maxY = 0;
 155   m_offsetPV = 0;
 156   m_scalePV = 1;
 157 }
 158
 159
 160 void
 161 Array2dFile::setArraySize (int x, int y, int pixelSize, int pixelFormat)
 162 {
 163     m_nx = x;
 164     m_ny = y;
 165     m_pixelSize = pixelSize;
 166     m_arraySize = m_nx * m_ny * m_pixelSize;
 167     m_pixelFormat = pixelFormat;
 168     allocArray ();
 169 }
 170
 171 void
 172 Array2dFile::setArraySize (int x, int y)
 173 {
 174     m_nx = x;
 175     m_ny = y;
 176     allocArray ();
 177 }
 178
 179 void
 180 Array2dFile::allocArray (void)
 181 {
 182     if (m_arrayData)
 183         freeArray();
 184
 185     m_arraySize = m_nx * m_ny * m_pixelSize;
 186     m_arrayData = new unsigned char* [m_nx];
 187
 188     int columnBytes = m_ny * m_pixelSize;
 189     for (int i = 0; i < m_nx; i++)
 190         m_arrayData[i] = new unsigned char [columnBytes];
 191 }
 192
 193 void
 194 Array2dFile::freeArray (void)
 195 {
 196     if (m_arrayData) {
 197         for (int i = 0; i < m_nx; i++)
 198             delete m_arrayData[i];
 199         delete m_arrayData;
 200         m_arrayData = NULL;
 201     }
 202 }
 203
 204 bool
 205 Array2dFile::fileWrite (const char* const filename)
 206 {
 207     m_filename = filename;
 208
 209     frnetorderstream fs (m_filename.c_str(), ios::out | ios::in | ios::trunc | ios::binary);
 210     if (fs.fail()) {
 211         sys_error (ERR_WARNING, "Error opening file %s for writing [fileCreate]", m_filename.c_str());
 212       return false;
 213     }
 214     if (! headerWrite(fs))
 215         return false;
 216
 217     if (! arrayDataWrite (fs))
 218         return false;
 219
 220     if (! labelsWrite (fs))
 221         return false;
 222
 223     return true;
 224 }
 225
 226 bool
 227 Array2dFile::fileRead (const char* const filename)
 228 {
 229     m_filename = filename;
 230
 231     frnetorderstream fs (m_filename.c_str(), ios::out | ios::in | ios::binary | ios::nocreate);
 232     if (fs.fail()) {
 233       sys_error (ERR_WARNING, "Unable to open file %s [fileRead]", m_filename.c_str());
 234       return false;
 235     }
 236
 237     if (! headerRead(fs))
 238       return false;
 239
 240     allocArray ();
 241
 242     if (! arrayDataRead(fs))
 243       return false;;
 244
 245     if (! labelsRead (fs))
 246       return false;
 247
 248     return true;
 249 }
 250
 251 void
 252 Array2dFile::setAxisIncrement (double incX, double incY)
 253 {
 254   m_axisIncrementKnown = true;
 255   m_axisIncrementX = incX;
 256   m_axisIncrementY = incY;
 257 }
 258
 259 void
 260 Array2dFile::setAxisExtent (double minX, double maxX, double minY, double maxY)
 261 {
 262     m_axisExtentKnown = true;
 263     m_minX = minX;
 264     m_maxY = maxX;
 265     m_minX = minX;
 266     m_maxY = maxY;
 267 }
 268
 269 bool
 270 Array2dFile::headerRead (frnetorderstream& fs)
 271 {
 272   if (! fs) {
 273     sys_error (ERR_WARNING, "Tried to read header with file closed [headerRead]");
 274     return false;
 275   }
 276
 277   fs.seekg (0);
 278   kuint16 file_signature;
 279
 280   fs.readInt16 (m_headersize);
 281   fs.readInt16 (file_signature);
 282   fs.readInt16 (m_pixelFormat);
 283   fs.readInt16 (m_pixelSize);
 284   fs.readInt16 (m_numFileLabels);
 285   fs.readInt32 (m_nx);
 286   fs.readInt32 (m_ny);
 287   fs.readInt16 (m_axisIncrementKnown);
 288   fs.readFloat64 (m_axisIncrementX);
 289   fs.readFloat64 (m_axisIncrementY);
 290   fs.readInt16 (m_axisExtentKnown);
 291   fs.readFloat64 (m_minX);
 292   fs.readFloat64 (m_maxX);
 293   fs.readFloat64 (m_minY);
 294   fs.readFloat64 (m_maxY);
 295   fs.readFloat64 (m_offsetPV);
 296   fs.readFloat64 (m_scalePV);
 297
 298   int read_m_headersize = fs.tellg();
 299   if (read_m_headersize != m_headersize) {
 300     sys_error (ERR_WARNING, "Read m_headersize %d != file m_headersize %d", read_m_headersize, m_headersize);
 301     return false;
 302   }
 303   if (file_signature != m_signature) {
 304     sys_error (ERR_WARNING, "File signature %d != true signature %d", file_signature, m_signature);
 305     return false;
 306   }
 307
 308   return true;
 309 }
 310
 311
 312 bool
 313 Array2dFile::headerWrite (frnetorderstream& fs)
 314 {
 315   if (! fs) {
 316     sys_error (ERR_WARNING, "Tried to write header with ! fs");
 317     return false;
 318   }
 319
 320   m_numFileLabels = m_labels.size();
 321
 322   fs.seekp (0);
 323   fs.writeInt16 (m_headersize);
 324   fs.writeInt16 (m_signature);
 325   fs.writeInt16 (m_pixelFormat);
 326   fs.writeInt16 (m_pixelSize);
 327   fs.writeInt16 (m_numFileLabels);
 328   fs.writeInt32 (m_nx);
 329   fs.writeInt32 (m_ny);
 330   fs.writeInt16 (m_axisIncrementKnown);
 331   fs.writeFloat64 (m_axisIncrementX);
 332   fs.writeFloat64 (m_axisIncrementY);
 333   fs.writeInt16 (m_axisExtentKnown);
 334   fs.writeFloat64 (m_minX);
 335   fs.writeFloat64 (m_maxX);
 336   fs.writeFloat64 (m_minY);
 337   fs.writeFloat64 (m_maxY);
 338   fs.writeFloat64 (m_offsetPV);
 339   fs.writeFloat64 (m_scalePV);
 340
 341   m_headersize = fs.tellp();
 342   fs.seekp (0);
 343   fs.writeInt16 (m_headersize);
 344
 345   return true;
 346 }
 347
 348
 349 bool
 350 Array2dFile::arrayDataWrite (frnetorderstream& fs)
 351 {
 352   if (! fs) {
 353     sys_error (ERR_WARNING, "Tried to arrayDataWrite with !fs");
 354     return false;
 355   }
 356
 357   if (! m_arrayData)
 358       return false;
 359
 360   fs.seekp (m_headersize);
 361   int columnSize = m_ny * m_pixelSize;
 362   for (unsigned int ix = 0; ix < m_nx; ix++) {
 363       unsigned char* ptrColumn = m_arrayData[ix];
 364       if (NativeBigEndian()) {
 365           for (unsigned int iy = 0; iy < m_ny; iy++) {
 366               ConvertReverseNetworkOrder (ptrColumn, m_pixelSize);
 367               fs.write (ptrColumn, m_pixelSize);
 368               ptrColumn += m_pixelSize;
 369           }
 370       } else
 371           fs.write (ptrColumn, columnSize);
 372   }
 373
 374   return true;
 375 }
 376
 377
 378 bool
 379 Array2dFile::arrayDataRead (frnetorderstream& fs)
 380 {
 381   if (! fs) {
 382     sys_error (ERR_WARNING, "Tried to arrayDataRead with ! fs");
 383     return false;
 384   }
 385
 386   if (! m_arrayData)
 387       return false;
 388
 389   fs.seekg (m_headersize);
 390   int columnSize = m_ny * m_pixelSize;
 391   for (int ix = 0; ix < m_nx; ix++) {
 392       unsigned char* ptrColumn = m_arrayData[ix];
 393       if (NativeBigEndian()) {
 394           for (unsigned int iy = 0; iy < m_ny; iy++) {
 395               fs.read (ptrColumn, m_pixelSize);
 396               ConvertReverseNetworkOrder (ptrColumn, m_pixelSize);
 397               ptrColumn += m_pixelSize;
 398           }
 399       } else
 400           fs.read (ptrColumn, columnSize);
 401   }
 402
 403   return true;
 404 }
 405
 406 bool
 407 Array2dFile::labelsRead (frnetorderstream& fs)
 408 {
 409     off_t pos = m_headersize + m_arraySize;
 410     fs.seekg (pos);
 411     if (fs.fail())
 412         return false;
 413
 414     for (int i = 0; i < m_numFileLabels; i++) {
 415         kuint16 labelType, year, month, day, hour, minute, second;
 416         kfloat64 calcTime;
 417
 418         fs.readInt16 (labelType);
 419         fs.readInt16 (year);
 420         fs.readInt16 (month);
 421         fs.readInt16 (day);
 422         fs.readInt16 (hour);
 423         fs.readInt16 (minute);
 424         fs.readInt16 (second);
 425         fs.readFloat64 (calcTime);
 426
 427         kuint16 strLength;
 428         fs.readInt16 (strLength);
 429         char labelStr [strLength+1];
 430         fs.read (labelStr, strLength);
 431         labelStr[strLength] = 0;
 432
 433         Array2dFileLabel* pLabel = new Array2dFileLabel(labelType, labelStr, calcTime);
 434         pLabel->setDateTime (year, month, day, hour, minute, second);
 435         m_labels.push_back (pLabel);
 436     }
 437
 438     return true;
 439 }
 440
 441 bool
 442 Array2dFile::labelsWrite (frnetorderstream& fs)
 443 {
 444     off_t pos = m_headersize + m_arraySize;
 445     fs.seekp (pos);
 446
 447     for (constLabelIterator l = m_labels.begin(); l != m_labels.end(); l++) {
 448         const Array2dFileLabel& label = **l;
 449         kuint16 labelType = label.getLabelType();
 450         kfloat64 calcTime = label.getCalcTime();
 451         const char* const labelString = label.getLabelString().c_str();
 452         int year, month, day, hour, minute, second;
 453         kuint16 yearBuf, monthBuf, dayBuf, hourBuf, minuteBuf, secondBuf;
 454
 455         label.getDateTime (year, month, day, hour, minute, second);
 456         yearBuf = year; monthBuf = month; dayBuf = day;
 457         hourBuf = hour; minuteBuf = minute; secondBuf = second;
 458
 459         fs.writeInt16 (labelType);
 460         fs.writeInt16 (yearBuf);
 461         fs.writeInt16 (monthBuf);
 462         fs.writeInt16 (dayBuf);
 463         fs.writeInt16 (hourBuf);
 464         fs.writeInt16 (minuteBuf);
 465         fs.writeInt16 (secondBuf);
 466         fs.writeFloat64 (calcTime);
 467         kuint16 strlength = strlen (labelString);
 468         fs.writeInt16 (strlength);
 469         fs.write (labelString, strlength);
 470     }
 471
 472     return true;
 473 }
 474
 475 void
 476 Array2dFile::labelAdd (const char* const lstr, double calc_time=0.)
 477 {
 478   labelAdd (Array2dFileLabel::L_HISTORY, lstr, calc_time);
 479 }
 480
 481
 482 void
 483 Array2dFile::labelAdd (int type, const char* const lstr, double calc_time=0.)
 484 {
 485   Array2dFileLabel label (type, lstr, calc_time);
 486
 487   labelAdd (label);
 488 }
 489
 490
 491 void
 492 Array2dFile::labelAdd (const Array2dFileLabel& label)
 493 {
 494     Array2dFileLabel* pLabel = new Array2dFileLabel(label);
 495
 496     m_labels.push_back (pLabel);
 497 }
 498
 499 void
 500 Array2dFile::labelsCopy (Array2dFile& copyFile, const char* const idStr)
 501 {
 502     string id = idStr;
 503     for (int i = 0; i < copyFile.getNumLabels(); i++) {
 504       Array2dFileLabel l = copyFile.labelGet (i);
 505       string lstr = l.getLabelString();
 506       lstr = idStr + lstr;
 507       l.setLabelString (lstr);
 508       labelAdd (l);
 509     }
 510 }
 511
 512 void
 513 Array2dFile::arrayDataClear (void)
 514 {
 515     if (m_arrayData) {
 516         int columnSize = m_ny * m_pixelSize;
 517         for (int ix = 0; ix < m_nx; ix++)
 518             memset (m_arrayData[ix], 0, columnSize);
 519     }
 520 }
 521
 522 void
 523 Array2dFile::printLabels (ostream& os) const
 524 {
 525     int nlabels = getNumLabels();
 526
 527     for (constLabelIterator l = m_labels.begin(); l != m_labels.end(); l++) {
 528       const Array2dFileLabel& label = **l;
 529
 530       if (label.getLabelType() == Array2dFileLabel::L_HISTORY) {
 531         os << "History: " << endl;
 532         os << "  " << label.getLabelString() << endl;
 533         os << "  calc time = " << label.getCalcTime() << " secs" << endl;
 534         os << "  Timestamp = " << label.getDateString() << endl;
 535       } else if (label.getLabelType() == Array2dFileLabel::L_USER) {
 536         os << "Note: " <<  label.getLabelString() << endl;
 537             os << "  Timestamp = %s" << label.getDateString() << endl;
 538       }
 539         os << endl;
 540     }
 541 }
 542
 543
 544 const Array2dFileLabel&
 545 Array2dFile::labelGet (int i) const
 546 {
 547   return *m_labels[i];
 548 }