Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Xtalk in GND #653

Merged
merged 1 commit into from
Dec 6, 2023
Merged

Xtalk in GND #653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,6 @@ MESSAGE("- Coincidence digitizer modules (combining of several Coincidence Sorte
MESSAGE("- Compton Camera digitizer modules and output")
MESSAGE("- Output: Sinogram, Ecat7, LMF")
MESSAGE("- ARF may work not properly yet")
MESSAGE("- Digitizer Modules to be added soon: Buffer, intrinsicResolutionBlurring, lightYield, transferEfficiency, quantumEfficiency, crosstalk, calibration")
MESSAGE("We apologize for this inconvenience and kindly ask for your patience.")
MESSAGE("This functionalities will be added during 2023.")
MESSAGE("Meanwhile, please, use Gate 9.2")
Expand Down
197 changes: 103 additions & 94 deletions source/digits_hits/include/GateCrosstalk.hh
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,91 +6,80 @@ of the GNU Lesser General Public Licence (LGPL)
See LICENSE.md for further details
----------------------*/

// OK GND 2022

/*! \class GateCrosstalk
\brief Digitizer Module for simulating an optical and/or an electronic Crosstalk
- GateCrosstalk - by [email protected] (dec 2002)

- Digitizer Module for simulating an optical and/or an electronic Crosstalk
of the scintillation light between the neighbor crystals:
if the input Digi arrives in a crystal array, Digis around
it are created (in the edge and corner neighbor crystals).
ATTENTION: this module functions only for a chosen volume which is an array repeater !!!

5/12/23 - added to GND by [email protected] but MAYBE NOT PROPERLY TESTED !!!!

\sa GateVDigitizerModule
*/
#ifndef GateCrosstalk_h
#define GateCrosstalk_h 1

#include "GateVDigitizerModule.hh"
#include "GateDigi.hh"
#include "GateClockDependent.hh"
#include "GateCrystalSD.hh"

#include "globals.hh"
#include <iostream>
#include <vector>

#include "GateVPulseProcessor.hh"
#include "GateCrosstalkMessenger.hh"
#include "GateSinglesDigitizer.hh"

class GateCrosstalkMessenger;
class GateArrayParamsFinder;
class GateOutputVolumeID;

/*! \class GateCrosstalk
\brief Pulse-processor for simulating an optical and/or an electronic crosstalk
- GateCrosstalk - by [email protected] (dec 2002)
class GateCrosstalk : public GateVDigitizerModule
{
public:
//! This function allows to retrieve the current instance of the GateCrosstalk singleton
/*!
If the GateCrosstalk already exists, GetInstance only returns a pointer to this singleton.
If this singleton does not exist yet, GetInstance creates it by calling the private
GateCrosstalk constructor
*/
static GateCrosstalk* GetInstance(GateSinglesDigitizer* itsChain,
const G4String& itsName,
G4double itsEdgesFraction, G4double itsCornersFraction);

- Pulse-processor for simulating an optical and/or an electronic crosstalk
of the scintillation light between the neighbor crystals:
if the input pulse arrives in a crystal array, pulses around
it are created (in the edge and corner neighbor crystals).
ATTENTION: this module functions only for a chosen volume which is an array repeater !!!

GateCrosstalk(GateSinglesDigitizer *digitizer, G4String name, G4double itsEdgesFraction, G4double itsCornersFraction);
~GateCrosstalk();

void Digitize() override;

\sa GateVPulseProcessor
*/
class GateCrosstalk : public GateVPulseProcessor
{
public:
//! This function allows to retrieve the current instance of the GateCrosstalk singleton
/*!
If the GateCrosstalk already exists, GetInstance only returns a pointer to this singleton.
If this singleton does not exist yet, GetInstance creates it by calling the private
GateCrosstalk constructor
*/
static GateCrosstalk* GetInstance(GatePulseProcessorChain* itsChain,
const G4String& itsName,
G4double itsEdgesFraction, G4double itsCornersFraction);

//! Public Destructor
virtual ~GateCrosstalk() ;

private:
//!< Private constructor which Constructs a new crosstalk module attached to a GateDigitizer:
//! this function should only be called from GetInstance()
GateCrosstalk(GatePulseProcessorChain* itsChain,
const G4String& itsName,
G4double itsEdgesFraction, G4double itsCornersFraction) ;

public:


void CheckVolumeName(G4String val);

//! \name getters and setters
//@{
//! This function returns the fraction of the part of energy which goes in the edge crystals.
G4double GetEdgesFraction() { return m_edgesCrosstalkFraction; }

//! This function sets the fraction of the part of energy which goes in the edge crystals.
void SetEdgesFraction (G4double val) { m_edgesCrosstalkFraction = val; }

//! This function returns the fraction of the part of energy which goes in the corner crystals.
G4double GetCornersFraction() { return m_cornersCrosstalkFraction; }

//! This function sets the fraction of the part of energy which goes in the corner crystals.
void SetCornersFraction (G4double val) { m_cornersCrosstalkFraction = val; }

//! Return the rest crosstalk per cent
G4double GetXTPerCent() { return m_XtalkpCent; };
//@}

//! Implementation of the pure virtual method declared by the base class GateDigitizerComponent
//! print-out the attributes specific of the crosstalk
virtual void DescribeMyself(size_t indent);

protected:
//! Implementation of the pure virtual method declared by the base class GateVPulseProcessor
//! This methods processes one input-pulse
//! It is is called by ProcessPulseList() for each of the input pulses
//! The result of the pulse-processing is incorporated into the output pulse-list
void ProcessOnePulse(const GatePulse* inputPulse,GatePulseList& outputPulseList);

private:

void CheckVolumeName(G4String val);

//! \name getters and setters
//@{
//! This function returns the fraction of the part of energy which goes in the edge crystals.
G4double GetEdgesFraction() { return m_edgesCrosstalkFraction; }

//! This function sets the fraction of the part of energy which goes in the edge crystals.
void SetEdgesFraction (G4double val) { m_edgesCrosstalkFraction = val; }

//! This function returns the fraction of the part of energy which goes in the corner crystals.
G4double GetCornersFraction() { return m_cornersCrosstalkFraction; }

//! This function sets the fraction of the part of energy which goes in the corner crystals.
void SetCornersFraction (G4double val) { m_cornersCrosstalkFraction = val; }

//! Return the rest Crosstalk per cent
G4double GetXTPerCent() { return m_XtalkpCent; };
//@}

void DescribeMyself(size_t );

private:
// //! Find the different parameters of the array of detection :
// //! The numbers of rows in x, y and z
// //! The position in this matrix of the hit
Expand All @@ -102,34 +91,54 @@ class GateCrosstalk : public GateVPulseProcessor
// //! Get the ArrayRepeater from an VObjectReapeater (if it isn't an ArrayRepeater return 0)
// GateArrayRepeater* GetArrayRepeater(GateVGlobalPlacement* aRepeater);

// //! Find the different parameters of the input Pulse :
// //! Find the different parameters of the input Digi :
// //! e.g. the position in this array of the hit
// void FindInputPulseParams(const GateVolumeID* m_volumeID);
// void FindInputDigiParams(const GateVolumeID* m_volumeID);

//! Create a new VolumeID for the volume of in the matrix with position \i,\j,\k
GateVolumeID CreateVolumeID(const GateVolumeID* m_volumeID, G4int i, G4int j, G4int k);
//! Create a new VolumeID for the volume of in the matrix with position \i,\j,\k
GateVolumeID CreateVolumeID(const GateVolumeID* m_volumeID, G4int i, G4int j, G4int k);

//! Create a new OutputVolumeID for the volume of in the matrix with position \i,\j,\k
GateOutputVolumeID CreateOutputVolumeID(const GateVolumeID m_volumeID);
//! Create a new OutputVolumeID for the volume of in the matrix with position \i,\j,\k
GateOutputVolumeID CreateOutputVolumeID(const GateVolumeID m_volumeID);

//! Create a new Pulse of an energy of \val * ENERGY of \pulse in the volume in position \i,\j,\k
GatePulse* CreatePulse(G4double val, const GatePulse* pulse, G4int i, G4int j, G4int k);
//! Create a new Digi of an energy of \val * ENERGY of \Digi in the volume in position \i,\j,\k
GateDigi* CreateDigi(G4double val, const GateDigi* Digi, G4int i, G4int j, G4int k);

private:
//! Static pointer to the GateCrosstalk singleton
static GateCrosstalk* theGateCrosstalk;

G4double m_XtalkpCent; //!< Actual crosstalk per cent of energy
G4double m_edgesCrosstalkFraction, m_cornersCrosstalkFraction; //!< Coefficient which connects energy to the resolution
GateCrosstalkMessenger *m_messenger; //!< Messenger
G4String m_volume; //!< Name of the crosstalk volume
G4int m_testVolume; //!< Equal to 1 if m_volume is a valid volume name, else 0
protected:
G4double m_XtalkpCent; //!< Actual Crosstalk per cent of energy
G4double m_edgesCrosstalkFraction, m_cornersCrosstalkFraction; //!< Coefficient which connects energy to the resolution
GateCrosstalkMessenger *m_messenger; //!< Messenger
G4String m_volume; //!< Name of the Crosstalk volume
G4int m_testVolume; //!< Equal to 1 if m_volume is a valid volume name, else 0

GateArrayParamsFinder* ArrayFinder;
size_t m_nbX, m_nbY, m_nbZ; //!< Parameters of the matrix of detection
size_t m_i, m_j, m_k; //!< position \i,\j,\k in the matrix
size_t m_depth; //!< Depth of the selected volume in the Inserter
};
GateArrayParamsFinder* ArrayFinder;
size_t m_nbX, m_nbY, m_nbZ; //!< Parameters of the matrix of detection
size_t m_i, m_j, m_k; //!< position \i,\j,\k in the matrix
size_t m_depth;

private:

//! Static pointer to the GateCrosstalk singleton
static GateCrosstalk* theGateCrosstalk;

GateDigi* m_outputDigi;

GateCrosstalkMessenger *m_Messenger;

GateDigiCollection* m_OutputDigiCollection;

GateSinglesDigitizer *m_digitizer;


};

#endif








57 changes: 41 additions & 16 deletions source/digits_hits/include/GateCrosstalkMessenger.hh
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,59 @@ of the GNU Lesser General Public Licence (LGPL)
See LICENSE.md for further details
----------------------*/

// OK GND 2022
/*This class is not used by GATE !
The purpose of this class is to help to create new users digitizer module(DM).
Please, check GateCrosstalk.cc for more detals
*/


/*! \class GateCrosstalkMessenger
\brief Messenger for the GateCrosstalk

- GateCrosstalk - by [email protected]

\sa GateCrosstalk, GateCrosstalkMessenger
*/


#ifndef GateCrosstalkMessenger_h
#define GateCrosstalkMessenger_h 1

#include "GatePulseProcessorMessenger.hh"
#include <vector>
#include "G4UIdirectory.hh"
#include "G4UImessenger.hh"
#include "globals.hh"

#include "GateClockDependentMessenger.hh"
class GateCrosstalk;

class G4UIcmdWithAString;
class G4UIcmdWithADouble;

class GateCrosstalk;

class GateCrosstalkMessenger: public GatePulseProcessorMessenger
class GateCrosstalkMessenger : public GateClockDependentMessenger
{
public:
GateCrosstalkMessenger(GateCrosstalk* itsCrosstalk);
virtual ~GateCrosstalkMessenger();
public:

GateCrosstalkMessenger(GateCrosstalk*);
~GateCrosstalkMessenger();

void SetNewValue(G4UIcommand*, G4String);

inline void SetNewValue(G4UIcommand* aCommand, G4String aString);

private:
GateCrosstalk* m_Crosstalk;

G4UIcmdWithADouble *edgesFractionCmd;
G4UIcmdWithADouble *cornersFractionCmd;

inline GateCrosstalk* GetCrosstalk()
{ return (GateCrosstalk*) GetPulseProcessor(); }

private:
G4UIcmdWithAString *newVolCmd;
G4UIcmdWithADouble *edgesFractionCmd;
G4UIcmdWithADouble *cornersFractionCmd;
};

#endif








6 changes: 6 additions & 0 deletions source/digits_hits/include/GateIntrinsicResolution.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ public:
void SetEref(const G4double& value ){ m_Eref=value;} ;
void SetLightOutput(const G4double& value ){ m_LY=value;} ;
void SetTransferEff(const G4double& value ){ m_TE=value;} ;
void SetEdgesFraction (G4double val) { m_edgesCrosstalkFraction = val; }
void SetCornersFraction (G4double val) { m_cornersCrosstalkFraction = val; }


//! Allow to use file(s) as lookout table for quantum efficiency
void UseFile(G4String aFile);
Expand All @@ -70,6 +73,7 @@ protected:
G4double m_LY; //Light Yield
G4double m_TE; //Transfer efficiency
G4double m_QE; //Quantum efficiency
G4double m_XtalkpCent;
G4bool isFirstEvent;

G4double m_uniqueQE; //!< Value of the quantum efficiency if it's unique
Expand All @@ -93,6 +97,8 @@ protected:
G4double** m_table; //!< Lookout table for the quantum efficiency of all channels
G4String m_volumeName; //!< Name of the module
G4int m_testVolume; //!< equal to 1 if the volume name is valid, 0 else
G4double m_edgesCrosstalkFraction, m_cornersCrosstalkFraction; //!< Coefficient which connects energy to the resolution


private:
GateDigi* m_outputDigi;
Expand Down
2 changes: 2 additions & 0 deletions source/digits_hits/include/GateIntrinsicResolutionMessenger.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ private:
G4UIcmdWithADouble *coeffTECmd;
G4UIcmdWithAString *newFileQECmd;
G4UIcmdWithADouble *uniqueQECmd;
G4UIcmdWithADouble *edgesFractionCmd;
G4UIcmdWithADouble *cornersFractionCmd;



Expand Down
Loading
Loading