XRayDetector.h

Go to the documentation of this file.

/*

Copyright (c) 2017, Dr Franck P. Vidal (franck.p.vidal@fpvidal.net),
http://www.fpvidal.net/
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the Bangor University nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/


#ifndef __XRayDetector_h
#define __XRayDetector_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef __gVirtualXRayConfig_h
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif

#include <memory>
#include <vector> // To store the energy response
#include <utility> // To create STL pairs

#ifndef __Types_h
#include "gVirtualXRay/Types.h"
#endif

#ifndef __Matrix4x4_h
#include "gVirtualXRay/Matrix4x4.h"
#endif

#ifndef __VBO_h
#include "gVirtualXRay/VBO.h"
#endif

#ifndef __SphereMesh_h
#include "gVirtualXRay/SphereMesh.h"
#endif

#ifndef __CubeMesh_h
#include "gVirtualXRay/CubeMesh.h"
#endif

#ifndef __Scintillator_h
#include "gVirtualXRay/Scintillator.h"
#endif

#ifndef __Image_h
#include "gVirtualXRay/Image.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


//==============================================================================
//==============================================================================
class XRayDetector
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    typedef enum SourceShapeTag
    {
        POINT,        
        SQUARE,       
        RECTANGLE,    
        CUBE,         
        LINE,         
        PARALLEL,     
        UNKNOWN_SHAPE 
    } SourceShape;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    XRayDetector();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    ~XRayDetector();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
        void release();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void displayDetector();


    void setWidgetLength(const RATIONAL_NUMBER& aLength);


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void displaySource();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void displaySourceWireframe();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void displayBeam();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void displayFirstPixelPosition();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void displayDetectorPosition();


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setResolutionInUnitsOfLengthPerPixel(
            const RATIONAL_NUMBER& aResolution);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setResolutionInUnitsOfLengthPerPixel(const VEC2& aResolution);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setNumberOfPixels(const Vec2ui& aSizeInPixels);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setDetectorPosition(const VEC3& aDetectorPosition);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setXrayPointSource(const VEC3& aXraySourcePosition);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setCubicSource(const VEC3& aXraySourcePosition,
                        unsigned int aNumberOfSamplesAlongOneDirection,
                        RATIONAL_NUMBER aLength);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setSquareSource(const VEC3& aXraySourcePosition,
                         unsigned int aNumberOfSamplesAlongOneDirection,
                         RATIONAL_NUMBER aLength);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setRectangleSource(const VEC3& aXraySourcePosition,
                                        unsigned int aNumberOfSamplesAlongLength,
                                        unsigned int aNumberOfSamplesAlongHeight,
                                        RATIONAL_NUMBER aLongitudinalLength,
                                        RATIONAL_NUMBER aHeight);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setLineSource(const VEC3& aXraySourcePosition,
                       const VEC3& aDirection,
                       unsigned int aNumberOfSamplesAlongOneDirection,
                       RATIONAL_NUMBER aLength);


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void setXrayPointSource();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void setCubicSource();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void setSquareSource();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void setRectangleSource();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void setLineSource();


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setUpVector(const VEC3& anUpVector);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setRightVector(const VEC3& aRightVector);


    void autoAlignDetector(bool aFlag = true);


    void rotateDetector(const RATIONAL_NUMBER& anAngle, const VEC3& aRotationAxis);
    

    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setRotationMatrix(const MATRIX4& aMatrix);


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void setParallelBeam();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void setConeBeam();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void setPointSource();


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const Vec2ui& getNumberOfPixels() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const VEC2& getSizeInUnitOfLength() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const VEC2& getPixelSpacingInUnitOfLength() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const VEC3& getDetectorPosition() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const VEC3& getXraySourceCentre() const;


    unsigned int getNumberOfSourceSamples()const;


    const VEC3& getSourceSamplePosition(unsigned int aSampleID) const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const VEC3& getUpVector() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const MATRIX4& getRotationMatrix() const;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    const VEC3& getNormal() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const VEC3& getRightVector() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void getPlaneEquation(RATIONAL_NUMBER& A,
                                RATIONAL_NUMBER& B,
                                RATIONAL_NUMBER& C,
                                RATIONAL_NUMBER& D);


    //------------------------------------------------------------------------------

    //------------------------------------------------------------------------------
    const std::vector<float>& getVertices() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    SourceShape getSourceShape() const;


    const std::vector<VEC3>& getSourcePositionSet() const;


    void setSourcePositions(const std::vector<VEC3>& aSourcePostionSet);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void rotateFocalSpot(const RATIONAL_NUMBER& aRotationAngle, const VEC3& aRotationAxis);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void rotateSource(const RATIONAL_NUMBER& aRotationAngle, 
        const VEC3& aRotationCentre,
        const VEC3& aRotationAxis);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    bool useParallelBeam() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const RATIONAL_NUMBER& getFOVY() const;


    const VEC2& getPixelSizeInUnitOfLength() const;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void clearEnergyResponse();


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void loadEnergyResponse(const std::string& aFileName,
        const RATIONAL_NUMBER& aUnitOfEnergy);


    void setEnergyResponse(const std::vector<std::pair<float, float> >& anEnergyResponse);


    void setEnergyResponse(const std::vector<std::pair<double, double> >& anEnergyResponse);


    void setScintillator(const Scintillator& aScintillator);


    void setScintillator(const std::string& aMaterial,
        const float& aThickness);
    
    
    const std::string& getScintillatorMaterial();


    double getScintillatorThickness();

    std::vector<std::pair<RATIONAL_NUMBER, RATIONAL_NUMBER> > getEnergyResponse() const;
    

    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    RATIONAL_NUMBER applyEnergyResponse(const RATIONAL_NUMBER& anEnergy) const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setLSF(const std::string& aFileName);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setLSF(const std::vector<RATIONAL_NUMBER>& aLSF);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const std::vector<RATIONAL_NUMBER>& getLSF() const;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void clearLSF();


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setPSF(const Image<RATIONAL_NUMBER>& aPSF);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const Image<RATIONAL_NUMBER>& getPSF() const;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void clearPSF();


//******************************************************************************
protected:
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void updateSizeInUnitOfLength();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void updateInternalValues();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void updateVBOs();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void updateDetectorVBO();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void updateParallelBeamVBO();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void updateConeBeamVBO();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void updateFOVY();


    VEC3            m_detector_position;


    VEC3            m_xray_source_centre;


    std::vector<VEC3> m_p_xray_source_position_set;


    VEC3            m_up_vector;


    MATRIX4         m_rotation_matrix;


    VEC2            m_size_in_unit_of_length;


    VEC2 m_resolution_in_unit_of_length_per_pixel;


    RATIONAL_NUMBER m_distance_source_detector;


    Vec2ui          m_size_in_number_of_pixels;


    bool m_vbo_need_update;


#if __cplusplus < 199711L
    std::auto_ptr<VBO> m_detector_geometry;
#else
    std::unique_ptr<VBO> m_detector_geometry;
#endif

    std::vector<GLfloat> m_p_detector_geometry_vertices;

#if __cplusplus < 199711L
    std::auto_ptr<VBO> m_parallel_beam;
#else
    std::unique_ptr<VBO> m_parallel_beam;
#endif


#if __cplusplus < 199711L
    std::auto_ptr<VBO> m_cone_beam;
#else
    std::unique_ptr<VBO> m_cone_beam;
#endif


#if __cplusplus < 199711L
    std::auto_ptr<VBO> m_parallel_beam_highlight;
#else
    std::unique_ptr<VBO> m_parallel_beam_highlight;
#endif


#if __cplusplus < 199711L
    std::auto_ptr<VBO> m_cone_beam_highlight;
#else
    std::unique_ptr<VBO> m_cone_beam_highlight;
#endif

    
    RATIONAL_NUMBER m_widget_length;


    SphereMesh m_source_mesh;


    CubeMesh<float> m_first_pixel_mesh;
    SphereMesh m_detector_centre_mesh;


    SourceShape m_source_shape;


    VEC3 m_normal;


    VEC3 m_look_at_vector;


    VEC3 m_right_vector;


    RATIONAL_NUMBER m_fovy;


    Scintillator m_scintillator;


    std::vector<RATIONAL_NUMBER> m_LSF;


    Image<RATIONAL_NUMBER> m_PSF;


    bool m_update_right_vector_flag;
};


} // namespace gVirtualXRay


//******************************************************************************
#include "XRayDetector.inl"


#endif // __XRayDetector_h