Detector simulation. More...

#include <JDetectorSimulator.hh>

Inheritance diagram for JDETECTOR::JDetectorSimulator:

Public Types
typedef JDetector::const_iterator	const_iterator

Public Member Functions
	JDetectorSimulator (const JDetector &detector)
	Constructor. More...

bool	hasK40Simulator () const
	Check availability of K40 simulator. More...

bool	hasPMTSimulator () const
	Check availability of PMT simulator. More...

bool	hasCLBSimulator () const
	Check availability of CLB simulator. More...

const JK40Simulator &	getK40Simulator () const
	Get K40 simulator. More...

const JPMTSimulator &	getPMTSimulator () const
	Get PMT simulator. More...

const JCLBSimulator &	getCLBSimulator () const
	Get CLB simulator. More...

void	reset (JK40Simulator *k40Simulator)
	Reset K40 simulator. More...

void	reset (JPMTSimulator *pmtSimulator)
	Reset PMT simulator. More...

void	reset (JCLBSimulator *clbSimulator)
	Reset CLB simulator. More...

virtual void	generateHits (const JModule &module, const JTimeRange &period, JModuleData &output) const override
	Generate hits. More...

virtual void	processHits (const JPMTIdentifier &ID, const JCalibration &calibration, const JStatus &status, const JPMTData< JPMTSignal > &input, JPMTData< JPMTPulse > &output) const override
	Process hits. More...

virtual void	processData (const JModuleIdentifier &id, const JCLBInput &input, JDAQSuperFrame &output) const override
	Process data. More...

virtual void	operator() (const JModule &module, JModuleData &input, JDAQSuperFrame &output) const
	Process module data in one step. More...

const JPMTRouter &	getPMTRouter () const
	Get PMT router. More...

const JPMTAddress &	getAddress (const JObjectID &id) const
	Get address of PMT. More...

const JPMT &	getPMT (const JPMTAddress &address) const
	Get PMT. More...

const JPMT &	getPMT (const JObjectID &id) const
	Get PMT. More...

bool	hasPMT (const JObjectID &id) const
	Has PMT. More...

JPMTIdentifier	getIdentifier (const JPMTAddress &address) const
	Get identifier of PMT. More...

JPMTIdentifier	getIdentifier (const JObjectID &id) const
	Get identifier of PMT. More...

const JModule &	getModule (const JModuleAddress &address) const
	Get module. More...

const JModule &	getParentModule (const JObjectID &id) const
	Get parent module. More...

int	getParentModuleID (const JObjectID &id) const
	Get parent module identifier. More...

JPMTChannel	getPMTChannel (const JPMTAddress &address) const
	Get PMT channel. More...

JPMTChannel	getPMTChannel (const JObjectID &id) const
	Get PMT channel. More...

JUTMPosition	getUTMPosition (const JObjectID &id) const
	Get UTM position of given PMT identifier. More...

const JClass_t &	getReference () const
	Get reference to object. More...

JClass_t &	getReference ()
	Get reference to object. More...

bool	is_valid () const
	Check validity of reference. More...

const JClass_t *	operator-> () const
	Smart pointer. More...

JClass_t *	operator-> ()
	Smart pointer. More...

const JClass_t &	operator* () const
	Dereference operator. More...

JClass_t &	operator* ()
	Dereference operator. More...

Protected Attributes
JLANG::JSinglePointer< JK40Simulator >	k40Simulator

JLANG::JSinglePointer< JPMTSimulator >	pmtSimulator

JLANG::JSinglePointer< JCLBSimulator >	clbSimulator

JClass_t &	__object

Private Types
typedef JReference< const JDetector >	JReference_t

Private Member Functions
	JDetectorSimulator (const JDetectorSimulator &)
	Make copy constructor inaccesible. More...

JDetectorSimulator &	operator= (const JDetectorSimulator &)
	Make assignment operator inaccesible. More...

Private Attributes
JCLBInput	buffer

JTOOLS::JRouter< JPMTAddress >	router

Detailed Description

Detector simulation.

This class implements the JK40Simulator, JPMTSimulator and JCLBSimulator interfaces. The implementations of these interfaces should be provided via pointers to corresponding objects.

N.B: This class owns the objects pointed to using class JLANG::JSinglePointer.

Definition at line 33 of file JDetectorSimulator.hh.

Member Typedef Documentation

◆ JReference_t

typedef JReference<const JDetector> JDETECTOR::JPMTRouter::JReference_t

privateinherited

Definition at line 39 of file JPMTRouter.hh.

◆ const_iterator

typedef JDetector::const_iterator JDETECTOR::JPMTRouter::const_iterator

inherited

Definition at line 43 of file JPMTRouter.hh.

Constructor & Destructor Documentation

◆ JDetectorSimulator() [1/2]

JDETECTOR::JDetectorSimulator::JDetectorSimulator ( const JDetectorSimulator & )

private

Make copy constructor inaccesible.

◆ JDetectorSimulator() [2/2]

JDETECTOR::JDetectorSimulator::JDetectorSimulator ( const JDetector & detector )

inline

Constructor.

Parameters

detector detector

Definition at line 58 of file JDetectorSimulator.hh.

                                                   :
       JPMTRouter(detector)
     {}

Member Function Documentation

◆ operator=()

JDetectorSimulator& JDETECTOR::JDetectorSimulator::operator= ( const JDetectorSimulator & )

private

Make assignment operator inaccesible.

◆ hasK40Simulator()

bool JDETECTOR::JDetectorSimulator::hasK40Simulator ( ) const

inline

Check availability of K40 simulator.

Returns: true if simulator available; else false

Definition at line 68 of file JDetectorSimulator.hh.

     {
       return k40Simulator.get() != NULL;
     }

◆ hasPMTSimulator()

bool JDETECTOR::JDetectorSimulator::hasPMTSimulator ( ) const

inline

Check availability of PMT simulator.

Returns: true if simulator available; else false

Definition at line 80 of file JDetectorSimulator.hh.

     {
       return pmtSimulator.get() != NULL;
     }

◆ hasCLBSimulator()

bool JDETECTOR::JDetectorSimulator::hasCLBSimulator ( ) const

inline

Check availability of CLB simulator.

Returns: true if simulator available; else false

Definition at line 91 of file JDetectorSimulator.hh.

     {
       return clbSimulator.get() != NULL;
     }

◆ getK40Simulator()

const JK40Simulator& JDETECTOR::JDetectorSimulator::getK40Simulator ( ) const

inline

Get K40 simulator.

Returns: K40 simulator

Definition at line 102 of file JDetectorSimulator.hh.

     {
       if (hasK40Simulator())
         return *k40Simulator;
       else
         THROW(JPointerException, "JDetectorSimulator: K40 simulator not avaliable.");   
     }

◆ getPMTSimulator()

const JPMTSimulator& JDETECTOR::JDetectorSimulator::getPMTSimulator ( ) const

inline

Get PMT simulator.

Returns: PMT simulator

Definition at line 116 of file JDetectorSimulator.hh.

     {
       if (hasPMTSimulator())
         return *pmtSimulator;
       else
         THROW(JPointerException, "JDetectorSimulator: PMT simulator not avaliable.");   
     }

◆ getCLBSimulator()

const JCLBSimulator& JDETECTOR::JDetectorSimulator::getCLBSimulator ( ) const

inline

Get CLB simulator.

Returns: CLB simulator

Definition at line 130 of file JDetectorSimulator.hh.

     {
       if (hasCLBSimulator())
         return *clbSimulator;
       else
         THROW(JPointerException, "JDetectorSimulator: CLB simulator not avaliable.");   
     }

◆ reset() [1/3]

void JDETECTOR::JDetectorSimulator::reset ( JK40Simulator * k40Simulator )

inline

Reset K40 simulator.

Parameters

k40Simulator K40 simulator

Definition at line 144 of file JDetectorSimulator.hh.

     {
       this->k40Simulator.reset(k40Simulator);
     }

◆ reset() [2/3]

void JDETECTOR::JDetectorSimulator::reset ( JPMTSimulator * pmtSimulator )

inline

Reset PMT simulator.

Parameters

pmtSimulator PMT simulator

Definition at line 156 of file JDetectorSimulator.hh.

     {
       this->pmtSimulator.reset(pmtSimulator);
     }

◆ reset() [3/3]

void JDETECTOR::JDetectorSimulator::reset ( JCLBSimulator * clbSimulator )

inline

Reset CLB simulator.

Parameters

clbSimulator CLB simulator

Definition at line 167 of file JDetectorSimulator.hh.

     {
       this->clbSimulator.reset(clbSimulator);
     }

◆ generateHits()

virtual void JDETECTOR::JDetectorSimulator::generateHits	(	const JModule &	module,
		const JTimeRange &	period,
		JModuleData &	output
	)		const

inlineoverridevirtual

Generate hits.

Parameters

module	module
period	time window [ns]
output	background data

Implements JDETECTOR::JK40Simulator.

Definition at line 180 of file JDetectorSimulator.hh.

     {
       getK40Simulator().generateHits(module, period, output);
     }

◆ processHits()

virtual void JDETECTOR::JDetectorSimulator::processHits	(	const JPMTIdentifier &	ID,
		const JCalibration &	calibration,
		const JStatus &	status,
		const JPMTData< JPMTSignal > &	input,
		JPMTData< JPMTPulse > &	output
	)		const

inlineoverridevirtual

Process hits.

Parameters

ID	PMT identifier
calibration	PMT calibration
status	PMT status
input	PMT signals
output	PMT hits

Implements JDETECTOR::JPMTSimulator.

Definition at line 197 of file JDetectorSimulator.hh.

     {
       getPMTSimulator().processHits(ID, calibration, status, input, output);
     }

◆ processData()

virtual void JDETECTOR::JDetectorSimulator::processData	(	const JModuleIdentifier &	id,
		const JCLBInput &	input,
		JDAQSuperFrame &	output
	)		const

inlineoverridevirtual

Process data.

Parameters

id	module identifier
input	PMT data
output	CLB data

Implements JDETECTOR::JCLBSimulator.

Definition at line 214 of file JDetectorSimulator.hh.

     {
       getCLBSimulator().processData(id, input, output);
     }

◆ operator()()

virtual void JDETECTOR::JDetectorSimulator::operator()	(	const JModule &	module,
		JModuleData &	input,
		JDAQSuperFrame &	output
	)		const

inlinevirtual

Process module data in one step.

Parameters

module	module
input	PMT signals
output	CLB data

Definition at line 227 of file JDetectorSimulator.hh.

     {
       // PMT simulation
         
       buffer.reset(input.size());
   
       for (unsigned int i = 0; i != input.size(); ++i) {
             
         input[i].sort();
             
         const JPMT& pmt = module.getPMT(i);
  
         processHits(JPMTIdentifier(module.getID(), i), 
                     pmt.getCalibration(), 
                     pmt.getStatus(), 
                     input [i], 
                     buffer[i]);
       }
           
       // CLB simulation
           
       processData(module, buffer, output);
     }

◆ getPMTRouter()

const JPMTRouter& JDETECTOR::JPMTRouter::getPMTRouter ( ) const

inlineinherited

Get PMT router.

Returns: PMT router

Definition at line 68 of file JPMTRouter.hh.

     {
       return static_cast<const JPMTRouter&>(*this);
     }

◆ getAddress()

const JPMTAddress& JDETECTOR::JPMTRouter::getAddress ( const JObjectID & id ) const

inlineinherited

Get address of PMT.

Parameters

id	PMT identifier

Returns: address

Definition at line 80 of file JPMTRouter.hh.

     {
       return router.get(id.getID());
     }

◆ getPMT() [1/2]

const JPMT& JDETECTOR::JPMTRouter::getPMT ( const JPMTAddress & address ) const

inlineinherited

Get PMT.

Parameters

address PMT address

Returns: PMT

Definition at line 92 of file JPMTRouter.hh.

     {
       return getReference().getPMT(address);
     }

◆ getPMT() [2/2]

const JPMT& JDETECTOR::JPMTRouter::getPMT ( const JObjectID & id ) const

inlineinherited

Get PMT.

Parameters

id	PMT identifier

Returns: PMT

Definition at line 104 of file JPMTRouter.hh.

     {
       return getReference().getPMT(this->getAddress(id));
     }

◆ hasPMT()

bool JDETECTOR::JPMTRouter::hasPMT ( const JObjectID & id ) const

inlineinherited

Has PMT.

Parameters

id	PMT identifier

Returns: true if PMT present; else false

Definition at line 116 of file JPMTRouter.hh.

     {
       return router.has(id.getID());
     }

◆ getIdentifier() [1/2]

JPMTIdentifier JDETECTOR::JPMTRouter::getIdentifier ( const JPMTAddress & address ) const

inlineinherited

Get identifier of PMT.

Parameters

address PMT address

Returns: address

Definition at line 128 of file JPMTRouter.hh.

     {
       return JPMTIdentifier(getModule(address), address.second);
     }

◆ getIdentifier() [2/2]

JPMTIdentifier JDETECTOR::JPMTRouter::getIdentifier ( const JObjectID & id ) const

inlineinherited

Get identifier of PMT.

Parameters

id	PMT identifier

Returns: address

Definition at line 140 of file JPMTRouter.hh.

     {
       return getIdentifier(this->getAddress(id));
     }

◆ getModule()

const JModule& JDETECTOR::JPMTRouter::getModule ( const JModuleAddress & address ) const

inlineinherited

Get module.

Parameters

address module address

Returns: module

Definition at line 152 of file JPMTRouter.hh.

     {
       return getReference().getModule(address);
     }

◆ getParentModule()

const JModule& JDETECTOR::JPMTRouter::getParentModule ( const JObjectID & id ) const

inlineinherited

Get parent module.

Parameters

id	PMT identifier

Returns: module

Definition at line 164 of file JPMTRouter.hh.

     {
       return getModule(this->getAddress(id));
     }

◆ getParentModuleID()

int JDETECTOR::JPMTRouter::getParentModuleID ( const JObjectID & id ) const

inlineinherited

Get parent module identifier.

Parameters

id	PMT identifier

Returns: module identifier

Definition at line 176 of file JPMTRouter.hh.

     {
       return getParentModule(id).getID();
     }

◆ getPMTChannel() [1/2]

JPMTChannel JDETECTOR::JPMTRouter::getPMTChannel ( const JPMTAddress & address ) const

inlineinherited

Get PMT channel.

Parameters

address PMT address

Returns: PMT channel

Definition at line 188 of file JPMTRouter.hh.

     {
       return JPMTChannel(getModule(address).getLocation(), address.second);
     }

◆ getPMTChannel() [2/2]

JPMTChannel JDETECTOR::JPMTRouter::getPMTChannel ( const JObjectID & id ) const

inlineinherited

Get PMT channel.

Parameters

id	PMT identifier

Returns: PMT channel

Definition at line 200 of file JPMTRouter.hh.

     {
       return getPMTChannel(getAddress(id));
     }

◆ getUTMPosition()

JUTMPosition JDETECTOR::JPMTRouter::getUTMPosition ( const JObjectID & id ) const

inlineinherited

Get UTM position of given PMT identifier.

Parameters

id	PMT identifier

Returns: UTM position

Definition at line 212 of file JPMTRouter.hh.

     {
       return JUTMPosition(getPMT(id).getPosition() + getReference().getPosition());
     }

◆ getReference() [1/2]

template<class JClass_t >

const JClass_t& JLANG::JReference< JClass_t >::getReference ( ) const

inlineinherited

Get reference to object.

Returns: reference to object

Definition at line 38 of file JReference.hh.

     {
       return __object;
     }

◆ getReference() [2/2]

template<class JClass_t >

JClass_t& JLANG::JReference< JClass_t >::getReference ( )

inlineinherited

Get reference to object.

Returns: reference to object

Definition at line 49 of file JReference.hh.

     {
       return __object;
     }

◆ is_valid()

template<class JClass_t >

bool JLANG::JReference< JClass_t >::is_valid ( ) const

inlineinherited

Check validity of reference.

Returns: true

Definition at line 60 of file JReference.hh.

     {
       return true;
     }

◆ operator->() [1/2]

template<class JClass_t >

const JClass_t* JLANG::JReference< JClass_t >::operator-> ( ) const

inlineinherited

Smart pointer.

Returns: pointer to object

Definition at line 71 of file JReference.hh.

     {
       return &__object;
     }

◆ operator->() [2/2]

template<class JClass_t >

JClass_t* JLANG::JReference< JClass_t >::operator-> ( )

inlineinherited

Smart pointer.

Returns: pointer to object

Definition at line 82 of file JReference.hh.

     {
       return &__object;
     }

◆ operator*() [1/2]

template<class JClass_t >

const JClass_t& JLANG::JReference< JClass_t >::operator* ( ) const

inlineinherited

Dereference operator.

Returns: reference to object

Definition at line 93 of file JReference.hh.

     {
       return __object;
     }

◆ operator*() [2/2]

template<class JClass_t >

JClass_t& JLANG::JReference< JClass_t >::operator* ( )

inlineinherited

Dereference operator.

Returns: reference to object

Definition at line 104 of file JReference.hh.

     {
       return __object;
     }

Member Data Documentation

◆ k40Simulator

JLANG::JSinglePointer<JK40Simulator> JDETECTOR::JDetectorSimulator::k40Simulator

protected

Definition at line 255 of file JDetectorSimulator.hh.

◆ pmtSimulator

JLANG::JSinglePointer<JPMTSimulator> JDETECTOR::JDetectorSimulator::pmtSimulator

protected

Definition at line 256 of file JDetectorSimulator.hh.

◆ clbSimulator

JLANG::JSinglePointer<JCLBSimulator> JDETECTOR::JDetectorSimulator::clbSimulator

protected

Definition at line 257 of file JDetectorSimulator.hh.

◆ buffer

JCLBInput JDETECTOR::JDetectorSimulator::buffer

mutableprivate

Definition at line 260 of file JDetectorSimulator.hh.

◆ router

JTOOLS::JRouter<JPMTAddress> JDETECTOR::JPMTRouter::router

privateinherited

Definition at line 218 of file JPMTRouter.hh.

◆ __object

template<class JClass_t >

JClass_t& JLANG::JReference< JClass_t >::__object

protectedinherited

Definition at line 110 of file JReference.hh.

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

JDetectorSimulator.hh

Public Types

Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ JReference_t

◆ const_iterator

Constructor & Destructor Documentation

◆ JDetectorSimulator() [1/2]

◆ JDetectorSimulator() [2/2]

Member Function Documentation

◆ operator=()

◆ hasK40Simulator()

◆ hasPMTSimulator()

◆ hasCLBSimulator()

◆ getK40Simulator()

◆ getPMTSimulator()

◆ getCLBSimulator()

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ generateHits()

◆ processHits()

◆ processData()

◆ operator()()

◆ getPMTRouter()

◆ getAddress()

◆ getPMT() [1/2]

◆ getPMT() [2/2]

◆ hasPMT()

◆ getIdentifier() [1/2]

◆ getIdentifier() [2/2]

◆ getModule()

◆ getParentModule()

◆ getParentModuleID()

◆ getPMTChannel() [1/2]

◆ getPMTChannel() [2/2]

◆ getUTMPosition()

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ is_valid()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

Member Data Documentation

◆ k40Simulator

◆ pmtSimulator

◆ clbSimulator

◆ buffer

◆ router

◆ __object