InterfileHeaderSiemens.h

Go to the documentation of this file.

/*
    Copyright (C) 2020, 2021, 2023 University College London
    Copyright (C) 2018 STFC
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

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

#include "stir/ByteOrder.h"
#include "stir/NumericInfo.h"
#include "stir/IO/InterfileHeader.h"
#include "stir/ProjDataFromStream.h"
#include "stir/ExamInfo.h"

START_NAMESPACE_STIR

class ProjDataInfo;

class InterfileHeaderSiemens : public InterfileHeader
{
public:
  static const double double_value_not_set;

  InterfileHeaderSiemens();

  ~InterfileHeaderSiemens() override {}

protected:
  // Returns false if OK, true if not.
  bool post_processing() override;

  void ignore_Siemens_date_and_time_keys(const std::string& keyword);

private:
  // TODO the next few ones should be made static members
  // Lists of possible values for some keywords
  // ASCIIlist_type number_format_values;
  ASCIIlist_type byte_order_values;
  ASCIIlist_type patient_position_values;

  // Corresponding variables here

  // int number_format_index;
  int byte_order_index;
  int patient_position_index;

  void set_type_of_data();

protected:
  void read_scan_data_types();
};

#if 0 // probably not necessary

class InterfileImageHeader : public InterfileHeaderSiemens
{
 private:
  typedef InterfileHeaderSiemens base_type;

public:
  InterfileImageHeader();
  std::vector<double>   first_pixel_offsets;

protected:
  virtual void read_matrix_info();
  virtual bool post_processing();

};

#endif

class InterfileRawDataHeaderSiemens : public InterfileHeaderSiemens
{
public:
  InterfileRawDataHeaderSiemens();

protected:
  bool post_processing() override;
  // need this to be false for the listmode data
  bool is_arccorrected;

public:
  ProjDataFromStream::StorageOrder storage_order;
  std::vector<int> segment_sequence;
  std::vector<int> timing_poss_sequence;
  shared_ptr<ProjDataInfo> data_info_ptr;

private:
  void resize_segments_and_set();
  // void read_frames_info();

  // int find_storage_order();

protected:
  int axial_compression;
  int maximum_ring_difference;
  int tof_mash_factor;

  std::vector<int> segment_table;
  int num_segments;
  int num_rings;
  int num_views;
  int num_bins;
  int num_tof_bins;
};

class InterfilePDFSHeaderSiemens : public InterfileRawDataHeaderSiemens
{
public:
  InterfilePDFSHeaderSiemens();

protected:
  bool post_processing() override;

public:
  std::vector<std::string> applied_corrections;
  bool compression;

private:
  void resize_segments_and_set();

  int find_storage_order();

  int num_scan_data_types;
  std::vector<std::string> scan_data_types;
  void read_scan_data_types();
  int total_num_sinograms;
  std::string compression_as_string;

  int num_buckets;
  std::vector<int> bucket_singles_rates;
  void read_bucket_singles_rates();
};

class InterfileListmodeHeaderSiemens : public InterfileRawDataHeaderSiemens
{
public:
  InterfileListmodeHeaderSiemens();

protected:
  bool post_processing() override;

public:
  int get_axial_compression() const;
  int get_maximum_ring_difference() const;
  int get_num_views() const;
  int get_num_projections() const;

private:
  int find_storage_order();
};

class InterfileNormHeaderSiemens : public InterfileRawDataHeaderSiemens
{
public:
  InterfileNormHeaderSiemens();

protected:
  bool post_processing() override;

public:
  float calib_factor;
  float cross_calib_factor;
  int num_buckets;

private:
  int num_components;
  std::vector<std::vector<int>> number_of_dimensions;
  void read_num_components();
};

END_NAMESPACE_STIR

#endif // __stir_InterfileHeaderSiemens_H__