VdsPartDesc.h

Go to the documentation of this file.

// VdsPartDesc.h: Description of a visibility data set or part thereof
//
// Copyright (C) 2020 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
 
#ifndef LOFAR_LMWCOMMON_VDSPARTDESC_H
#define LOFAR_LMWCOMMON_VDSPARTDESC_H
 
#include "ParameterSet.h"
 
#include "blob/BlobOStream.h"
#include "blob/BlobIStream.h"
 
#include <string>
#include <vector>
#include <iosfwd>
 
namespace dp3 {
namespace common {
 
 
//
//
 
class VdsPartDesc {
 public:
  VdsPartDesc() : itsStartTime(0), itsEndTime(1), itsStepTime(1) {}
 
  explicit VdsPartDesc(const ParameterSet&);
 
  void setName(const std::string& name, const std::string& fileSys);
 
  void setFileName(const std::string& name) { itsFileName = name; }
 
  void setClusterDescName(const std::string& cdName) { itsCDescName = cdName; }
 
  void changeBaseName(const std::string& newBaseName);
 
  void setTimes(double startTime, double endTime, double stepTime,
                const std::vector<double>& starts = std::vector<double>(),
                const std::vector<double>& ends = std::vector<double>());
 
  void addBand(int nchan, double startFreq, double endFreq);
  void addBand(int nchan, const std::vector<double>& startFreq,
               const std::vector<double>& endFreq);
 
  void addParm(const std::string& key, const std::string& value) {
    return itsParms.add(key, value);
  }
 
  const ParameterSet& getParms() const { return itsParms; }
 
  void clearParms() { itsParms.clear(); }
 
  void write(std::ostream& os, const std::string& prefix) const;
 
  const std::string& getName() const { return itsName; }
  const std::string& getFileName() const { return itsFileName; }
  const std::string& getFileSys() const { return itsFileSys; }
  const std::string& getClusterDescName() const { return itsCDescName; }
  double getStartTime() const { return itsStartTime; }
  double getEndTime() const { return itsEndTime; }
  double getStepTime() const { return itsStepTime; }
  const std::vector<double>& getStartTimes() const { return itsStartTimes; }
  const std::vector<double>& getEndTimes() const { return itsEndTimes; }
  int getNBand() const { return itsNChan.size(); }
  const std::vector<int>& getNChan() const { return itsNChan; }
  const std::vector<double>& getStartFreqs() const { return itsStartFreqs; }
  const std::vector<double>& getEndFreqs() const { return itsEndFreqs; }
 
  blob::BlobOStream& toBlob(blob::BlobOStream&) const;
  blob::BlobIStream& fromBlob(blob::BlobIStream&);
 
 private:
  std::string itsName;       
  std::string itsFileName;   
  std::string itsFileSys;    
  std::string itsCDescName;  
  double itsStartTime;
  double itsEndTime;
  double itsStepTime;
  std::vector<double> itsStartTimes;
  std::vector<double> itsEndTimes;
  std::vector<int32_t> itsNChan;      
  std::vector<double> itsStartFreqs;  
  std::vector<double> itsEndFreqs;    
  ParameterSet itsParms;              
};
 
inline blob::BlobOStream& operator<<(blob::BlobOStream& bs,
                                     const VdsPartDesc& vpd) {
  return vpd.toBlob(bs);
}
inline blob::BlobIStream& operator>>(blob::BlobIStream& bs, VdsPartDesc& vpd) {
  return vpd.fromBlob(bs);
}
 
}  // namespace common
}  // namespace dp3
 
#endif