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