dataFile.hpp

Go to the documentation of this file.

// @copyright
// (c) Copyright ESO 2020
// All Rights Reserved
// ESO (eso.org) is an Intergovernmental Organization, and therefore special
// legal conditions apply.
//
// @file dataFile.hpp
// @brief Data file class, offers access to FITS file functions.
//
// This file is part of the DDT Image Handling Library and
// provides a class that offers access to FITS file functions.
//
// @author Christoph Bortlisz, CGI
// @since  2020/08/24
//
 
#ifndef DATAFILE_HPP
#define DATAFILE_HPP
 
#include <sys/stat.h>
 
#include <algorithm>
#include <boost/bind/bind.hpp>
#include <boost/signals2/signal.hpp>
#include <cctype>
 
#include "ddt/ddtLogger.hpp"
#include "ddt/imageError.hpp"
#include "ddt/imageIO.hpp"
 
namespace ddt {
 
typedef struct FitsExtension {
  int number_axis;
  int image_width;
 
  int image_height;
 
  std::string extension;
 
  std::string extensionName;
} FitsExtension;
 
class DataFile {
 public:
  DataFile();
 
  virtual ~DataFile();
 
  void set_logger(ddt::DdtLogger* logger);
 
  bool OpenFile(const std::string& filename, const int position = 0);
 
  cpl_vector* OpenAndLoadVector(const std::string& file_name,
                                const int position = 0);
 
  cpl_image* OpenAndLoadImage(const std::string& file_name,
                              const int position = 0);
 
  cpl_image* OpenAndLoadCube(const std::string& file_name,
                             const int plane_number = 0,
                             const int position = 0);
 
  cpl_vector* LoadVector();
 
  cpl_image* LoadImage(const int plane_number = 0);
 
  cpl_table* LoadBinaryTable(const int extension_number);
 
  cpl_propertylist* LoadPropertyList();
 
  cpl_wcs* LoadWCS();
 
  cpl_image* LoadImageExtensionsAsOne(const int plane_number = 0);
 
  int get_FilePosition() const;
 
  std::string get_FileName() const;
 
  int get_NumberAxis() const;
 
  int get_NumberPlanes() const;
 
  int get_NumberExtensions() const;
 
  int get_ImageWidth() const;
 
  int get_ImageHeight() const;
 
  bool get_IsVector() const;
 
  bool get_IsImage() const;
 
  bool get_IsCube() const;
 
  bool get_IsBintable() const;
 
  FitsExtension* get_FitsExtensionInfo(const int extension_number);
 
  FitsExtension get_PrimaryHDUInfo() const;
 
  std::vector<int> get_invalid_image_hdus() const;
 
 protected:
  ddt::DdtLogger* logger;
 
 private:
  void initialize();
 
  bool SetImageProperties();
 
  bool RetrieveImageProperties(const cpl_propertylist* const property_list);
 
  void RetrieveExtensionInfo();
 
  bool OpenFileExtension(const int position);
 
  bool OpenPrimaryHDU();
 
  std::string file_name;
 
  int file_position;
 
  int number_axis;
 
  int number_planes;
 
  int number_extensions;
 
  int image_width;
 
  int image_height;
 
  bool is_vector;
 
  bool is_image;
 
  bool is_cube;
 
  bool is_bintable;
 
  FitsExtension primaryHDU;
 
  std::vector<FitsExtension> extensions;
 
  std::vector<int> invalid_image_hdus;
};
 
}  // namespace ddt
 
#endif /* DATAFILE_HPP */