XRayBeam.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 __XRayBeam_h
#define __XRayBeam_h


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

#include <vector>
#include <string>
#include <iostream>

#ifdef HAS_PythonLibs
#include <Python.h>
#endif


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

#ifndef __SpectrumRecord_h
#include "gVirtualXRay/SpectrumRecord.h"
#endif


#include <memory>
#include <mutex>

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


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


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    ~XRayBeam();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void clear();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void clearSpectrumOnly();


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

    //--------------------------------------------------------------------------
    bool addChannel(const RATIONAL_NUMBER& aNumberOfPhotons,
                    const RATIONAL_NUMBER& anIncidentEnergy);


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

    //--------------------------------------------------------------------------
    void initialise(const char* aFileName,
                    const RATIONAL_NUMBER& aUnit,
                    unsigned int aMergeChannelFlag = 1);


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

    //--------------------------------------------------------------------------
    void initialise(const RATIONAL_NUMBER& anIncidentEnergy);


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void normalise();


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

    //--------------------------------------------------------------------------
    void setBinTotalEnergyCutoff(const RATIONAL_NUMBER& aThreshold);


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

    //--------------------------------------------------------------------------
    unsigned int getEnergyChannelNumber();


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

    //--------------------------------------------------------------------------
    const SpectrumRecord& getEnergyChannel(unsigned int anID);


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

    //--------------------------------------------------------------------------
    RATIONAL_NUMBER getTotalEnergy();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void enablePoissonNoise();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void disablePoissonNoise();


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

    //--------------------------------------------------------------------------
    void setNumberOfPhotons(RATIONAL_NUMBER aNumberOfPhotons);


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

    //--------------------------------------------------------------------------
    RATIONAL_NUMBER getNumberOfPhotons();


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

    //--------------------------------------------------------------------------
    void usePoissonNoise(bool aFlag);


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

    //--------------------------------------------------------------------------
    bool usePoissonNoise() const;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void sort();


    void setPhotonCountingBands(RATIONAL_NUMBER aMinEnergy,
        RATIONAL_NUMBER aMaxEnergy,
        unsigned int aNumberOfBands);


    unsigned int getNumberOfPhotonCountingBands();
    void activatePhotonCountingBand(unsigned int aBand);
    void mergePhotonCountingBands();
    const std::vector<RATIONAL_NUMBER>& getPhotonCountingBands();

    void setVoltage(const RATIONAL_NUMBER& aVoltage);
    void setmAs(const RATIONAL_NUMBER& an_mAs);
    void setTubeAngle(const RATIONAL_NUMBER& anAngle);
    RATIONAL_NUMBER getVoltage() const;
    RATIONAL_NUMBER getmAs() const;
    RATIONAL_NUMBER getTubeAngle() const;
    void clearFiltration();
    void setFiltration(const std::vector<std::pair<unsigned int, RATIONAL_NUMBER> >& aSetOfFilters);
    void addFilter(const std::string& aMaterial, const double& aThickness);
    void addFilter(unsigned int aMaterial, const double& aThickness);
    const std::vector<std::pair<unsigned int, RATIONAL_NUMBER> >& getFiltration() const;
    bool hasSpekpy();
    bool hasXpecgen();
    void useSpekpy();
    void useXpecgen();
    bool usingSpekpy() const;
    bool usingXpecgen() const;


//******************************************************************************
protected:
    void createSpectrumFromVoltage();
    std::string getInterpretor() const;

    std::vector<SpectrumRecord> m_beam_spectrum;


    RATIONAL_NUMBER m_bin_total_energy_lower_threshold;


    bool m_use_poisson_noise;


    RATIONAL_NUMBER m_number_of_photons_per_pixel;

    std::vector<std::vector<SpectrumRecord> > m_beam_spectrum_for_photon_count_detector;
    std::vector<RATIONAL_NUMBER>  m_photon_count_bands;

    RATIONAL_NUMBER m_voltage;
    RATIONAL_NUMBER m_tube_angle_in_degrees;
    RATIONAL_NUMBER m_mAs; // Not currently in use
    std::vector<std::pair<unsigned int, RATIONAL_NUMBER> > m_filtration;
    bool m_use_spekpy;
    bool m_use_xpecgen;
    bool m_need_to_update_tube_spectrum;
};


} // namespace gVirtualXRay


//******************************************************************************
#include "XRayBeam.inl"


#endif // __XRayBeam_h