sScannerManager.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-2019 all CASToR contributors listed below:

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

This is CASToR version 3.0.
*/

#ifndef SSCANNERMANAGER_HH
#define SSCANNERMANAGER_HH 1

#include "gVariables.hh"
#include "gOptions.hh"
#include "sOutputManager.hh"
#ifdef _WIN32
#include "oDirentWin32.hh"
#else
#include "dirent.h"
#endif
#include "vScanner.hh"

#define SCANNER_UNKNOWN -1

#define SCANNER_PET 0

#define SCANNER_SPECT_PINHOLE 1

#define SCANNER_SPECT_CONVERGENT 2

#define SCANNER_CT 3

#define SCANNER_SINOGRAM 4

class sScannerManager
{
  // -----------------------------------------------------------------------------------------
  // Constructor & Destructor
  public:
    static sScannerManager* GetInstance() 
    {
      if (mp_Instance == NULL)
        mp_Instance = new sScannerManager();
      return mp_Instance;
    }

  // -----------------------------------------------------------------------------------------
  // Public member functions
  public:
    void Describe();
    int CheckParameters();
    int Initialize();
    int ShowScannersDescription();
    int FindScannerSystem(string a_scannerName);
    int InitScannerWithFile(string a_pathScanFile, string a_scannerName, int a_fileTypeFlag);
    int BuildScannerObject();
    int GetGeometricInfoFromDataFile(string a_pathToDataFilename);
    int InstantiateScanner();
    int BuildLUT();
    int GetModalityFromString(string a_systemStr);


  // -------------------------------------------------------------------
  // Get & Set functions
  public:
    inline bool HasUserScannerFile()
           {return m_hasUserScannerFile;}
    inline string GetPathToScannerFile()
           {return m_pathToScannerFile;}
    inline string GetScannerName()
           {return m_scannerName;}
    inline int GetScannerType()
           {return (mp_Scanner!=NULL) ? mp_Scanner->GetScannerType() : SCANNER_UNKNOWN ;}
    inline vScanner* GetScannerObject()
           {return mp_Scanner;}
    inline int GetSystemNbElts()
           {return mp_Scanner->GetSystemNbElts();}
    inline void SetVerbose(int a_verboseLevel)
           {m_verbose = a_verboseLevel;}
    inline void SetImageDimensionsAndQuantification(oImageDimensionsAndQuantification* ap_ID)
           {mp_ID = ap_ID;}
    inline void SetSaveLUTFlag(bool a_flag)
           {m_saveLUTFlag = a_flag;}
    inline bool SaveLUTFlag()
           {return m_saveLUTFlag;}
    
    
  // -------------------------------------------------------------------
  // Analytical projection functions
  public:
    int64_t PROJ_GetModalityStopValueMainLoop();
    int64_t PROJ_GetModalityStartValueInnerLoop(int64_t a_elt1);
    int64_t PROJ_GetCurrentProgression(int64_t a_elt1, int64_t a_elt2, int64_t* ap_nbEltsArray, int a_nbRGates, int a_nbCGates, int a_fr, int a_rg, int a_cg);
    int64_t PROJ_GetProgressionFinalValue();


  // -------------------------------------------------------------------
  // Functions dedicated to transfer geometric information for Projection, from the main class to the scanner class (Set)
  //                                                                       from the scanner class to the datafile (Get, for datafile header writing)
  public:
    // RECONSTRUCTION
    int GetSPECTSpecificParameters(uint16_t* ap_nbOfProjections, 
                                   uint16_t* ap_nbHeads,
                                   FLTNB* ap_acquisitionZoom,
                                   uint16_t* ap_nbOfBins, 
                                   FLTNB*  ap_pixSizeXY,
                                   FLTNB*& ap_angles, 
                                   FLTNB*& ap_CORtoDetectorDistance,
                                   int* ap_headRotDirection);
    int GetCTSpecificParameters(uint16_t* ap_nbOfProjections, 
                                FLTNB*& ap_angles, 
                                int* ap_headRotDirection);
    // ANALYTICAL PROJECTION
    int PROJ_GetPETSpecificParameters(FLTNB* ap_maxAxialDiffmm);
    int PROJ_SetPETSpecificParameters(FLTNB a_maxAxialDiffmm);
    int PROJ_SetSPECTSpecificParameters(uint16_t* ap_nbOfBins,
                                        uint32_t a_nbOfProjections, 
                                        FLTNB a_firstAngle, 
                                        FLTNB a_stepAngle, 
                                        FLTNB* ap_projectionAngles, 
                                        FLTNB a_CORtoDetectorDistance,
                                        string a_rotDirection);


  // -------------------------------------------------------------------
  // Private member functions
  private:
    sScannerManager();
    ~sScannerManager();
    // Prevent the compiler to generate methods to copy the object :
    sScannerManager(sScannerManager const&){};
    void operator=(sScannerManager const&){};
    int GetAvailableScanners(vector<string> *ap_scannerNames);


  // -------------------------------------------------------------------
  // Data members
  private:
    static sScannerManager* mp_Instance;       
    vScanner* mp_Scanner;                      
    oImageDimensionsAndQuantification* mp_ID;  
    int m_verbose;                             
    string m_pathToScannerFile;                
    string m_scannerName;                      
    bool m_hasUserScannerFile;                 
    bool m_hasGenericScannerFile;              
    bool m_allParametersChecked;               
    bool m_saveLUTFlag;                        
};

#endif