include/array2dfile.h

   1 /*****************************************************************************
   2 ** FILE IDENTIFICATION
   3 **
   4 **      Name:         array2dfile.h
   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.h,v 1.15 2001/01/02 05:34:57 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 ARRAY2DFILE_H
  29 #define ARRAY2DFILE_H
  30
  31 #ifndef MSVC
  32 #include <unistd.h>
  33 #endif
  34
  35 #include <sys/types.h>
  36 #include <cstring>
  37 #include <string>\r
  38 #include <iosfwd>
  39 #include <iomanip>\r
  40 #include <fstream>\r
  41 #include <iostream>\r
  42 #include <vector>
  43 #include "ctsupport.h"
  44 #include "fnetorderstream.h"
  45 #include "array2d.h"
  46
  47 class Array2dFileLabel
  48 {
  49 public:
  50     enum {
  51       L_EMPTY = 0,
  52       L_HISTORY = 1,
  53       L_USER = 2,
  54     };
  55
  56     Array2dFileLabel();
  57
  58     Array2dFileLabel(const char* const str, double ctime = 0.);
  59
  60     Array2dFileLabel(const int type, const char* const str, double ctime = 0.);
  61
  62     ~Array2dFileLabel();
  63
  64     const std::string& getLabelString (void) const
  65         { return m_strLabel; }
  66
  67     kfloat64 getCalcTime (void) const
  68         { return m_calcTime; }
  69
  70     void setCalcTime (kfloat64 calcTime)
  71         { m_calcTime = calcTime; }
  72
  73     void setLabelType (int labelType)
  74         { m_labelType = labelType; }
  75
  76     int getLabelType (void) const
  77         { return m_labelType; }
  78
  79         std::string& setLabelString (const char* const str)
  80         { m_strLabel = str; return (m_strLabel); }
  81
  82         std::string& setLabelString (const std::string& str)
  83         { m_strLabel = str; return (m_strLabel); }
  84
  85     void setDateTime (int year, int month, int day, int hour, int minute, int second);
  86
  87     void getDateTime (int& year, int& month, int& day, int& hour, int& minute, int& second) const;
  88
  89     const std::string& getDateString () const;
  90
  91     void print (std::ostream& os) const;
  92     void printBrief (std::ostream& os) const;\r
  93
  94     Array2dFileLabel (const Array2dFileLabel& rhs);
  95
  96     Array2dFileLabel& operator= (const Array2dFileLabel& rhs);
  97
  98 private:
  99     void init (void);
 100
 101     kuint16 m_labelType;
 102     kuint16 m_year;
 103     kuint16 m_month;
 104     kuint16 m_day;
 105     kuint16 m_hour;
 106     kuint16 m_minute;
 107     kuint16 m_second;
 108         std::string m_strLabel;
 109     kfloat64 m_calcTime;
 110
 111     mutable std::string m_strDate;
 112 };
 113
 114
 115 class Array2dFile
 116 {
 117 public:
 118   enum {
 119     PIXEL_INVALID = 0,
 120     PIXEL_INT8 = 1,
 121     PIXEL_UINT8 = 2,
 122     PIXEL_INT16 = 3,
 123     PIXEL_UINT16 = 4,
 124     PIXEL_INT32 = 5,
 125     PIXEL_UINT32 = 6,
 126     PIXEL_FLOAT32 = 7,
 127     PIXEL_FLOAT64 = 8,
 128   };
 129 \r
 130   enum {\r
 131     DATA_TYPE_INVALID = 0,\r
 132     DATA_TYPE_REAL,\r
 133     DATA_TYPE_COMPLEX,\r
 134   };\r
 135
 136   Array2dFile (int nx, int ny, int pixelSize, int pixelFormat = PIXEL_INVALID, int dataType = DATA_TYPE_REAL);
 137   Array2dFile (void);
 138   ~Array2dFile ();
 139
 140   void setArraySize (int nx, int ny, int pixelSize, int pixelFormat = PIXEL_INVALID, int dataType = DATA_TYPE_REAL);
 141
 142   void setArraySize (int nx, int ny);
 143
 144   unsigned int getNumLabels (void) const
 145       { return m_labels.size(); }
 146
 147   const Array2dFileLabel& labelGet (int label_num) const;
 148
 149   void labelAdd (const Array2dFileLabel& label);
 150
 151   void labelAdd (const char* const m_strLabel, double calc_time=0.);
 152
 153   void labelAdd (int type, const char* const m_strLabel, double calc_time=0.);
 154
 155   void labelsCopy (Array2dFile& file, const char* const idStr = NULL);
 156
 157   void setPixelFormat (int type)
 158       { m_pixelFormat = type; }
 159
 160   void setPixelSize (int size)
 161       { m_pixelSize = size; }
 162
 163   kuint32 nx (void) const
 164       { return m_nx; }
 165
 166   kuint32 ny (void) const
 167       { return m_ny; }
 168 \r
 169   bool isComplex() const\r
 170   { return m_dataType == DATA_TYPE_COMPLEX; }\r
 171 \r
 172   bool isReal() const\r
 173   { return m_dataType == DATA_TYPE_REAL; }\r
 174 \r
 175   int dataType () const\r
 176   { return static_cast<int>(m_dataType); }\r
 177 \r
 178   void setDataType (int dataType)\r
 179   { m_dataType = dataType; }\r
 180
 181   void setAxisIncrement (double axisIncX, double axisIncY);
 182
 183   bool reallocRealToComplex ();\r
 184 \r
 185   bool reallocComplexToReal ();\r
 186
 187   void getPixelValueRange (double& pvmin, double& pvmax) const;\r
 188   void setAxisExtent (double minX, double maxX, double minY, double maxY);
 189
 190   void doPixelOffsetScale (double offset, double scale);
 191
 192   void arrayDataClear (void);
 193
 194   bool fileRead (const char* const filename);
 195
 196   bool fileRead (const std::string& filename);
 197
 198   bool fileWrite (const char* const filename);
 199
 200   bool fileWrite (const std::string& filename);
 201
 202   const std::string& getFilename (void) const
 203       {  return m_filename; }
 204
 205   void printLabels (std::ostream& os) const;\r
 206   void printLabelsBrief (std::ostream& os) const;\r
 207 \r
 208   unsigned int nLabels() const\r
 209   { return m_labels.size(); }\r
 210
 211   typedef std::vector<Array2dFileLabel*>::iterator labelIterator;
 212   typedef std::vector<Array2dFileLabel*>::const_iterator constLabelIterator;
 213
 214  protected:
 215          typedef std::vector<Array2dFileLabel*> labelContainer;
 216
 217   static const kuint16 m_signature;
 218   kuint16 m_headersize;
 219   std::string  m_filename;
 220
 221   kuint16 m_pixelSize;
 222   kuint16 m_pixelFormat;
 223   kuint16 m_axisIncrementKnown;
 224   kfloat64 m_axisIncrementX, m_axisIncrementY;
 225   kuint16 m_axisExtentKnown;
 226   kfloat64 m_minX, m_maxX, m_minY, m_maxY;
 227   kfloat64 m_offsetPV, m_scalePV;
 228   kuint32 m_nx;
 229   kuint32 m_ny;
 230   kuint32 m_arraySize;
 231   labelContainer m_labels;
 232   kuint16 m_numFileLabels;\r
 233   kuint16 m_dataType;
 234   unsigned char** m_arrayData;
 235   unsigned char** m_imaginaryArrayData;\r
 236
 237 private:
 238   void init (void);
 239
 240   bool headerRead (frnetorderstream& fs);
 241
 242   bool headerWrite (frnetorderstream& fs);
 243
 244   bool arrayDataRead (frnetorderstream& fs);
 245
 246   bool arrayDataWrite (frnetorderstream& fs);
 247
 248   bool labelsRead (frnetorderstream& fs);
 249
 250   bool labelsWrite (frnetorderstream& fs);
 251
 252   bool labelSeek (int label_num);
 253
 254   void allocArrays ();
 255   void freeArrays ();
 256 \r
 257   void allocArray (unsigned char**& rppData);\r
 258   void freeArray (unsigned char**& rppData);\r
 259
 260   Array2dFile (const Array2dFile& rhs);        // copy constructor
 261   Array2dFile& operator= (const Array2dFile&); // assignment operator
 262
 263 };
 264
 265
 266
 267 #endif