OutputFileFormat.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2003- 2007, Hammersmith Imanet Ltd
    This file is part of STIR.
    SPDX-License-Identifier: Apache-2.0


    See STIR/LICENSE.txt for details
*/
#ifndef __stir_IO_OutputFileFormat_H__
#define __stir_IO_OutputFileFormat_H__

#include "stir/RegisteredObject.h"
#include "stir/NumericType.h"
#include "stir/ByteOrder.h"
#include <string>

START_NAMESPACE_STIR

class Succeeded;

template <typename DataT>
class OutputFileFormat : public RegisteredObject<OutputFileFormat<DataT>>
{
public:
  static shared_ptr<OutputFileFormat<DataT>> default_sptr();

  OutputFileFormat(const NumericType& = NumericType::FLOAT, const ByteOrder& = ByteOrder::native);


  Succeeded write_to_file(std::string& filename, const DataT& data) const;


  Succeeded write_to_file(const std::string& filename, const DataT& density) const;

  NumericType get_type_of_numbers() const;
  ByteOrder get_byte_order();

  float get_scale_to_write_data() const;


  virtual NumericType set_type_of_numbers(const NumericType&, const bool warn = false);

  virtual ByteOrder set_byte_order(const ByteOrder&, const bool warn = false);

  virtual void set_byte_order_and_type_of_numbers(ByteOrder&, NumericType&, const bool warn = false);


  virtual float set_scale_to_write_data(const float new_scale_to_write_data, const bool warn = false);

protected:
  NumericType type_of_numbers;
  ByteOrder file_byte_order;

  float scale_to_write_data;


  virtual Succeeded actual_write_to_file(std::string& filename, const DataT& density) const = 0;

  // parsing stuff


  void set_defaults() override;

  void initialise_keymap() override;

  bool post_processing() override;

  void set_key_values() override;

private:
  static shared_ptr<OutputFileFormat<DataT>> _default_sptr;
  // Lists of possible values for some keywords
  static ASCIIlist_type number_format_values;
  static ASCIIlist_type byte_order_values;

  // Corresponding variables here

  int number_format_index;
  int byte_order_index;
  int bytes_per_pixel;
};

END_NAMESPACE_STIR

#endif