vDataFile.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 VDATAFILE_HH
#define VDATAFILE_HH 1

#include "gVariables.hh"
#include "vEvent.hh"
#include "iEventPET.hh"
#include "iEventListPET.hh"
#include "iEventHistoPET.hh"
#include "iEventSPECT.hh"
#include "iEventCT.hh"
#include "iEventNorm.hh"
#include "sOutputManager.hh"
#include "sScannerManager.hh"
#include "oImageDimensionsAndQuantification.hh"
#include "oMemoryMapped.hh"

#define MODE_UNKNOWN -1

#define MODE_LIST 0

#define MODE_HISTOGRAM 1

#define MODE_NORMALIZATION 2

#define TYPE_UNKNOWN -1

#define TYPE_PET 0

#define TYPE_SPECT 1

#define TYPE_CT 2

#define SPEC_UNKNOWN -1

#define SPEC_EMISSION 0

#define SPEC_TRANSMISSION 1

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

  // -------------------------------------------------------------------
  // Public member functions
  public:
    int ReadInfoInHeader(bool a_affectQuantificationFlag = true);
    int SetParametersFrom(vDataFile* ap_DataFile);
    int CheckParameters();
    int InitializeMappedFile();
    virtual int ComputeSizeEvent() = 0;
    virtual int PrepareDataFile() = 0;
    int OpenFileForWriting(string a_suffix="");
    int CloseFile();
    virtual int WriteHeader() = 0;
    virtual int WriteEvent(vEvent* ap_Event, int a_th=0) = 0;
    vEvent* GetEvent(int64_t a_eventIndex, int a_th = 0);
    virtual vEvent* GetEventSpecific(char* ap_buffer, int a_th) = 0;
    void GetEventIndexStartAndStop(int64_t* ap_indexStart, int64_t* ap_indexStop, int a_subsetNum = 0, int a_NbSubsets = 1);
    int CheckConsistencyWithAnotherBedDataFile(vDataFile* ap_DataFile);
    void Describe();
    virtual void DescribeSpecific() = 0;

  // -------------------------------------------------------------------
  // Functions dedicated to analytical projections
  public:
    virtual int PROJ_InitFile() = 0;
    virtual int PROJ_GetScannerSpecificParameters() = 0;
    int PROJ_WriteData();
    int PROJ_DeleteTmpDataFile();
    vEvent* PROJ_GenerateEvent(int idx_elt1, int idx_elt2, int a_th);

  // -------------------------------------------------------------------
  // Public Get & Set FUNCTIONS
  public:
    inline int GetBedIndex()
           {return m_bedIndex;}
    inline int GetDataMode()
           {return m_dataMode;}
    string GetDataModeToString();
    inline int GetDataType()
           {return m_dataType;}
    string GetDataTypeToString();
    inline int GetDataSpec()
           {return m_dataSpec;}
    string GetDataSpecToString();
    int64_t GetSize()
         {return m_nbEvents;}
    int64_t GetEventSize() {return m_sizeEvent;}
    inline string GetHeaderDataFileName()
           {return m_headerFileName;};
    inline string GetDataFileName()
           {return m_dataFileName;};
    inline int64_t GetStartTime()
           {return m_startTimeInSec;};
    inline int64_t GetDuration()
           {return m_durationInSec;};
    inline FLTNB GetCalibrationFactor()
           {return m_calibrationFactor;}
    inline FLTNB* GetPOIResolution()
           {return mp_POIResolution;}
    inline bool* GetPOIDirectionFlag()
           {return mp_POIDirectionFlag;}
    inline bool GetPOIInfoFlag()
           {return m_POIInfoFlag;}
    inline bool GetIgnorePOIFlag()
           {return m_ignorePOIFlag;}
    virtual int GetMaxRingDiff();
    inline void SetDataMode(int a_dataMode)
           {m_dataMode = a_dataMode;}
    inline void SetDataType(int a_dataType)
           {m_dataType = a_dataType;}
    inline void SetBedIndex(int a_bedIndex)
           {m_bedIndex = a_bedIndex;}
    inline bool GetBedPositionFlag()
           {return m_bedPositionFlag;}
    inline FLTNB GetRelativeBedPosition()
           {return m_relativeBedPosition;}
    inline void SetVerbose(int a_verboseLevel)
           {m_verbose = a_verboseLevel;}
    inline int GetVerbose()
           {return m_verbose;}
    inline void SetImageDimensionsAndQuantification(oImageDimensionsAndQuantification* ap_ImageDimensionsAndQuantification)
           {mp_ID = ap_ImageDimensionsAndQuantification;}
    inline void SetPOIResolution(FLTNB ap_value[3])
           {for (int i=0 ; i<3 ; i++) mp_POIResolution[i] = ap_value[i];} 
    inline void SetIgnorePOIFlag(bool a_ignorePOIFlag)
           {m_ignorePOIFlag = a_ignorePOIFlag;}
    inline void SetHeaderDataFileName(const string& a_headerFileName)
           {m_headerFileName = a_headerFileName;}
    inline void SetBinaryDataFileName(const string& a_dataFileName)
           {m_dataFileName = a_dataFileName;}
    inline void SetCalibrationFactor(FLTNB a_value)
           {m_calibrationFactor = a_value;} 
    inline void SetNbEvents(int64_t a_value)
           {m_nbEvents = a_value;} 
    inline void SetStartTime(FLTNB a_value)
           {m_startTimeInSec = a_value;} 
    inline void SetDuration(FLTNB a_value)
           {m_durationInSec = a_value;}
    inline string GetScannerName()
           {return m_scannerName;}

    virtual int Shuffle( int64_t );

  // -------------------------------------------------------------------
  // Private member functions
  private:
    virtual int SetSpecificParametersFrom(vDataFile* ap_DataFile) = 0;
    virtual int CheckSpecificParameters() = 0;
    virtual int CheckFileSizeConsistency() = 0;
    virtual int ReadSpecificInfoInHeader(bool a_affectQuantificationFlag = true) = 0;
    virtual int CheckSpecificConsistencyWithAnotherDataFile(vDataFile* ap_DataFile) = 0;

  // -------------------------------------------------------------------
  // Data members
  protected:
    oImageDimensionsAndQuantification* mp_ID; 
    int m_verbose;                            
    // Variables related to the acquisition
    string m_headerFileName;                  
    string m_dataFileName;                    
    int64_t m_nbEvents;                       
    int m_dataMode;                           
    int m_dataType;                           
    int m_dataSpec;                           
    FLTNB m_startTimeInSec;                   
    FLTNB m_durationInSec;                    
    FLTNB m_calibrationFactor;                
    int m_bedIndex;                           
    FLTNB m_relativeBedPosition;              
    bool m_bedPositionFlag;                   
    string m_scannerName;                     
    // POI: Position Of Interaction
    bool m_POIInfoFlag;                       
    bool m_ignorePOIFlag;                     
    bool mp_POIDirectionFlag[3];              
    FLTNB mp_POIResolution[3];                
    // Members for I/O actions
    int64_t m_sizeEvent;                      
    fstream** m2p_dataFile;                   
    vEvent** m2p_BufferEvent;                 
    int64_t m_mpi1stEvent;                    
    int64_t m_mpiLastEvent;                   
    int64_t m_mpiNbEvents;                    
    oMemoryMapped* mp_MappedFile;             
    char* mp_mappedMemory;                    
};

#endif