LdacOutput.cpp

Go to the documentation of this file.

#include <sstream>

#include <AlexandriaKernel/memory_tools.h>

#include "SOURCEXTRACTORPLUSPLUS_VERSION.h"

#include "SEFramework/Image/ImageSource.h"
#include "SEImplementation/Configuration/DetectionImageConfig.h"
#include "SEImplementation/Output/LdacOutput.h"
#include "SEImplementation/Plugin/DetectionFrameInfo/DetectionFrameInfo.h"

#if BOOST_VERSION < 107300
#include <boost/io/detail/quoted_manip.hpp>
#else
#include <boost/io/quoted.hpp>
#endif

namespace SourceXtractor {

using Euclid::Configuration::ConfigManager;
using Euclid::make_unique;
using namespace Euclid::Table;

namespace {

template<typename T>
std::string generateHeader(const std::string& name, T value, const std::string& comment) {
  std::stringstream str;

  str << std::setw(8) << std::left << name << "= "
      << std::scientific << std::setw(20) << std::right << value
      << " / ";

  if (str.str().size() > 80) {
    throw Elements::Exception() << "Header cannot exceed 80 characters: \"" << str.str() << "\"";
  }

  size_t remaining = 80 - str.str().size();
  if (comment.size() < remaining) {
    str << comment << std::string(remaining - comment.size(), ' ');
  } else {
    // truncate comment if too long
    str << comment.substr(0, remaining);
  }

  return str.str();
}

template<>
std::string generateHeader<std::string>(const std::string& name, std::string value, const std::string& comment) {
  std::stringstream str, quoted_value;

  quoted_value << boost::io::quoted(value, '\'', '\'');

  str << std::setw(8) << std::left << name << "= "
      << std::setw(20) << std::left << quoted_value.str()
      << " / ";

  if (str.str().size() > 80) {
    throw Elements::Exception() << "Header cannot exceed 80 characters: \"" << str.str() << "\"";
  }

  size_t remaining = 80 - str.str().size();
  if (comment.size() < remaining) {
    str << comment << std::string(remaining - comment.size(), ' ');
  } else {
    // truncate comment if too long
    str << comment.substr(0, remaining);
  }

  return str.str();
}

static void generateHistory(std::vector<std::string>& headers) {
  std::vector<std::string> entries;
  std::stringstream str;

  str << "Version " << SOURCEXTRACTORPLUSPLUS_VERSION_STRING;
  entries.emplace_back(str.str());
  str.str("");

  auto t = std::time(nullptr);
  auto now = *std::gmtime(&t);

  char date_str[32];
  strftime(date_str, sizeof(date_str), "%Y-%m-%dT%H:%M:%SZ", &now);
  str << "Called at " << date_str;
  entries.emplace_back(str.str());
  str.str("");

  for (auto& e : entries) {
    std::stringstream padder;
    padder << "HISTORY s++: " << std::setw(67) << std::left << e;
    headers.emplace_back(padder.str());
  }
}

}

void LdacOutput::outputSource(const SourceInterface& source) {
  if (m_fits_writer == nullptr) {
    const auto& detection_frame_info = source.getProperty<DetectionFrameInfo>();
    m_rms = detection_frame_info.getBackgroundMedianRms();
    m_gain = detection_frame_info.getGain();

    // Headers from the image
    m_image_metadata = detection_frame_info.getMetadata();

    writeHeaders();

    m_fits_writer = std::make_shared<FitsWriter>(m_filename);


    if (m_part_nb >= 1) {
      std::stringstream hdu_name;
      hdu_name << "LDAC_OBJECTS_" << m_part_nb;
      m_fits_writer->setHduName(hdu_name.str());
    } else {
      m_fits_writer->setHduName("LDAC_OBJECTS");
    }
  }
  FlushableOutput::outputSource(source);
}

void LdacOutput::writeHeaders() {
  auto imhead_writer = Euclid::make_unique<FitsWriter>(m_filename, m_part_nb == 0);
  if (m_part_nb >= 1) {
    std::stringstream hdu_name;
    hdu_name << "LDAC_IMHEAD_" << m_part_nb;
    imhead_writer->setHduName(hdu_name.str());
  } else {
    imhead_writer->setHduName("LDAC_IMHEAD");
  }

  // Headers from the image
  std::vector<std::string> ldac_imhead;
  for (const auto &p : m_image_metadata) {
    std::string comment;
    if (p.second.m_extra.count("comment")) {
      comment = p.second.m_extra.at("comment");
    }
    if (p.second.m_value.type() == typeid(std::string)) {
      ldac_imhead.emplace_back(generateHeader(p.first, boost::get<std::string>(p.second.m_value), comment));
    } else {
      ldac_imhead.emplace_back(generateHeader(p.first, p.second.m_value, comment));
    }
  }

  // Headers from the configuration and detection
  ldac_imhead.emplace_back(generateHeader("SPPGAIN", m_gain, "Gain used"));
  ldac_imhead.emplace_back(generateHeader("SPPBKDEV", m_rms, "Median background RMS"));

  // History, why not
  generateHistory(ldac_imhead);

  // END
  ldac_imhead.emplace_back("END" + std::string(77, ' '));

  // Join everything as a single string
  std::string header = std::accumulate(ldac_imhead.begin(), ldac_imhead.end(), std::string());

  // Write the table
  auto column_info = std::make_shared<ColumnInfo>(std::vector<ColumnInfo::info_type>{{"Field Header Card", typeid(std::string)}});
  std::vector<Row> rows{{std::vector<Row::cell_type>{header}, column_info}};
  imhead_writer->addData(Table{std::move(rows)});
}

void LdacOutput::nextPart() {
  m_part_nb++;
  // closes current HDU and will trigger a new header HDU when the next source is written
  m_fits_writer = nullptr;
}

}  // end of namespace SourceXtractor