Represents a sensitive detector. More...

Inheritance diagram for OMSimSensitiveDetector:

Collaboration diagram for OMSimSensitiveDetector:

Detailed Description

Enhanced sensitive detector with photon origin classification.

Public Member Functions
	OMSimSensitiveDetector (G4String pName, DetectorType pDetectorType)
	Constructor for OMSimSensitiveDetector.

	~OMSimSensitiveDetector ()
	Destructor for OMSimSensitiveDetector.

G4bool	ProcessHits (G4Step pStep, G4TouchableHistory pTouchableHistory) override
	Processes hits for optical photons in the detector.

void	setPMTResponse (OMSimPMTResponse *pResponse)
	Sets the PMT response model.

	OMSimSensitiveDetector (G4String pName, DetectorType pDetectorType)

G4bool	ProcessHits (G4Step pStep, G4TouchableHistory pTouchableHistory) override

void	setPMTResponse (OMSimPMTResponse *pResponse)

Private Member Functions
G4bool	checkVolumeAbsorption (G4Step *pStep)
	Checks if the photon was absorbed in the volume.

G4bool	checkBoundaryAbsorption (G4Step *pStep)
	Checks if the photon was detected at a boundary.

PhotonInfo	getPhotonInfo (G4Step *pStep)
	Retrieves photon information from a given step.

G4bool	handlePMT (G4Step pStep, G4TouchableHistory pTouchableHistory)
	Handles hits for PMT detectors.

G4bool	handleGeneralPhotonDetector (G4Step pStep, G4TouchableHistory pTouchableHistory)
	Handles hits for general photon detectors.

G4bool	handleShellDetector (G4Step pStep, G4TouchableHistory pTouchableHistory)
	Handles hits for shell photon detectors. This detector does not kill the particle.

bool	isPhotonDetected (double p_efficiency)
	Monte carlo if the photon was detected based on the detection probability.

void	storePhotonHit (PhotonInfo &pInfo)
	Stores photon hit information into the HitManager.

void	fetchBoundaryProcess ()
	Fetches the boundary process for detecting boundary absorptions.

void	killParticle (G4Track *pTrack)
	Stop the particle from propagating further. Necessary for 100% efficient detectors.

G4bool	checkVolumeAbsorption (G4Step *pStep)

G4bool	checkBoundaryAbsorption (G4Step *pStep)

PhotonInfo	getPhotonInfo (G4Step *pStep)

G4bool	handlePMT (G4Step pStep, G4TouchableHistory pTouchableHistory)

G4bool	handleGeneralPhotonDetector (G4Step pStep, G4TouchableHistory pTouchableHistory)

G4bool	handleShellDetector (G4Step pStep, G4TouchableHistory pTouchableHistory)

bool	isPhotonDetected (double p_efficiency)

void	storePhotonHit (PhotonInfo &pInfo)

void	fetchBoundaryProcess ()

void	killParticle (G4Track *pTrack)

Private Attributes
bool	m_QEcut

OMSimPMTResponse *	m_PMTResponse

DetectorType	m_detectorType

Static Private Attributes
static thread_local G4OpBoundaryProcess *	m_boundaryProcess = nullptr

Constructor & Destructor Documentation

◆ OMSimSensitiveDetector()

OMSimSensitiveDetector::OMSimSensitiveDetector	(	G4String	p_name,
		DetectorType	p_detectorType
	)

Parameters

p_name	Name of the sensitive detector.
p_detectorType	Type of the detector (e.g., PMT, VolumePhotonDetector).

Member Function Documentation

◆ checkBoundaryAbsorption()

G4bool OMSimSensitiveDetector::checkBoundaryAbsorption ( G4Step * p_step )

private

Parameters

p_step The current step information.

Returns: True if the photon was detected at the boundary, false otherwise.

◆ checkVolumeAbsorption()

G4bool OMSimSensitiveDetector::checkVolumeAbsorption ( G4Step * p_step )

private

Parameters

p_step The current step information.

Returns: True if the photon was absorbed, false otherwise.

◆ fetchBoundaryProcess()

void OMSimSensitiveDetector::fetchBoundaryProcess ( )

private

Retrieves and stores the G4OpBoundaryProcess to check for photon detection at boundaries. Logs an error if the process is not found.

◆ getPhotonInfo()

PhotonInfo OMSimSensitiveDetector::getPhotonInfo ( G4Step * p_step )

private

Parameters

p_step The current step information.

Returns: PhotonInfo struct containing the photon details.

◆ handleGeneralPhotonDetector()

G4bool OMSimSensitiveDetector::handleGeneralPhotonDetector	(	G4Step *	p_step,
		G4TouchableHistory *	p_touchableHistory
	)

private

Parameters

p_step	The current step information.
p_touchableHistory	The history of touchable objects.

Returns: True if the hit was stored, always true for general photon detectors.

◆ handlePMT()

G4bool OMSimSensitiveDetector::handlePMT	(	G4Step *	p_step,
		G4TouchableHistory *	p_touchableHistory
	)

private

Parameters

p_step	The current step information.
p_touchableHistory	The history of touchable objects.

Returns: True if the hit was stored, false otherwise.

◆ handleShellDetector()

G4bool OMSimSensitiveDetector::handleShellDetector	(	G4Step *	p_step,
		G4TouchableHistory *	p_touchableHistory
	)

private

Parameters

p_step	The current step information.
p_touchableHistory	The history of touchable objects.

Returns: True if the hit was stored.alignas

◆ isPhotonDetected()

bool OMSimSensitiveDetector::isPhotonDetected ( double p_efficiency )

private

Parameters

p_efficiency The detection probability.

Returns: True if the photon was detected, false otherwise.

◆ ProcessHits()

G4bool OMSimSensitiveDetector::ProcessHits	(	G4Step *	p_step,
		G4TouchableHistory *	p_touchableHistory
	)

override

If the detector type is one of the perfect detectors (100% efficient), the photon hit is registered directly. Otherwise, it checks for volume or boundary absorption based on the detector type.

Parameters

p_step	The current step information.
p_touchableHistory	The history of touchable objects.

Returns: True if the photon hit was stored, false otherwise.

◆ setPMTResponse()

void OMSimSensitiveDetector::setPMTResponse ( OMSimPMTResponse * p_response )

Parameters

p_response Pointer to the PMT response object.

◆ storePhotonHit()

void OMSimSensitiveDetector::storePhotonHit ( PhotonInfo & p_info )

private

Parameters

p_info The photon hit information.

Member Data Documentation

◆ m_boundaryProcess

thread_local G4OpBoundaryProcess * OMSimSensitiveDetector::m_boundaryProcess = nullptr

staticprivate

Todo:: Test several optical modules of same type with new type

The documentation for this class was generated from the following files:

common/framework/include/OMSimSensitiveDetector.hh
simulations/wavepid/include/OMSimSensitiveDetector.hh
common/framework/src/OMSimSensitiveDetector.cc
simulations/wavepid/src/OMSimSensitiveDetector.cc

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

◆ OMSimSensitiveDetector()

Member Function Documentation

◆ checkBoundaryAbsorption()

◆ checkVolumeAbsorption()

◆ fetchBoundaryProcess()

◆ getPhotonInfo()

◆ handleGeneralPhotonDetector()

◆ handlePMT()

◆ handleShellDetector()

◆ isPhotonDetected()

◆ ProcessHits()

◆ setPMTResponse()

◆ storePhotonHit()

Member Data Documentation

◆ m_boundaryProcess