LoadFITS.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2014 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//---------------------------------------------------
// Includes
//---------------------------------------------------
#include <map>
#include <sstream>
#include <string>
#include <vector>
 
#include "MantidAPI/IFileLoader.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidKernel/FileDescriptor.h"
 
namespace Mantid {
namespace DataHandling {
 
struct FITSInfo;
 
class MANTID_DATAHANDLING_DLL LoadFITS : public API::IFileLoader<Kernel::FileDescriptor> {
public:
  LoadFITS();
 
  const std::string name() const override { return "LoadFITS"; }
 
  const std::string summary() const override { return "Load FITS files into workspaces of type Workspace2D."; }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Load", "SaveFITS"}; }
 
  const std::string category() const override { return "DataHandling\\Imaging"; }
 
  int confidence(Kernel::FileDescriptor &descriptor) const override;
 
  bool loadMutipleAsOne() override { return true; }
 
private:
  void init() override;
  void exec() override;
 
  void loadHeader(const std::string &filePath, FITSInfo &header);
 
  void headerSanityCheck(const FITSInfo &hdr, const FITSInfo &hdrFirst);
 
  void doLoadFiles(const std::vector<std::string> &paths, const std::string &outWSName, bool loadAsRectImg, int binSize,
                   double noiseThresh);
 
  void parseHeader(FITSInfo &headerInfo);
 
  DataObjects::Workspace2D_sptr makeWorkspace(const FITSInfo &fileInfo, size_t &newFileNumber,
                                              std::vector<char> &buffer, API::MantidImage &imageY,
                                              API::MantidImage &imageE, const DataObjects::Workspace2D_sptr &parent,
                                              bool loadAsRectImg = false, int binSize = 1, double noiseThresh = false);
 
  void addAxesInfoAndLogs(const DataObjects::Workspace2D_sptr &ws, bool loadAsRectImg, const FITSInfo &fileInfo,
                          int binSize, double cmpp);
 
  // Reads the data from a single FITS file into a workspace (directly, fast)
  void readDataToWorkspace(const FITSInfo &fileInfo, double cmpp, const DataObjects::Workspace2D_sptr &ws,
                           std::vector<char> &buffer);
 
  // Reads the data from a single FITS file into image objects (Y and E) that
  // then can/will be copied into a workspace
  void readDataToImgs(const FITSInfo &fileInfo, API::MantidImage &imageY, API::MantidImage &imageE,
                      std::vector<char> &buffer);
 
  void readInBuffer(const FITSInfo &fileInfo, std::vector<char> &buffer, size_t len);
 
  void doFilterNoise(double thresh, API::MantidImage &imageY, API::MantidImage &imageE);
 
  void doRebin(size_t rebin, const API::MantidImage &imageY, const API::MantidImage &imageE,
               API::MantidImage &rebinnedY, API::MantidImage &rebinnedE);
 
  bool isInstrOtherThanIMAT(const FITSInfo &hdr);
 
  void setupDefaultKeywordNames();
 
  // Maps the header keys to specified values
  void mapHeaderKeys();
 
  size_t fetchNumber(const std::string &name);
 
  // Adds a number of leading 0's to another number up to the totalDigitCount.
  std::string padZeros(const size_t number, const size_t totalDigitCount);
 
  // Strings used to map header keys
  std::string m_headerScaleKey;
  std::string m_headerOffsetKey;
  std::string m_headerBitDepthKey;
  std::string m_headerRotationKey;
  std::string m_headerImageKeyKey;
  std::string m_headerNAxisNameKey;
  std::vector<std::string> m_headerAxisNameKeys;
  std::string m_mapFile;
 
  static const std::string g_defaultImgType;
 
  // names of extension headers
  std::string m_sampleRotation;
  std::string m_imageType;
 
  size_t m_pixelCount;
 
  // Number of digits for the fixed width appendix number added to
  // workspace names, i.e. 3=> workspace_001; 5 => workspace_00001
  static const size_t g_DIGIT_SIZE_APPEND = 6;
  static const int g_BASE_HEADER_SIZE = 2880;
 
  // TODO: in the next round of refactoring of LoadFITS, this should
  // become common between LoadFITS and the new SaveFITS
  // Names for several options that can be given in a "FITS" header
  // setup file
  static const std::string g_END_KEYNAME;
  static const std::string g_COMMENT_KEYNAME;
  static const std::string g_XTENSION_KEYNAME;
  static const std::string g_BIT_DEPTH_NAME;
  static const std::string g_AXIS_NAMES_NAME;
  static const std::string g_ROTATION_NAME;
  static const std::string g_IMAGE_KEY_NAME;
  static const std::string g_HEADER_MAP_NAME;
 
  // Bits per pixel
  // This must be consistent with how the BITPIX header entries are processed
  static const size_t g_maxBitDepth;
  // max. bytes per pixel, for buffers
  static const size_t g_maxBytesPP;
};
 
} // namespace DataHandling
} // namespace Mantid