vScanner.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 VSCANNER_HH
#define VSCANNER_HH 1

#include "gVariables.hh"
#include "sOutputManager.hh"
#include "oMatrix.hh"
#include "sRandomNumberGenerator.hh"

#define GEO_ROT_CW 0

#define GEO_ROT_CCW 1

class sScannerManager;

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


  // -------------------------------------------------------------------
  // Public member functions
  public:
    void Describe();
    virtual void DescribeSpecific() = 0;
    virtual int Instantiate(bool a_scannerFileIsLUT) = 0;
    virtual int BuildLUT(bool a_scannerFileIsLUT) = 0;
    virtual int CheckParameters() = 0;
    virtual int Initialize() = 0;
    virtual int GetPositionsAndOrientations( int a_index1, int a_index2,
                                             FLTNB ap_Position1[3], FLTNB ap_Position2[3],
                                             FLTNB ap_Orientation1[3], FLTNB ap_Orientation2[3],
                                             FLTNB* ap_POI1 = NULL, FLTNB* ap_POI2 = NULL ) = 0;
    virtual int GetRdmPositionsAndOrientations( int a_index1, int a_index2,
                                                FLTNB ap_Position1[3], FLTNB ap_Position2[3],
                                                FLTNB ap_Orientation1[3], FLTNB ap_Orientation2[3] ) = 0;
    virtual int GetPositionWithRandomDepth( int a_index1, int a_index2, FLTNB ap_Position1[3], FLTNB ap_Position2[3] ) = 0;
    virtual int GetTwoCorners( int a_index1, int a_index2,
                               FLTNB ap_CornerInf1[3], FLTNB ap_CornerSup1[3],
                               FLTNB ap_CornerInf2[3], FLTNB ap_CornerSup2[3]) = 0;
    virtual int GetEdgesCenterPositions( int a_index1, int a_index2,
      FLTNB ap_pos_line_point1[3], FLTNB ap_pos_line_point2[3],
      FLTNB ap_pos_point1_x[4], FLTNB ap_pos_point1_y[4], FLTNB ap_pos_point1_z[4],
      FLTNB ap_pos_point2_x[4], FLTNB ap_pos_point2_y[4], FLTNB ap_pos_point2_z[4] ) = 0;
    virtual int ComputeLUT();
    virtual int LoadLUT();
    virtual int GetSystemNbElts() = 0;
    virtual int IsAvailableLOR(int a_elt1, int a_elt2);
    virtual void ShowHelp() = 0;
    virtual int GetGeometricInfoFromDataFile(string a_path) = 0;
    inline int GetScannerType()
           {return m_scannerType;}
    string  GetScannerTypeString();
    inline void SetVerbose(int a_verboseLevel)
           {m_verbose = a_verboseLevel;}
    inline void SetImageDimensionsAndQuantification(oImageDimensionsAndQuantification* ap_ID)
           {mp_ID = ap_ID;}
    inline FLTNB GetDefaultBedDisplacementInMm()
           {return m_defaultBedDisplacementInMm;}
    inline virtual FLTNB GetDetectionElementSizeTrans() = 0;
    inline virtual FLTNB GetDetectionElementSizeAxial() = 0;

  // -------------------------------------------------------------------
  // PET dedicated functions (only overloaded by PET scanner class)
  public:
    virtual int SetPETMaxAxialDiffmm(FLTNB a_maxAxialDiffmm);
  
    virtual int SetRotDirection( string a_rotDirection );

    virtual int PROJ_GetPETSpecificParameters(FLTNB* ap_maxRingDiff);


  // -------------------------------------------------------------------
  // SPECT dedicated functions (only surcharged by SPECT scanner classes)
  public:
    virtual 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 );
    virtual int GetCTSpecificParameters( uint16_t* ap_nbOfProjections, 
                                         FLTNB*& ap_angles, 
                                         int* ap_detectorRotDirection );
    virtual int PROJ_SetSPECTNbBins( uint16_t* ap_nbOfBins );
    virtual int PROJ_SetSPECTNbProjections( uint32_t a_nbOfProjections );
    virtual int PROJ_SetSPECTAngles( FLTNB* ap_projectionAngles );
    virtual int PROJ_SetSPECTCORtoDetectorDistance( FLTNB a_CORtoDetectorDistance );
    virtual uint16_t PROJ_GetSPECTNbProjections(); // required for analytic projection (computations of indices for projection main loops in sScannerManager)
    virtual uint16_t PROJ_GetSPECTNbPixels(); // required for analytic projection (computations of index for projection main loops in sScannerManager)

    
  // -------------------------------------------------------------------
  // Private member functions
  private:


  // -------------------------------------------------------------------
  // Data members
  protected:
    int m_scannerType;                         
    int m_verbose;                             
    oImageDimensionsAndQuantification* mp_ID;  
    bool m_allParametersChecked;               
    oMatrix *mp_rotationMatrix;                
    oMatrix *mp_positionMatrix_ref;            
    oMatrix *mp_positionMatrix_out;            
    int m_rotDirection;                        
    FLTNB m_defaultBedDisplacementInMm;        
};


// ----------------------------------------------------------------------
// Part of code that manages the auto declaration of children classes
// ----------------------------------------------------------------------

// Macro for the function that creates the object
#define FUNCTION_SCANNER(CLASS) \
  static vScanner *make_scanner() { return new CLASS(); };

// Macro for the class that links the appropriate function to the map of objects
#define CLASS_SCANNER(NAME,CLASS)                                                             \
  class NAME##ScannerCreator                                                                  \
  {                                                                                           \
    public:                                                                                   \
      NAME##ScannerCreator()                                                                  \
        { sAddonManager::GetInstance()->mp_listOfScannerTypes[#NAME] = CLASS::make_scanner; } \
  };                                                                                          \
  static NAME##ScannerCreator ScannerCreator##NAME;

#endif