GGEMSXRaySource.hh

Go to the documentation of this file.

#ifndef GUARD_GGEMS_SOURCES_GGEMSXRAYSOURCE_HH
#define GUARD_GGEMS_SOURCES_GGEMSXRAYSOURCE_HH
 
// ************************************************************************
// * This file is part of GGEMS.                                          *
// *                                                                      *
// * GGEMS 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.                                  *
// *                                                                      *
// * GGEMS 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 GGEMS.  If not, see <https://www.gnu.org/licenses/>.      *
// *                                                                      *
// ************************************************************************
 
#include "GGEMS/sources/GGEMSSource.hh"
 
class GGEMS_EXPORT GGEMSXRaySource : public GGEMSSource
{
  public:
    explicit GGEMSXRaySource(std::string const& source_name);
 
    ~GGEMSXRaySource(void);
 
    GGEMSXRaySource(GGEMSXRaySource const& xray_source) = delete;
 
    GGEMSXRaySource& operator=(GGEMSXRaySource const& xray_source) = delete;
 
    GGEMSXRaySource(GGEMSXRaySource const&& xray_source) = delete;
 
    GGEMSXRaySource& operator=(GGEMSXRaySource const&& xray_source) = delete;
 
    void SetBeamAperture(GGfloat const& beam_aperture, std::string const& unit = "deg");
 
    void SetFocalSpotSize(GGfloat const& width, GGfloat const& height, GGfloat const& depth, std::string const& unit = "mm");
 
    void SetMonoenergy(GGfloat const& monoenergy, std::string const& unit = "keV");
 
    void SetPolyenergy(std::string const& energy_spectrum_filename);
 
    void Initialize(bool const& is_tracking = false) override;
 
    void PrintInfos(void) const override;
 
    void GetPrimaries(GGsize const& thread_index, GGsize const& number_of_particles) override;
 
  private:
    void InitializeKernel(void) override;
 
    void FillEnergy(void);
 
    void CheckParameters(void) const override;
 
  private: // Specific members for GGEMSXRaySource
    GGfloat beam_aperture_; 
    GGfloat3 focal_spot_size_; 
    GGbool is_monoenergy_mode_; 
    GGfloat monoenergy_; 
    std::string energy_spectrum_filename_; 
    GGsize number_of_energy_bins_; 
    cl::Buffer** energy_spectrum_; 
    cl::Buffer** cdf_; 
};
 
extern "C" GGEMS_EXPORT GGEMSXRaySource* create_ggems_xray_source(char const* source_name);
 
extern "C" GGEMS_EXPORT void set_position_ggems_xray_source(GGEMSXRaySource* xray_source, GGfloat const pos_x, GGfloat const pos_y, GGfloat const pos_z, char const* unit);
 
extern "C" GGEMS_EXPORT void set_number_of_particles_xray_source(GGEMSXRaySource* xray_source, GGsize const number_of_particles);
 
extern "C" GGEMS_EXPORT void set_source_particle_type_ggems_xray_source(GGEMSXRaySource* xray_source, char const* particle_name);
 
extern "C" GGEMS_EXPORT void set_beam_aperture_ggems_xray_source(GGEMSXRaySource* xray_source, GGfloat const beam_aperture, char const* unit);
 
extern "C" GGEMS_EXPORT void set_focal_spot_size_ggems_xray_source(GGEMSXRaySource* xray_source, GGfloat const width, GGfloat const height, GGfloat const depth, char const* unit);
 
extern "C" GGEMS_EXPORT void set_rotation_ggems_xray_source(GGEMSXRaySource* xray_source, GGfloat const rx, GGfloat const ry, GGfloat const rz, char const* unit);
 
extern "C" GGEMS_EXPORT void set_monoenergy_ggems_xray_source(GGEMSXRaySource* xray_source, GGfloat const monoenergy, char const* unit);
 
extern "C" GGEMS_EXPORT void set_polyenergy_ggems_xray_source(GGEMSXRaySource* xray_source, char const* energy_spectrum);
 
#endif // End of GUARD_GGEMS_SOURCES_GGEMSXRAYSOURCE_HH