oImageSpace.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 OIMAGESPACE_HH
#define OIMAGESPACE_HH 1

#include "gVariables.hh"
#include "oImageDimensionsAndQuantification.hh"
#include "oDeformationManager.hh"
#include "oInterfileIO.hh"

class vOptimizer;

class oImageSpace
{
  // Constructor & Destructor
  public:
    oImageSpace();
    ~oImageSpace();


  // -------------------------------------------------------------------
  // Public member functions
  public:

  // Let these pointers public to simplify getting them in other classes
  FLTNB****   m4p_image; 
  FLTNB****   m4p_forwardImage; 
  FLTNB****** m6p_backwardImage;  
  FLTNB*****  m5p_sensitivity; 
  FLTNB**     m2p_multiModalImage; 
  FLTNB*      mp_maskImage; 
  FLTNB*      mp_visitedVoxelsImage; 
  FLTNB**     m2p_miscellaneousImage; 
  FLTNB****   m4p_attenuation; 
  FLTNB****   m4p_outputImage; 
  FLTNB****   m4p_refDynForwardImage;  
  FLTNB*****  m5p_refDynBackwardImage;  
  FLTNB****   m4p_refDynSensitivityImage;  
  FLTNB**     m2p_projectionImage;  
  // -------------------------------------------------------------------
  void InstantiateImage();
  void DeallocateImage();
  void InstantiateForwardImage();
  void DeallocateForwardImage();
  void InstantiateBackwardImageFromDynamicBasis(int a_nbBackwardImages);
  void DeallocateBackwardImageFromDynamicBasis();
  void InstantiateBackwardImageFromDynamicBins();
  void DeallocateBackwardImageFromDynamicBins();
  void InstantiateSensitivityImage(const string& a_pathToSensitivityImage);
  void DeallocateSensitivityImage();
  FLTNB* AllocateMiscellaneousImage();
  void DeallocateMiscellaneousImage();
  int InitMultiModalImage(const vector<string>& a_pathToMultiModalImage);
  void DeallocateMultiModalImage();
  int InitMaskImage(const string& a_pathToImage);
  void DeallocateMaskImage();


  void InstantiateOutputImage();
  void InstantiateRefImagesForDeformation();
  //void InstantiateSensImageForDeformation();
  void InstantiateVisitedVoxelsImage();
  //void DeallocateBwdImageForDeformation();
  void DeallocateRefImagesForDeformation();
  void DeallocateOutputImage();
  void DeallocateVisitedVoxelsImage();
  int InitImage(const string& a_pathToInitialImage, FLTNB a_value);
  void InitBackwardImage();
  int InitSensitivityImage(const string& a_pathToSensitivityImage);
  //void InitBwdImageForDeformation();
  //void InitSensImageForDeformation();
  void InitRefImagesForDeformation();
  int LoadInitialImage(const string& a_pathToImage);
  void ComputeOutputImage();
  int ApplyOutputFOVMasking();
  int ApplyOutputMaskImage();
  int ApplyMaskToSensitivity();
  int ApplyOutputFlip();
  int SaveOutputImage(int a_iteration, int a_subset = -1);
  int SaveOutputBasisCoefficientImage(int a_iteration, int a_subset = -1);
  void SaveDebugImage(const string& a_name);
  int SaveSensitivityImage(const string& a_pathToSensitivityImage);
  void PrepareForwardImage();
  void Reduce();
  void CleanNeverVisitedVoxels();


  // -------------------------------------------------------------------
  // Functions for List-Mode Sensitivity Generation process
  
  void LMS_InstantiateImage();
  void LMS_InstantiateForwardImage();
  void LMS_InstantiateSensitivityImage();
  void LMS_DeallocateImage();
  void LMS_DeallocateForwardImage();
  void LMS_DeallocateSensitivityImage();
  void LMS_DeallocateAttenuationImage();
  int InitAttenuationImage(const string& a_pathToAtnImage);
  void LMS_CopyAtnToImage();
  void LMS_CopyAtnToForwardImage(bool a_use1stMotion, bool a_use2ndMotion);
  void LMS_CopyBackwardToSensitivity();
  void LMS_PrepareForwardImage();
  void ReduceBackwardImage(int a_imageIndex, int a_timeIndex, int a_respIndex, int a_cardIndex);
  int ApplyMaskToBackwardImage(int a_imageIndex, int a_timeIndex, int a_respIndex, int a_cardIndex);
  int LMS_SaveSensitivityImage(const string& a_pathToSensitivityImage, oDeformationManager* ap_DeformationManager);


  // -------------------------------------------------------------------
  // Functions for ANALYTICAL PROJECTION process
  
  void PROJ_InstantiateProjectionImage(int a_nbProjs, int a_nbPixels);
  void PROJ_DeallocateProjectionImage(int a_nbProjs);
  int PROJ_InitImage(const string& a_pathToInitialImage);
  int PROJ_LoadInitialImage(const string& a_pathToImage);
  int PROJ_SaveProjectionImage();


  // -------------------------------------------------------------------
  // Public Get and Set functions
  public:
    inline void SetVerbose(int a_verboseLevel)
           {m_verbose = a_verboseLevel;}
    inline void SetImageDimensionsAndQuantification(oImageDimensionsAndQuantification* ap_ImageDimensionsAndQuantification)
           {mp_ID = ap_ImageDimensionsAndQuantification;}
    inline int GetNbBackwardImages()
           {return m_nbBackwardImages;}
    inline bool IsLoadedSensitivity()
           {return m_loadedSensitivity;}
    inline bool IsLoadedMultiModal()
           {return m_loadedMultiModal;}
    inline bool IsLoadedMask()
           {return m_loadedMask;}
    inline bool Checked()
           {return mp_ID!=NULL && m_verbose!=-1;}
    inline int GetNbMiscellaneousImages()
           {return m_nbMiscellaneousImages;}


  // -------------------------------------------------------------------
  // Data members
  private:
    oImageDimensionsAndQuantification* mp_ID; 
    int m_verbose;                            
    bool m_loadedSensitivity;                 
    bool m_loadedMultiModal;                  
    bool m_loadedMask;                        
    int m_nbBackwardImages;                   
    int m_nbMiscellaneousImages;              
};

#endif