lfiio.cpp

/***************************************************************************
 *                                                                         *
 *   copyright : (C) 2007 The University of Toronto                        *
 *                   netterfield@astro.utoronto.ca                         *
 *   copyright : (C) 2005  University of British Columbia                  *
 *                   dscott@phas.ubc.ca                                    *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#include "lfiio.h"

#include <QXmlStreamWriter>
//#include <fitsio.h>
#include <math.h>

#define TIME_FIELD  "TIME"

#include "kst_i18n.h"

static const QString lfiioTypeString = I18N_NOOP("LFIIO image");

class LFIIOSource::Config {
  public:
    Config() {
    }

    void read(QSettings *cfg, const QString& fileName = QString::null) {
      Q_UNUSED(fileName);
      cfg->beginGroup(lfiioTypeString);
      cfg->endGroup();
    }

    void save(QXmlStreamWriter& s) {
      Q_UNUSED(s);
    }

    void load(const QDomElement& e) {
      Q_UNUSED(e);
    }
};


LFIIOSource::LFIIOSource(Kst::ObjectStore *store, QSettings *cfg, const QString& filename, const QString& type, const QDomElement& e)
: Kst::DataSource(store, cfg, filename, type, None), _config(0L) {

  _first = true;
  _valid = false;

  if (!type.isEmpty() && type != "LFIIO Image Source") {
    return;
  }

  _config = new LFIIOSource::Config;
  _config->read(cfg, filename);
  if (!e.isNull()) {
    _config->load(e);
  }

  if (init()) {
    _valid = true;
  }

  update();
}



LFIIOSource::~LFIIOSource() {
}


bool LFIIOSource::reset() {
  init();
  return true;
}


bool LFIIOSource::init() {
  Kst::Object::UpdateType updateType;
  bool                  bRetVal = false;
  int                   iResult = 0;

  _numFrames = 0;

  // read the metadata
  if (!_filename.isNull() && !_filename.isEmpty()) {
    QString   str;
    fitsfile* ffits;
    int       iStatus = 0;

    if (_first) {
      iResult = fits_open_table( &ffits, _filename.ascii(), READONLY, &iStatus );
      if (iResult == 0) {
        int keysexist;
        int morekeys;

        iResult = fits_get_hdrspace( ffits, &keysexist, &morekeys, &iStatus );
        if (iResult == 0) {
          char  keyname[FLEN_KEYWORD];
          char  value[FLEN_VALUE];
          char  comment[FLEN_COMMENT];
          int   keynum;

          for (keynum = 1; keynum <= keysexist; ++keynum) {
            iResult = fits_read_keyn( ffits, keynum, keyname, value, comment, &iStatus );
            if (iResult == 0) {
              str.sprintf("%s %s", value, comment);
              _metaData.insert(keyname, str);
            }
          }

          _first = false;
        }
      }
    }
  }

  updateType = update();
  if(updateType == Kst::Object::UPDATE) {
    bRetVal = true;
  }

  return bRetVal;
}


Kst::Object::UpdateType LFIIOSource::update() {

  Kst::Object::UpdateType updateType = Kst::Object::NO_CHANGE;
  QString               strTemplate;
  QString               strName;
  fitsfile*             ffits;
  char                  charTemplate[FLEN_CARD];
  char                  charName[FLEN_CARD];
  long                  lNumFrames;
  long                  lMaxRepeat = 1;
  long                  lRepeat;
  long                  lWidth;
  int                   iColNumber;
  int                   iNumCols;
  int                   iStatus = 0;
  int                   iResult = 0;
  int                   iTypeCode;
  int                   i;
  int                   newNF = 0;

  _valid  = false;

  if(!_filename.isNull() && !_filename.isEmpty()) {
    iResult = fits_open_table( &ffits, _filename.ascii(), READONLY, &iStatus );
    if(iResult == 0) {
      // determine size of data...
      iResult = fits_get_num_cols( ffits, &iNumCols, &iStatus );
      if(iResult == 0) {
        iResult = fits_get_num_rows( ffits, &lNumFrames, &iStatus );
        if(iResult == 0) {
          _fieldList.clear();
          _fieldList.append("INDEX");

          _valid = true;
          _bHasTime = false;

          // need to multiply lNumFrames by the maximum value of the vector repeat value...
          for(i = 0; i<iNumCols; i++) {
            iStatus = 0;

            sprintf(charTemplate, "%d", i+1);
            iResult = fits_get_colname( ffits, CASEINSEN, charTemplate, charName, &iColNumber, &iStatus );
            if(iResult == 0) {
              int iOffset = i;
              strName = charName;

              // ensure that we don't add duplicates to the _fieldList...
              while(_fieldList.findIndex(strName) != -1) {
                strName = QString("%1[%2]").arg(charName).arg(iOffset);
                iOffset++;
              }
            } else {
              strName.setNum(i);
            }

            _fieldList.append(strName);

            iStatus = 0;
            iResult = fits_get_coltype( ffits, i+1, &iTypeCode, &lRepeat, &lWidth, &iStatus );
            if(iResult == 0) {
              if(lRepeat > lMaxRepeat) {
                lMaxRepeat = lRepeat;
              }
            }
          }

          // check if we have a time field defined by the header keys TIMEZERO and DELTA_T.
          //  If so then we create a new field called $TIME_FIELD, unless such a field already
          //  exists, in which case we do nothing...
          char charTimeZero[] = "TIMEZERO";

          iStatus = 0;
          iResult = fits_read_key( ffits, TDOUBLE, charTimeZero, &_dTimeZero, 0L, &iStatus );
          if(iResult == 0) {
            char charTimeDelta[] = "DELTA_T";

            iResult = fits_read_key( ffits, TDOUBLE, charTimeDelta, &_dTimeDelta, 0L, &iStatus );
            if(iResult == 0) {
              if(_fieldList.find(QString(TIME_FIELD)) == _fieldList.end()) {
                _bHasTime = true;
                _fieldList.append(TIME_FIELD);
              }
            }
          }

          if(lNumFrames * lMaxRepeat != _numFrames) {
            _numCols   = iNumCols;
            newNF = lNumFrames * lMaxRepeat;
            updateType = Kst::Object::UPDATE;
          }
        }
      }
      iStatus = 0;
      fits_close_file( ffits, &iStatus );
    }
  }

  bool isnew = newNF != _numFrames;

  _numFrames = newNF;

  return (isnew ? Kst::Object::UPDATE : Kst::Object::NO_CHANGE);
}


int LFIIOSource::readField(double *v, const QString& field, int s, int n) {
  double    dNan = strtod("nan", NULL);
  fitsfile* ffits;
  bool      bOk;
  int       i;
  int       iCol;
  int       iRead = -1;
  int       iStatus = 0;
  int       iAnyNull;
  int       iResult = 0;

  if (n < 0) {
    n = 1; /* n < 0 means read one sample, not frame - irrelavent here */
  }

  if (field == "INDEX") {
    for(i = 0; i < n; i++) {
      v[i] = (double)(s + i) ;
    }
    iRead =  n;
  } else if (_bHasTime && field == TIME_FIELD) {
    for(i = 0; i < n; i++) {
      v[i] = _dTimeZero + ((double)(s + i) * _dTimeDelta);
    }
    iRead =  n;
  } else {
    memset(v, 0, n * sizeof(double));

    bOk = getColNumber(field, &iCol);
    if (bOk) {
      _valid = false;

      if (!_filename.isNull() && !_filename.isEmpty()) {
        iResult = fits_open_table( &ffits, _filename.ascii(), READONLY, &iStatus );
        if (iResult == 0) {
          _valid = true;

          // copy the data...
          // N.B. fitsio column indices are 1 based, so we ask for iCol+1 instead of just iCol
          iResult = fits_read_col( ffits, TDOUBLE, iCol+1, s+1, 1, n, &dNan, v, &iAnyNull, &iStatus );
          if (iResult == 0) {
            iRead = n;
          }

          iStatus = 0;
          fits_close_file( ffits, &iStatus );
        }
      }
    }
  }

  return iRead;
}


bool LFIIOSource::getColNumber( const QString& field, int* piColNumber ) const {
  QString strName;
  bool    bOk     = false;
  bool    bRetVal = false;
  int     iCount;
  int     iCol;
  int     i;

  iCol = field.toUInt(&bOk);
  if (bOk) {
    if (iCol >= 0 && iCol < _numCols) {
      *piColNumber = iCol;

      bRetVal = true;
    }
  } else {
    iCount = _fieldList.count();

    // start at 1, because the first entry is INDEX...
    for (i=1; i<iCount; i++) {
      strName = _fieldList[i].lower();
      if (strName.compare(field.lower()) == 0) {
        bRetVal = true;

        // subtract 1 to be consistent with the value returned from the previous branch...
        *piColNumber = i-1;

        break;
      }
    }
  }

  return bRetVal;
}


bool LFIIOSource::isValidField(const QString& field) const {
  bool bRetVal = false;
  int  iCol;

  if (field == "INDEX") {
    bRetVal = true;
  } else if (field == TIME_FIELD && _bHasTime) {
    bRetVal = true;
  } else {
    bRetVal = getColNumber(field, &iCol);
  }

  return bRetVal;
}


int LFIIOSource::samplesPerFrame(const QString &field) {
  Q_UNUSED(field)
  return 1;
}


int LFIIOSource::frameCount(const QString& field) const {
  Q_UNUSED(field)
  return _numFrames;
}


bool LFIIOSource::isEmpty() const {
  return _numFrames < 1;
}


QString LFIIOSource::fileType() const {
  return lfiioTypeString;
}


void LFIIOSource::save(QXmlStreamWriter &streamWriter) {
  Kst::DataSource::save(streamWriter);
}


int LFIIOSource::readScalar(double &S, const QString& scalar) {
  if (scalar == "FRAMES") {
    S = _numFrames;
    return 1;
  }
  return 0;
}


int LFIIOSource::readString(QString &S, const QString& string) {
  if (string == "FILE") {
    S = _filename;
    return 1;
  } else if (_metaData.contains(string)) {
    S = _metaData[string];
    return 1;
  }
  return 0;
}


QString LFIIOPlugin::pluginName() const { return "LFIIO Image Source Reader"; }
QString LFIIOPlugin::pluginDescription() const { return "LFIIO Image Source Reader"; }


Kst::DataSource *LFIIOPlugin::create(Kst::ObjectStore *store,
                                            QSettings *cfg,
                                            const QString &filename,
                                            const QString &type,
                                            const QDomElement &element) const {

  return new LFIIOSource(store, cfg, filename, type, element);
}



QStringList LFIIOPlugin::matrixList(QSettings *cfg,
                                             const QString& filename,
                                             const QString& type,
                                             QString *typeSuggestion,
                                             bool *complete) const {
  if (typeSuggestion) {
    *typeSuggestion = lfiioTypeString;
  }
  if ((!type.isEmpty() && !provides().contains(type)) ||
      0 == understands(cfg, filename)) {
    if (complete) {
      *complete = false;
    }
    return QStringList();
  }
  return QStringList();

}


QStringList LFIIOPlugin::scalarList(QSettings *cfg,
                                            const QString& filename,
                                            const QString& type,
                                            QString *typeSuggestion,
                                            bool *complete) const {

  QStringList scalarList;

  if ((!type.isEmpty() && !provides().contains(type)) || 0 == understands(cfg, filename)) {
    if (complete) {
      *complete = false;
    }
    return QStringList();
  }

  if (typeSuggestion) {
    *typeSuggestion = lfiioTypeString;
  }

  scalarList.append("FRAMES");
  return scalarList;

}


QStringList LFIIOPlugin::stringList(QSettings *cfg,
                                      const QString& filename,
                                      const QString& type,
                                      QString *typeSuggestion,
                                      bool *complete) const {

  QStringList stringList;

  if ((!type.isEmpty() && !provides().contains(type)) || 0 == understands(cfg, filename)) {
    if (complete) {
      *complete = false;
    }
    return QStringList();
  }

  if (typeSuggestion) {
    *typeSuggestion = lfiioTypeString;
  }

  stringList.append("FILENAME");

  QString   str;
  fitsfile* ffits;
  int       iStatus = 0;
  int       iResult = 0;

  iResult = fits_open_table(&ffits, filename.ascii(), READONLY, &iStatus);
  if (iResult == 0) {
    int keysexist;
    int morekeys;

    iResult = fits_get_hdrspace( ffits, &keysexist, &morekeys, &iStatus );
    if (iResult == 0) {
      char  keyname[FLEN_KEYWORD];
      char  value[FLEN_VALUE];
      char  comment[FLEN_COMMENT];
      int   keynum;

      for (keynum=1; keynum <= keysexist; ++keynum) {
        iResult = fits_read_keyn( ffits, keynum, keyname, value, comment, &iStatus );
        if (iResult == 0) {
          stringList.append(keyname);
        }
      }
    }
  }

  return stringList;
}


QStringList LFIIOPlugin::fieldList(QSettings *cfg,
                                            const QString& filename,
                                            const QString& type,
                                            QString *typeSuggestion,
                                            bool *complete) const {
  Q_UNUSED(type)
  QStringList fieldList;
  bool valid = true;
  bool hasTime = false;

  if (complete) {
    *complete = true;
  }

  if (typeSuggestion) {
    *typeSuggestion = lfiioTypeString;
  }
  if (understands(cfg, filename)) {
    QString               strName;
    fitsfile*             ffits;
    int                   iStatus = 0;
    int                   iNumCols;
    long                  lNumFrames;
    int                   i;
    char                  charTemplate[ FLEN_CARD ];
    char                  charName[ FLEN_CARD ];
    long                  lMaxRepeat = 1;
    long                  lRepeat;
    long                  lWidth;
    int                   iColNumber;
    int                   iResult = 0;
    int                   iTypeCode;

    iResult = fits_open_table( &ffits, filename.ascii(), READONLY, &iStatus );
    if (iResult == 0) {
      //
      // determine size of data...
      //
      iResult = fits_get_num_cols( ffits, &iNumCols, &iStatus );
      if (iResult == 0) {
        iResult = fits_get_num_rows( ffits, &lNumFrames, &iStatus );
        if (iResult == 0) {
          fieldList.append("INDEX");
          valid = true;
          hasTime = false;

          // need to multiply lNumFrames by the maximum value of the vector repeat value...
          for (i=0; i<iNumCols; i++) {
            iStatus = 0;

            sprintf(charTemplate, "%d", i+1);
            iResult = fits_get_colname( ffits, CASEINSEN, charTemplate, charName, &iColNumber, &iStatus );
            if (iResult == 0) {
              int iOffset = i;

              strName = charName;
              // ensure that we don't add duplicates to the _fieldList...
              while(fieldList.findIndex( strName ) != -1) {
                strName = QString("%1[%2]").arg(charName).arg(iOffset);
                iOffset++;
              }
            } else {
              strName.setNum(i);
            }
            fieldList.append(strName);

            iStatus = 0;
            iResult = fits_get_coltype( ffits, i+1, &iTypeCode, &lRepeat, &lWidth, &iStatus );
            if (iResult == 0) {
              if (lRepeat > lMaxRepeat) {
                lMaxRepeat = lRepeat;
              }
            }
          }

          //  Check if we have a time field defined by the header keys TIMEZERO and DELTA_T.
          //  If so then we create a new field called $TIME_FIELD, unless such a field already
          //  exists, in which case we do nothing...
          char charTimeZero[] = "TIMEZERO";
          double timeZero;
          double timeDelta;

          iStatus = 0;
          iResult = fits_read_key( ffits, TDOUBLE, charTimeZero, &timeZero, 0L, &iStatus );
          if (iResult == 0) {
            char charTimeDelta[] = "DELTA_T";

            iResult = fits_read_key( ffits, TDOUBLE, charTimeDelta, &timeDelta, 0L, &iStatus );
            if (iResult == 0) {
              if (fieldList.find(QString(TIME_FIELD)) == fieldList.end()) {
                hasTime = true;
                fieldList.append(TIME_FIELD);
              }
            }
          }
        }
      }
      iStatus = 0;
      fits_close_file( ffits, &iStatus );
    }
  }

  return fieldList;
}


int LFIIOPlugin::understands(QSettings *cfg, const QString& filename) const {
  Q_UNUSED(cfg)
  fitsfile* ffits;
  int       iStatus = 0;
  int       iRetVal = 0;

  // determine if it is a FITS file...
  if (fits_open_table( &ffits, filename.ascii(), READONLY, &iStatus ) == 0 ) {
    fits_close_file( ffits, &iStatus );
    iRetVal = 90;
  }

  return iRetVal;
}



bool LFIIOPlugin::supportsTime(QSettings *cfg, const QString& filename) const {
  //FIXME
  Q_UNUSED(cfg)
  Q_UNUSED(filename)
  return true;
}


QStringList LFIIOPlugin::provides() const {
  QStringList rc;
  rc += "LFIIO Image Source";
  return rc;
}


Kst::DataSourceConfigWidget *LFIIOPlugin::configWidget(QSettings *cfg, const QString& filename) const {

  Q_UNUSED(cfg)
  Q_UNUSED(filename)
  return 0;;

}

Q_EXPORT_PLUGIN2(kstdata_qimagesource, LFIIOPlugin)


// vim: ts=2 sw=2 et