iDataFileCT.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 IDATAFILECT_HH
#define IDATAFILECT_HH 1

#include "gVariables.hh"
#include "vDataFile.hh"
#include "vScanner.hh"
#include "iEventHistoCT.hh"
#include "iEventListCT.hh"


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

  // -------------------------------------------------------------------
  // 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);
    void DescribeSpecific();

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

  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline uint16_t GetNbProjections()
           {return m_nbOfProjections;};
    inline FLTNB* GetAngles()
           {return mp_angles;};
    inline void SetEventKindFlagOn()
           {m_eventKindFlag = true;}
    inline void SetNbProjections(uint16_t a_nbProjections)
           {m_nbOfProjections = a_nbProjections;} 
    inline int GetDetectorRotDirection()
           {return m_detectorRotDirection;}
    inline void SetDetectorRotDirection(int a_direction)
           {m_detectorRotDirection = a_direction;}
    inline bool GetEventKindFlag()
           {return m_eventKindFlag;}
    inline bool GetScatCorrectionFlag()
           {return m_scatCorrectionFlag;}
    inline bool GetBlankCorrectionFlag()
           {return m_blankCorrectionFlag;}

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

  // -------------------------------------------------------------------
  // Data members
  private:
    bool m_eventKindFlag;             
    bool m_blankCorrectionFlag;       
    bool m_ignoreBlankCorrectionFlag; 
    bool m_scatCorrectionFlag;        
    bool m_ignoreScatCorrectionFlag;  
    uint16_t m_nbOfProjections;       
    FLTNB* mp_angles;                 
    int m_detectorRotDirection;       
};

#endif