stir_ecat6.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000- 2011, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

    See STIR/LICENSE.txt for details
*/

#ifndef __stir_IO_stir_ecat6_H__
#define __stir_IO_stir_ecat6_H__

#include "stir/IO/stir_ecat_common.h"
#include "stir/IO/ecat6_types.h"
#include <string>
#include <stdio.h>
#include "stir/shared_ptr.h"

START_NAMESPACE_STIR

class Succeeded;
class NumericType;
class ByteOrder;
class Scanner;
class ExamInfo;
template <int num_dimensions, typename elemT>
class DiscretisedDensity;
template <typename elemT>
class VoxelsOnCartesianGrid;
template <typename elemT>
class Sinogram;
class ProjData;
class ProjDataInfo;

START_NAMESPACE_ECAT
START_NAMESPACE_ECAT6

bool is_ECAT6_file(const std::string& filename);
bool is_ECAT6_image_file(const std::string& filename);
bool is_ECAT6_emission_file(const std::string& filename);
bool is_ECAT6_attenuation_file(const std::string& filename);

/*
  \brief Convert image data
  \ingroup ECAT
  \param cti_fptr a FILE pointer to the ECAT6 file.
  \param mhead the ECAT6 main header. Note that this parameter will be used
         to get system and size info, not the main header in the file.
*/
VoxelsOnCartesianGrid<float>* ECAT6_to_VoxelsOnCartesianGrid(const int frame_num,
                                                             const int gate_num,
                                                             const int data_num,
                                                             const int bed_num,
                                                             FILE* cti_fptr,
                                                             const ECAT6_Main_header& mhead);
/*
  \brief Convert sinogram data
  \ingroup ECAT
  \param max_ring_diff if less than 0, the maximum is used (i.e. num_rings-1)
  \param arccorrected tells the function if the data is (assumed to be) arc-corrected. Note
         that the ECAT6 file format does not have any flag to indicate this.
  \param output_file_name filename for output. A .s extension will be added (for the
         binary file) if no extension is present.
  \param cti_fptr a FILE pointer to the ECAT6 file.
  \param mhead the ECAT6 main header. Note that this parameter will be used
         to get system and size info, not the main header in the file.
  \warning multiplies the data with the loss_correction_factor in the subheader.
*/
void ECAT6_to_PDFS(const int frame_num,
                   const int gate_num,
                   const int data_num,
                   const int bed_num,
                   int max_ring_diff,
                   bool arccorrected,
                   const std::string& output_file_name,
                   FILE* cti_fptr,
                   const ECAT6_Main_header& mhead);


Scanner* find_scanner_from_ECAT6_Main_header(const ECAT6_Main_header& mhead);


Succeeded DiscretisedDensity_to_ECAT6(DiscretisedDensity<3, float> const& density,
                                      std::string const& cti_name,
                                      std::string const& orig_name,
                                      const Scanner& scanner,
                                      const int frame_num = 1,
                                      const int gate_num = 1,
                                      const int data_num = 0,
                                      const int bed_num = 0);


Succeeded DiscretisedDensity_to_ECAT6(FILE* fptr,
                                      DiscretisedDensity<3, float> const& density,
                                      const ECAT6_Main_header& mhead,
                                      const int frame_num = 1,
                                      const int gate_num = 1,
                                      const int data_num = 0,
                                      const int bed_num = 0);


Succeeded ProjData_to_ECAT6(ProjData const& proj_data,
                            std::string const& cti_name,
                            std::string const& orig_name,
                            const int frame_num = 1,
                            const int gate_num = 1,
                            const int data_num = 0,
                            const int bed_num = 0,
                            const bool write_2D_sinograms = false);


Succeeded ProjData_to_ECAT6(FILE* fptr,
                            ProjData const& proj_data,
                            const ECAT6_Main_header& mhead,
                            const int frame_num = 1,
                            const int gate_num = 1,
                            const int data_num = 0,
                            const int bed_num = 0,
                            const bool write_2D_sinograms = false);


void make_ECAT6_Main_header(ECAT6_Main_header&, const Scanner&, const std::string& orig_name, ExamInfo const& exam_info);


void make_ECAT6_Main_header(ECAT6_Main_header& mhead,
                            Scanner const& scanner,
                            const std::string& orig_name,
                            DiscretisedDensity<3, float> const& density);


void make_ECAT6_Main_header(ECAT6_Main_header& mhead, const std::string& orig_name, ProjDataInfo const& proj_data_info);
END_NAMESPACE_ECAT
END_NAMESPACE_ECAT6
END_NAMESPACE_STIR
#endif