iDataFileSPECT.hh

Go to the documentation of this file.

/*
This file is part of CASToR.

    CASToR is free software: you can redistribute it and/or modify it under the
    terms of the GNU General Public License as published by the Free Software
    Foundation, either version 3 of the License, or (at your option) any later
    version.

    CASToR is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    details.

    You should have received a copy of the GNU General Public License along with
    CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.

Copyright 2017-2018 all CASToR contributors listed below:

    --> current contributors: Thibaut MERLIN, Simon STUTE, Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Mael MILLARDET
    --> past contributors: Valentin VIELZEUF

This is CASToR version 2.0.
*/

#ifndef IDATAFILESPECT_HH
#define IDATAFILESPECT_HH 1

#include "gVariables.hh"
#include "vDataFile.hh"
#include "vScanner.hh"
#include "iEventHistoSPECT.hh"
#include "iEventListSPECT.hh"

class iDataFileSPECT : public vDataFile
{
  // -------------------------------------------------------------------
  // Constructor & Destructor
  public:
    iDataFileSPECT();
    ~iDataFileSPECT();

  // -------------------------------------------------------------------
  // Public member functions
  public:
    int ReadSpecificInfoInHeader(bool a_affectQuantificationFlag);
    int WriteHeader();
    int ComputeSizeEvent();
    int PrepareDataFile();
    int WriteEvent(vEvent* ap_Event, int a_th=0);
    vEvent* GetEventSpecific(char* ap_buffer, int a_th);
    int InitAngles(FLTNB* ap_angles);
    int InitCorToDetectorDistance(FLTNB* ap_CORtoDetectorDistance);
    void DescribeSpecific();

  // -------------------------------------------------------------------
  // Public functions dedicated to the projection script
  public:
    int PROJ_InitFile();
    int PROJ_GetScannerSpecificParameters();

  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline uint16_t GetNbHeads()
           {return m_nbHeads;};
    inline uint16_t GetNbProjections()
           {return m_nbOfProjections;};
    inline FLTNB* GetAngles()
           {return mp_angles;};
    inline FLTNB* GetCORtoDetectorDistance()
           {return mp_CORtoDetectorDistance;};
    inline uint16_t GetNbBins(int axis)
           {return mp_nbOfBins[axis];};
    inline void SetEventKindFlagOn()
           {m_eventKindFlag = true;}
    inline void SetIsotope(string a_value)
           {m_isotope = a_value;} 
    inline string GetIsotope()
           {return m_isotope;}
    inline void SetNbBins(uint16_t a_binTrs, uint16_t a_binAxl)
           {mp_nbOfBins[0] = a_binTrs; mp_nbOfBins[1]=a_binAxl;} 
    inline void SetNbProjections(uint16_t a_nbProjections)
           {m_nbOfProjections = a_nbProjections;} 
    inline int GetHeadRotDirection()
           {return m_headRotDirection;}
    inline void SetHeadRotDirection(int a_direction)
           {m_headRotDirection = a_direction;}
    inline bool GetEventKindFlag()
           {return m_eventKindFlag;}
    inline bool GetScatCorrectionFlag()
           {return m_scatCorrectionFlag;}
    inline bool GetNormCorrectionFlag()
           {return m_normCorrectionFlag;}

  // -------------------------------------------------------------------
  // Private member functions
  private:
    int SetSpecificParametersFrom(vDataFile* ap_DataFile);
    int CheckSpecificParameters();
    int CheckFileSizeConsistency();
    int WriteHistoEvent(iEventHistoSPECT* ap_Event, int a_th);
    int WriteListEvent(iEventListSPECT* ap_Event, int a_th);
    int CheckSpecificConsistencyWithAnotherDataFile(vDataFile* ap_DataFile);

  // -------------------------------------------------------------------
  // Data members
  private:
    string m_isotope;                
    bool m_eventKindFlag;            
    bool m_normCorrectionFlag;       
    bool m_ignoreNormCorrectionFlag; 
    bool m_scatCorrectionFlag;       
    bool m_ignoreScatCorrectionFlag; 
    uint16_t mp_nbOfBins[2];         
    FLTNB m_acquisitionZoom;         
    uint16_t m_nbOfProjections;      
    FLTNB* mp_angles;                
    uint16_t m_nbHeads;              
    FLTNB* mp_CORtoDetectorDistance; 
    int m_headRotDirection;          
};

#endif