Scintillator.h

Go to the documentation of this file.

/*

Copyright (c) 2022, 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 __Scintillator_h
#define __Scintillator_h


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

#include <string> // To store the material properties
#include <vector> // To store the energy response
#include <utility> // To create STL pairs

#ifndef __PhotonCrossSection_h
#include "gVirtualXRay/PhotonCrossSection.h"
#endif

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


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


//==============================================================================
//==============================================================================
class Scintillator
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    Scintillator();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    ~Scintillator();


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


    void setMaterial(const std::string& aMaterial);


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

    //--------------------------------------------------------------------------
    static std::vector<std::string> getSupportedScintillatorMaterials();


    void setThickness(const RATIONAL_NUMBER& aThickness);


    const std::string& getMaterial() const;


    RATIONAL_NUMBER getThickness();


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


    static std::vector<std::pair<RATIONAL_NUMBER, RATIONAL_NUMBER> > getEnergyResponse(const std::string& aMaterial,
        const RATIONAL_NUMBER& aThickness);


    static RATIONAL_NUMBER getDensity(const std::string& aMaterial);


    static std::string getCompound(const std::string& aMaterial);


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

     //--------------------------------------------------------------------------
    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);


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

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


//******************************************************************************
protected:
    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    int findNearestEnergyIdx(const RATIONAL_NUMBER& anEnergy) const;


    std::string m_material;
    RATIONAL_NUMBER m_density;

    RATIONAL_NUMBER m_thickness;

    std::vector<std::pair<RATIONAL_NUMBER, RATIONAL_NUMBER> > m_p_energy_response;


    // PhotonCrossSection m_photon_cross_section;
};


} // namespace gVirtualXRay


//******************************************************************************
#include "Scintillator.inl"


#endif // __Scintillator_h