Auxiliary classes and methods for detector calibration. More...

Classes
class	JAnchor
	Data structure for anchor position on sea bed. More...

class	JCalibration
	Data structure for time calibration. More...

struct	JCalibrator
	Auxiliary class to apply (de-)calibration to template hit. More...

struct	JCalibrator< T, true >
	Template specialisation of JCalibrator for primitive data types. More...

struct	JCalibrator< JHit_t, false >
	Template specialisation of JCalibrator for non-primitive data types. More...

class	JTransferFunction1D
	Auxiliary class for a non-linear transfer function of TDC inside FPGA. More...

class	JCLBDefaultSimulator
	Default CLB simulation. More...

class	JCLBDefaultSimulatorInterface
	Default CLB simulation. More...

struct	JCLBInput
	Wrapper for CLB input. More...

class	JCLBSimulator
	Interface for CLB simulation. More...

class	JCompass
	Data structure for compass in three dimensions. More...

class	JDAQHitRouter
	Simple wrapper around JModuleRouter class for direct addressing of PMT data in detector data structure for DAQ hits. More...

class	JDetector
	Detector data structure. More...

class	JDetectorAddressMap
	Lookup table for PMT addresses in detector. More...

struct	JPPM_DU_t
	Type definitions for different detectors.PPM_DU. More...

struct	JKM3NeT_t
	KM3NeT More...

struct	JMonteCarlo_t
	Monte Carlo. More...

struct	JAntares_t
	Antares More...

struct	JObsolete_t
	obsolete detector More...

class	JTemplateDetectorAddressMap
	Template lookup table for PMT addresses in detector. More...

class	JTemplateDetectorAddressMap< JObsolete_t >
	Template specialisation of JTemplateDetectorAddressMap for obsolete detector. More...

class	JTemplateDetectorAddressMap< JPPM_DU_t >
	Template specialisation of JTemplateDetectorAddressMap for PPM_DU detector. More...

class	JTemplateDetectorAddressMap< JKM3NeT_t >
	Template specialisation of JTemplateDetectorAddressMap for KM3NeT detector. More...

class	JTemplateDetectorAddressMap< JMonteCarlo_t >
	Template specialisation of JTemplateDetectorAddressMap for Monte Carlo detector. More...

struct	JDetectorAddressMap_t
	Auxiliary class to extract detector address map from detector identifier. More...

struct	JDetectorAddressMap_t< JTypeList< JHead_t, JTail_t > >

struct	JDetectorAddressMap_t< JTypeList< JHead_t, JNullType > >

struct	JPMTCalibration_t
	Auxiliary data structure for PMT time calibration. More...

struct	JHVCalibration_t
	Data structure for PMT high-voltage calibration. More...

struct	JPMTThresholdCalibration_t
	Data structure for PMT threshold calibration. More...

struct	JModulePosition_t
	Auxiliary data structure for module position. More...

struct	JModuleRotation_t
	Auxiliary data structure for module rotation. More...

class	JDetectorHeader
	Data structure for detector header. More...

class	JDetectorParameters
	Data structure for parameters for detector geometry. More...

class	JDetectorParametersHelper
	Auxiliary class for I/O of JDetectorParameters data structure. More...

class	JDetectorSimulator
	Detector simulation. More...

class	JDetectorSubset_t
	Detector subset without binary search functionality. More...

class	JDetectorSubset
	Detector subset with binary search functionality. More...

struct	JRotation
	Auxiliary class to get rotation matrix between two optical modules. More...

struct	JDetectorVersion
	Detector version. More...

struct	JGetDetectorVersion
	Auxiliary class to map detector version to numerical value. More...

struct	JPutDetectorVersion
	Auxiliary class to map numerical value to detector version. More...

struct	JHydrophone
	Type definition of hydrophone. More...

class	JK40DefaultSimulator
	Default implementation of the simulation of K40 background. More...

class	JK40DefaultSimulatorInterface
	Default K40 simulator interface. More...

class	JK40Simulator
	Interface for simulation of K40 background. More...

class	JLocation
	Logical location of module. More...

class	JModule
	Data structure for a composite optical module. More...

class	JModuleAddress
	Address of module in detector data structure. More...

struct	JPMTAddressTranslator
	Data structure to translate PMT physical to readout address. More...

class	JModuleAddressMap
	Lookup table for PMT addresses in optical module. More...

struct	JModuleComparator3Z_t
	Module comparator according its z-position. More...

struct	JModuleComparator3D_t
	Module comparator according its distance to origin. More...

class	JModuleGeometry
	Module geometry. More...

struct	JUTCDistance
	Auxiliary class for distance beteen UTC times. More...

struct	JModuleAttributes
	Data structure for module address and module attributes. More...

struct	JMaximalDistance
	Auxiliary class to match modules according maximal distance. More...

class	JModuleMapper
	Mapper for directly addressing of associated modules in the detector data structure. More...

class	JModuleRouter
	Router for direct addressing of module data in detector data structure. More...

struct	JGetModuleStatusBit
	Auxiliary class to map key to module status bit. More...

class	JMonteCarloDetector
	Monte Carlo detector (i.e. so-called .det file). More...

class	JPMT
	Data structure for PMT geometry, calibration and status. More...

class	JPMTAddress
	Address of PMT in detector data structure. More...

struct	JPMTAnalogueSignalProcessor
	PMT analogue signal processor. More...

class	JPMTChannel
	Auxiliary class to uniquely identify PMT readout channel. More...

struct	JModuleAnalogueSignalProcessor
	Auxiliary container for PMT analogue signal processors in same optical module. More...

class	JPMTDefaultSimulator
	Default PMT simulation. More...

class	JPMTDefaultSimulatorInterface
	Default PMT simulation interface. More...

class	JPMTIdentifier
	PMT identifier. More...

class	JPMTParameters
	Data structure for PMT parameters. More...

class	JPMTParametersMap
	Auxiliary class for map of PMT parameters. More...

class	JPMTPhysicalAddress
	Data structure for PMT physical address. More...

struct	JPMTRateRange
	Data structure for range of PMT rates. More...

class	JPMTReadoutAddress
	Data structure for PMT readout address. More...

class	JPMTRouter
	Router for direct addressing of PMT data in detector data structure. More...

class	JPMTSignalProcessorInterface
	PMT signal processor interface. More...

struct	JPhotoElectron
	Data structure for single photo-electron. More...

struct	JPMTSignal
	Data structure for PMT analogue signal. More...

struct	JPMTPulse
	Data structure for PMT digital pulse. More...

class	JPMTData
	Template data structure for PMT I/O. More...

class	JModuleData
	Data structure for PMT data corresponding to a detector module. More...

class	JPMTSimulator
	Interface for PMT simulation. More...

struct	JGetPMTStatusBit
	Auxiliary class to map key to PMT status bit. More...

struct	JTransitionTimeGenerator_t
	Auxiliary base class to generate PMT transition times based on measurements. More...

struct	JTransitionTimeGenerator
	Implementation to generate PMT transition times based on measurements by Oleg Kalekin et al. (see also examples/JDetector/JTTS.cc). More...

struct	JTransitionTimeGenerator38
	Implementation to generate PMT transition times based on measurements. More...

struct	JTransitionTimeGenerator41
	Implementation to generate PMT transition times based on measurements. More...

struct	JTransitionTimeGeneratorXX
	Implementation to generate PMT transition times based on measurements. More...

struct	JTransitionTimeProbability_t
	Auxiliary base class for probability distibution of the PMT transition times based on measurements. More...

struct	JTransitionTimeProbability
	Implementation of probability distibution of the PMT transition times based on measurements by Oleg Kalekin et al. More...

struct	JTransitionTimeProbability38
	Implementation of probability distibution of the PMT transition times based on measurements. More...

struct	JTransitionTimeProbability41
	Implementation of probability distibution of the PMT transition times based on measurements. More...

struct	JTransitionTimeProbabilityXX
	Implementation of probability distibution of the PMT transition times based on measurements. More...

class	JTransitionTimeProbability2D
	Auxiliary class to generate twofold PMT transition times. More...

struct	JStringCounter
	Auxiliary class for counting unique strings. More...

struct	JStringRouter
	Router for mapping of string identifier to index. More...

class	JTripod
	Data structure for tripod. More...

struct	JVersion
	Auxiliary class for version identifier. More...

Typedefs
typedef JPMTData< JPMTPulse >	JPMTOutput
	Type definition of PMT base output. More...

typedef JTYPELIST< JPPM_DU_t, JKM3NeT_t, JMonteCarlo_t > ::typelist	JDetectorTypes_t
	Type list of KM3NeT detector types. More...

typedef std::vector < JHVCalibration_t >	JHVCalibration
	PMT high voltage calibration. More...

typedef std::vector < JPMTThresholdCalibration_t >	JPMTThresholdCalibration
	PMT threshold calibration. More...

typedef std::vector < JPMTCalibration_t >	JPMTCalibration
	PMT time calibration. More...

typedef std::vector < JModulePosition_t >	JModulePosition
	Module position. More...

typedef std::vector < JModuleRotation_t >	JModuleRotation
	Module rotation. More...

typedef JLANG::JObjectID	JDetectorID
	Type definition of detector identifier. More...

typedef JTOOLS::JRange< int >	floor_range
	Type definition for range of floors. More...

typedef JLANG::JComparator < double(JVector3D::*)() const >	JModuleComparator
	Type definition of a module comparator using 3D position information. More...

typedef JLANG::JObjectID	JModuleIdentifier

typedef JPutStatusBit	JPutModuleStatusBit
	Type definition to map module status bit to key. More...

typedef std::map < JPMTIdentifier, JPMTParameters >	JPMTParametersMap_t
	Type definition of map PMT identifier to PMT parameters. More...

typedef JPutStatusBit	JPutPMTStatusBit
	Type definition to map PMT status bit to key. More...

Functions
bool	operator< (const JAnchor &first, const JAnchor &second)
	Sort anchors in ascending distance from (0,0). More...

template<class T >
double	getTime (const T &t1, const JCalibration &cal)
	Get calibrated time. More...

template<class T >
double	putTime (const T &t1, const JCalibration &cal)
	Get de-calibrated time. More...

template<class T >
double	getToT (const T &tot, const JCalibration &cal)
	Get calibrated time-over-threshold of hit. More...

template<class T >
double	putToT (const T &tot, const JCalibration &cal)
	Get de-calibrated time-over-threshold of hit. More...

bool	hasDetector (JType< JPPM_DU_t > type, const int id)
	Check validity of detector identifier. More...

bool	hasDetector (JType< JKM3NeT_t > type, const int id)

bool	hasDetector (JType< JMonteCarlo_t > type, const int id)

template<class JDetector_t >
JDetectorAddressMap &	getDetectorAddressMap ()
	Get detector address map. More...

template<class JDetector_t >
JModuleAddressMap &	getModuleAddressMap (int id)
	Get module address map. More...

template<class JDetector_t >
const JPMTAddressTranslator &	getPMTAddressTranslator (int id, int tdc)
	Get PMT address translator for given module identifier and TDC channel. More...

template<class JDetector_t >
int	getPMTLogicalIndex (int id, int tdc)
	Get PMT logical index for given module identifier and TDC channel. More...

JDetectorAddressMap &	getDetectorAddressMap (const int id)
	Get detector address map. More...

bool	hasDetectorAddressMap (const int id)
	Check if detector address map is available. More...

bool	is_valid (const json &js)
	Check validity of JSon data. More...

template<class T >
std::vector< std::string >	get_string_array (T value)
	Cast single value to array of strings, conform the DB-format. More...

double	retrieve_value (std::vector< std::string > string_value_array)
	Retrieve value from json array of strings. More...

void	to_json (json &js, const JPMTCalibration_t &object)
	Convert PMT time calibration to JSon. More...

void	from_json (const json &js, JPMTCalibration_t &object)
	Convert JSon to PMT time calibration. More...

void	to_json (json &js, const JHVCalibration_t &object)
	Convert PMT high-voltage calibration to JSon. More...

void	from_json (const json &js, JHVCalibration_t &object)
	Convert JSon to PMT high-voltage calibration. More...

void	to_json (json &js, const JPMTThresholdCalibration_t &object)
	Convert PMT threshold calibration to JSon. More...

void	from_json (const json &js, JPMTThresholdCalibration_t &object)
	Convert JSon to PMT threshold calibration. More...

void	to_json (json &js, const JModulePosition_t &object)
	Convert module position to JSon. More...

void	from_json (const json &js, JModulePosition_t &object)
	Convert JSon to module position. More...

void	to_json (json &js, const JModuleRotation_t &object)
	Convert module rotation to JSon. More...

void	from_json (const json &js, JModuleRotation_t &object)
	Convert JSon to module rotation. More...

JUTMGrid	getARCAUTMGrid ()
	Get UTM grid for ARCA. More...

JUTMGrid	getORCAUTMGrid ()
	Get UTM grid for ORCA. More...

JDetectorHeader	getARCADetectorHeader ()
	Get detector header for ARCA. More...

JDetectorHeader	getORCADetectorHeader ()
	Get detector header for ORCA. More...

bool	isARCADetector (const JDetectorHeader &header)
	Check if given detector header is compatible with tat of ARCA. More...

bool	isORCADetector (const JDetectorHeader &header)
	Check if given detector header is compatible with that of ORCA. More...

double	getMaximalDistance (const JDetector &detector)
	Get maximal distance between modules in detector. More...

double	GetXrotationG4 (const JVersor3D dir)
	Get rotation over X axis in Geant4 coordinate system. More...

double	GetYrotationG4 (const JVersor3D dir)
	Get rotation over Y axis in Geant4 coordinate system. More...

void	read_gdml (std::istream &, JDetector &)

void	write_gdml (std::ostream &out, const JDetector &detector)
	Writes KM3Sim GDML input file from detector. More...

double	getMaximalTime (const JDetector &detector)
	Get maximal time between modules in detector following causality. More...

double	getMaximalTime (const JDetector &detector, const double roadWidth_m)
	Get maximal time between modules in detector following causality. More...

JTimeRange	getTimeRange (const JTimeRange &timeRange, const JModule &module)
	Get de-calibrated time range. More...

int	getNumberOfPMTs (const JModule &module)
	Get number of PMTs. More...

int	getNumberOfPMTs (const JDetector &detector)
	Get number of PMTs. More...

std::set< int >	getStringIDs (const JDetector &detector)
	Get list of strings identifiers. More...

int	getNumberOfFloors (const JDetector &detector)
	Get number of floors. More...

floor_range	getRangeOfFloors (const JDetector &detector)
	Get range of floors. More...

int	getNumberOfModules (const JDetector &detector)
	Get number of modules. More...

void	load (const std::string &file_name, JDetector &detector)
	Load detector from input file. More...

void	store (const std::string &file_name, const JDetector &detector)
	Store detector to output file. More...

const JModule &	getModule (const JModuleAddressMap &memo, const int id=-1, const JLocation &location=JLocation())
	Get module according module address map. More...

template<class JDetector_t >
const JModule &	getModule (const JType< JDetector_t > type, const int id, const JLocation &location=JLocation())
	Get module according given detector type. More...

const JModule &	getModule (const JType< JAntares_t > type, const int id, const JLocation &location=JLocation())
	Get module according Antares detector type. More...

template<class JDetector_t >
const JModule &	getModule (const int id, const JLocation &location=JLocation())
	Get module according detector template. More...

JPosition3D	getPosition (const JModule &first, const JModule &second)
	Get position to go from first to second module. More...

JCalibration	getCalibration (const JCalibration &first, const JCalibration &second)
	Get calibration to go from first to second calibration. More...

std::vector< std::string >	getDetectorVersions (const JType< std::string > &type)
	Get detector versions. More...

std::vector < JDetectorVersion::JVersion_t >	getDetectorVersions (const JType< JDetectorVersion::JVersion_t > &type)
	Get detector versions. More...

template<class T >
std::vector< T >	getDetectorVersions ()
	Get detector versions. More...

std::string	getLatestDetectorVersion (const JType< std::string > &type)
	Get latest detector version. More...

JVersion	getLatestDetectorVersion (const JType< JVersion > &type)
	Get latest detector version. More...

JDetectorVersion::JVersion_t	getLatestDetectorVersion (const JType< JDetectorVersion::JVersion_t > &type)
	Get latest detector version. More...

template<class T >
T	getLatestDetectorVersion ()
	Get latest detector version. More...

std::string	getLabel (const JLocation &location)
	Get module label for monitoring and other applications. More...

template<class JAttributes_t >
void	setAttributes (const JModule &first, const JModule &second, JAttributes_t &attributes)
	Template method to set module attributes. More...

template<>
void	setAttributes< JNullType > (const JModule &first, const JModule &second, JNullType &attributes)
	Template specialisation to set no attributes for the default empty object. More...

std::vector< std::string >	getModuleStatusBits (const JType< std::string > &type)
	Get module status bits. More...

std::vector< int >	getModuleStatusBits (const JType< int > &type)
	Get module status bits. More...

template<class T >
std::vector< T >	getModuleStatusBits ()
	Get module status bits. More...

JPosition3D	getPiezoPosition ()
	Get relative position of piezo in optical module. More...

double	getTimeOverThresholdProbability (const JPMTAnalogueSignalProcessor &pmt, const double tot_ns, const double NPE, const double precision=1.0e-4)
	Get time-over-threshold probability. More...

bool	operator< (const JPMTIdentifier &first, const JPMTIdentifier &second)
	Less than operator for PMT identifiers. More...

bool	operator== (const JPMTIdentifier &first, const JPMTIdentifier &second)
	Equal operator for PMT identifiers. More...

std::string	getLabel (const JPMTIdentifier &id)
	Get PMT label for monitoring and other applications. More...

double	getSurvivalProbability (const JPMTParameters &parameters)
	Get model dependent probability that a one photo-electron hit survives the simulation of the PMT assuming QE = 1. More...

double	getHitProbability (const double QE, const double mu)
	Get ratio of hit probabilities for given QE and expectation value of the number of photo-electrons. More...

double	getMaximalHitProbability (const double mu)
	Get maximal ratio of hit probabilities for given QE and expectation value of the number of photo-electrons. More...

double	getQE (const double R, const double mu)
	Get QE for given ratio of hit probabilities and expectation value of the number of photo-electrons. More...

double	getChargeProbability (const JPMTSignalProcessorInterface &pmt, const double npe, const double NPE, const double precision=1.0e-4)
	Get charge probability. More...

bool	operator< (const JPhotoElectron &first, const JPhotoElectron &second)
	Less than operator for photo-elecrons. More...

bool	operator< (const JPMTSignal &first, const JPMTSignal &second)
	Less than operator for PMT signals. More...

bool	operator< (const JPMTPulse &first, const JPMTPulse &second)
	Less than operator for PMT pulses. More...

JTimeRange	getTimeRange (const JPMTData< JPMTSignal > &input)
	Get time range (i.e. earlist and latest hit time) of PMT data. More...

JTimeRange	getTimeRange (const JModuleData &input)
	Get time range (i.e. earlist and latest hit time) of module data. More...

std::vector< std::string >	getPMTStatusBits (const JType< std::string > &type)
	Get PMT status bits. More...

std::vector< int >	getPMTStatusBits (const JType< int > &type)
	Get PMT status bits. More...

template<class T >
std::vector< T >	getPMTStatusBits ()
	Get PMT status bits. More...

Variables
const double	TIME_OVER_THRESHOLD_NS = 25.08
	Specification for time-over-threshold corresponding to a one photo-electron pulse. More...

const double	NOMINAL_GAIN = 1.0
	Specification for normalized gain corresponding to a one photo-electron pulse. More...

static const std::string	User_t = "User"
	Detector calibration key words for JSON I/O. More...

static const std::string	Location_t = "Location"

static const std::string	Time_t = "Time"

static const std::string	Start_t = "Start"

static const std::string	End_t = "End"

static const std::string	Comment_t = "Comment"

static const std::string	Encoding_t = "Encoding"

static const std::string	Input_t = "Inputs"

static const std::string	Error_t = "Error"

static const std::string	Message_t = "Message"

static const std::string	Code_t = "Code"

static const std::string	Provenance_t = "Provenance"

static const std::string	Info_t = "Info"

static const std::string	Configuration_t = "Configuration"

static const std::string	Arguments_t = "Arguments"

static const std::string	Inputs_t = "Inputs"

static const std::string	UUID_t = "UUID"

static const std::string	APIVersion_t = "APIVersion"

static const std::string	Type_t = "Type"

static const std::string	Test_t = "Test"

static const std::string	Tests_t = "Tests"

static const std::string	Data_t = "Data"

static const std::string	URL_t = "URL"

static const std::string	Name_t = "Name"

static const std::string	Unit_t = "Unit"

static const std::string	Values_t = "Values"

static const std::string	Parameters_t = "Parameters"

static const std::string	RunNumber_t = "RUN_NUMBER"

static const std::string	PMTT0s_t = "PMTT0s"

static const std::string	PMTSupplyVoltage_t = "PMT_Supply_Voltage"

static const std::string	PMTThreshold_t = "PMT_Threshold"

static const std::string	DOMPositions_t = "DOMPositions"

static const std::string	DOMRotations_t = "DOMRotations"

static const std::string	PMTGain_t = "PMT_Gain"

static const std::string	UPI_t = "UPI"

static const std::string	PBS_t = "PBS"

static const std::string	Variant_t = "Variant"

static const std::string	PMTSerial_t = "PMTSerial"

static const std::string	DOMSerial_t = "DOMSerial"

static const std::string	DOMId_t = "DOMId"

static const std::string	T0_t = "T0"

static const std::string	PX_t = "PX"

static const std::string	PY_t = "PY"

static const std::string	PZ_t = "PZ"

static const std::string	Q0_t = "Q0"

static const std::string	QX_t = "QX"

static const std::string	QY_t = "QY"

static const std::string	QZ_t = "QZ"

static const std::string	Unitless_t = "-"

static const std::string	Volt_t = "V"

static const std::string	Result_t = "Result"

static const std::string	OK_t = "OK"

static const std::string	Fail_t = "FAIL"

static const double	ORCA_TBARZ_M = 0.91
	ORCA T-bar position relative to seabed [m]. More...

static const double	ARCA_TBARZ_M = 0.95
	ORCA T-bar position relative to seabed [m]. More...

static const char *const	GENDET_DETECTOR_FILE_FORMAT = "det"
	File name extensions. More...

static const char *const	BINARY_DETECTOR_FILE_FORMAT [] = { "dat", "datx" }
	JIO binary file format. More...

static const char *const	KM3NET_DETECTOR_FILE_FORMAT = "detx"
	KM3NeT standard ASCII format More...

static const char *const	ZIPPED_DETECTOR_FILE_FORMAT = "gz"
	zipped KM3NeT standard ASCII format More...

static const char *const	GDML_DETECTOR_FILE_FORMAT = "gdml"
	KM3Sim input format. More...

static const char *const	GDML_SCHEMA = getenv("GDML_SCHEMA_DIR")
	directory necessary for correct GDML header output More...

static const char *const	CAN_MARGIN_M = getenv("CAN_MARGIN_M")
	extension of the detector size to comply with the can definition More...

static const char *const	G4GDML_DEFAULT_SCHEMALOCATION = "http://service-spi.web.cern.ch/service-spi/app/releases/GDML/schema/gdml.xsd"

static JRotation	getRotation
	Function object to get rotation matrix to go from first to second module. More...

static const JGetDetectorVersion	getDetectorVersion
	Function object to map detector version to numerical value. More...

static const JPutDetectorVersion	putDetectorVersion (getDetectorVersion)
	Function object to map numerical value to detector version. More...

static const JGetModuleStatusBit	getModuleStatusBit
	Function object to map key to module status bit. More...

static const JPutModuleStatusBit	putModuleStatusBit (getModuleStatusBit)
	Function object to map module status bit to key. More...

static const double	PIEZO_DELAYTIME_US = 170.0
	Piezo delay time [us]. More...

static const double	HYDROPHONE_DELAYTIME_US = 50.0
	Hydrophone delay time [us]. More...

static const int	LED_BEACON_PMT_TYPE = 2
	PMT type of LED beacon. More...

static const JGetPMTStatusBit	getPMTStatusBit
	Function object to map key to PMT status bit. More...

static const JPutPMTStatusBit	putPMTStatusBit (getPMTStatusBit)
	Function object to map PMT status bit to key. More...

const JTransitionTimeGenerator38	p38

const JTransitionTimeGenerator41	p41

	getTransitionTime
	Function object to generate transition time. More...

	getTransitionTimeProbability
	Function object of transition time prabability. More...

static const JTransitionTimeProbability2D	getTransitionTimeProbability2D
	Function object of twofold transition time prabability. More...

static const JStringCounter	getNumberOfStrings
	Function object to count unique strings. More...

Detailed Description

Auxiliary classes and methods for detector calibration.

Auxiliary classes and methods for detector calibration and simulation.

Author: mdejong

Typedef Documentation

typedef JPMTData<JPMTPulse> JDETECTOR::JPMTOutput

Type definition of PMT base output.

Definition at line 27 of file JCLBSimulator.hh.

typedef JTYPELIST<JPPM_DU_t, JKM3NeT_t, JMonteCarlo_t>::typelist JDETECTOR::JDetectorTypes_t

Type list of KM3NeT detector types.

Definition at line 43 of file JDetectorAddressMapToolkit.hh.

typedef std::vector<JHVCalibration_t> JDETECTOR::JHVCalibration

PMT high voltage calibration.

Definition at line 579 of file JDetectorCalibration.hh.

typedef std::vector<JPMTThresholdCalibration_t> JDETECTOR::JPMTThresholdCalibration

PMT threshold calibration.

Definition at line 580 of file JDetectorCalibration.hh.

typedef std::vector<JPMTCalibration_t> JDETECTOR::JPMTCalibration

PMT time calibration.

Definition at line 581 of file JDetectorCalibration.hh.

typedef std::vector<JModulePosition_t> JDETECTOR::JModulePosition

Module position.

Definition at line 582 of file JDetectorCalibration.hh.

typedef std::vector<JModuleRotation_t> JDETECTOR::JModuleRotation

Module rotation.

Definition at line 583 of file JDetectorCalibration.hh.

typedef JLANG::JObjectID JDETECTOR::JDetectorID

Type definition of detector identifier.

Definition at line 19 of file JDetectorID.hh.

typedef JTOOLS::JRange<int> JDETECTOR::floor_range

Type definition for range of floors.

Definition at line 424 of file JDetectorToolkit.hh.

typedef JLANG::JComparator<double (JVector3D::*)() const> JDETECTOR::JModuleComparator

Type definition of a module comparator using 3D position information.

Definition at line 22 of file JModuleComparator.hh.

typedef JLANG::JObjectID JDETECTOR::JModuleIdentifier

Definition at line 16 of file JModuleIdentifier.hh.

typedef JPutStatusBit JDETECTOR::JPutModuleStatusBit

Type definition to map module status bit to key.

Definition at line 58 of file JModuleStatus.hh.

typedef std::map<JPMTIdentifier, JPMTParameters> JDETECTOR::JPMTParametersMap_t

Type definition of map PMT identifier to PMT parameters.

Definition at line 47 of file JPMTParametersMap.hh.

typedef JPutStatusBit JDETECTOR::JPutPMTStatusBit

Type definition to map PMT status bit to key.

Definition at line 59 of file JPMTStatus.hh.

Function Documentation

bool JDETECTOR::operator<	(	const JAnchor &	first,
		const JAnchor &	second
	)

inline

Sort anchors in ascending distance from (0,0).

Parameters

first	first anchor
second	second anchor

Returns: true if first anchor closer to (0,0); else false

Definition at line 99 of file JAnchor.hh.

   {
     return first.getLengthSquared() < second.getLengthSquared();
   }

template<class T >

double JDETECTOR::getTime	(	const T &	t1,
		const JCalibration &	cal
	)

inline

Get calibrated time.

Parameters

t1	time [ns]
cal	calibration

Returns: time [ns]

Definition at line 222 of file JDetector/JCalibration.hh.

   {
     return JCalibrator<T>::getTime(t1, cal);
   }

template<class T >

double JDETECTOR::putTime	(	const T &	t1,
		const JCalibration &	cal
	)

inline

Get de-calibrated time.

Parameters

t1	time [ns]
cal	calibration

Returns: time [ns]

Definition at line 236 of file JDetector/JCalibration.hh.

   {
     return JCalibrator<T>::putTime(t1, cal);
   }

template<class T >

double JDETECTOR::getToT	(	const T &	tot,
		const JCalibration &	cal
	)

inline

Get calibrated time-over-threshold of hit.

Parameters

tot	time-over-threshold [ns]
cal	calibration

Returns: time-over-threshold [ns]

Definition at line 250 of file JDetector/JCalibration.hh.

   {
     return JCalibrator<T>::getToT(tot, cal);
   }

template<class T >

double JDETECTOR::putToT	(	const T &	tot,
		const JCalibration &	cal
	)

inline

Get de-calibrated time-over-threshold of hit.

Parameters

tot	time-over-threshold [ns]
cal	calibration

Returns: time-over-threshold [ns]

Definition at line 264 of file JDetector/JCalibration.hh.

   {
     return JCalibrator<T>::putToT(tot, cal);
   }

bool JDETECTOR::hasDetector	(	JType< JPPM_DU_t >	type,
		const int	id
	)

inline

Check validity of detector identifier.

Parameters

type	detector type
id	detector identifier

Returns: true if valid match; else false

Definition at line 53 of file JDetectorAddressMapToolkit.hh.

53 { return id == 1; }

bool JDETECTOR::hasDetector	(	JType< JKM3NeT_t >	type,
		const int	id
	)

inline

Definition at line 54 of file JDetectorAddressMapToolkit.hh.

54 { return id >= 2 && id <= 2000000000; }

bool JDETECTOR::hasDetector	(	JType< JMonteCarlo_t >	type,
		const int	id
	)

inline

Definition at line 55 of file JDetectorAddressMapToolkit.hh.

55 { return id >= -2000000000 && id <= -2; }

template<class JDetector_t >

JDetectorAddressMap& JDETECTOR::getDetectorAddressMap ( )

inline

Get detector address map.

Returns: detector address map

Definition at line 364 of file JDetectorAddressMapToolkit.hh.

   {
     static JTemplateDetectorAddressMap<JDetector_t> demo;
 
     return demo;
   }

template<class JDetector_t >

JModuleAddressMap& JDETECTOR::getModuleAddressMap ( int id )

inline

Get module address map.

Parameters

id	module identifier

Returns: module address map

Definition at line 379 of file JDetectorAddressMapToolkit.hh.

   {
     return getDetectorAddressMap<JDetector_t>().get(id);
   }

template<class JDetector_t >

const JPMTAddressTranslator& JDETECTOR::getPMTAddressTranslator	(	int	id,
		int	tdc
	)

inline

Get PMT address translator for given module identifier and TDC channel.

Parameters

id	module identifier
tdc	TDC

Returns: PMT address translator

Definition at line 393 of file JDetectorAddressMapToolkit.hh.

   {
     return getModuleAddressMap<JDetector_t>(id).getAddressTranslator(tdc);
   }

template<class JDetector_t >

int JDETECTOR::getPMTLogicalIndex	(	int	id,
		int	tdc
	)

inline

Get PMT logical index for given module identifier and TDC channel.

Parameters

id	module identifier
tdc	TDC

Returns: PMT logical index

Definition at line 407 of file JDetectorAddressMapToolkit.hh.

   {
     return getModuleAddressMap<JDetector_t>(id).getIndex(tdc);
   }

JDetectorAddressMap& JDETECTOR::getDetectorAddressMap ( const int id )

inline

Get detector address map.

Parameters

id	detector identifier

Returns: detector address map

Definition at line 488 of file JDetectorAddressMapToolkit.hh.

   {
     return JDetectorAddressMap_t<JDetectorTypes_t>::get(id);
   }

bool JDETECTOR::hasDetectorAddressMap ( const int id )

inline

Check if detector address map is available.

Parameters

id	detector identifier

Returns: true if detector address map available; else false

Definition at line 500 of file JDetectorAddressMapToolkit.hh.

   {
     return JDetectorAddressMap_t<JDetectorTypes_t>::has(id);
   }

bool JDETECTOR::is_valid ( const json & js )

inline

Check validity of JSon data.

Parameters

js JSon data

Returns: true if valid; else false

Definition at line 123 of file JDetectorCalibration.hh.

   {
     return js.contains(Result_t)  &&  js[Result_t] == OK_t;
   }

template<class T >

std::vector<std::string> JDETECTOR::get_string_array ( T value )

inline

Cast single value to array of strings, conform the DB-format.

Parameters

value value

Returns: std::vector containing value casted to string

Definition at line 136 of file JDetectorCalibration.hh.

   {
     using namespace std;
     
     return vector<string>{ to_string(value) };
   }

double JDETECTOR::retrieve_value ( std::vector< std::string > string_value_array )

inline

Retrieve value from json array of strings.

Parameters

string_value_array array of string-casted values

Returns: double-casted value

Definition at line 150 of file JDetectorCalibration.hh.

   {
     return std::stod(string_value_array[0]);
   }

void JDETECTOR::to_json	(	json &	js,
		const JPMTCalibration_t &	object
	)

inline

Convert PMT time calibration to JSon.

Parameters

js	json
object	PMT time calibration

Definition at line 190 of file JDetectorCalibration.hh.

   {
     js = json{ { PMTSerial_t, object.getID() },
                { T0_t,        object.getT0() } };
   }

void JDETECTOR::from_json	(	const json &	js,
		JPMTCalibration_t &	object
	)

inline

Convert JSon to PMT time calibration.

Parameters

js	json
object	PMT time calibration

Definition at line 203 of file JDetectorCalibration.hh.

   {
     object.setID(js.at(PMTSerial_t).get<int>());
 
     object.setT0(js.at(T0_t).get<double>());
   }

void JDETECTOR::to_json	(	json &	js,
		const JHVCalibration_t &	object
	)

inline

Convert PMT high-voltage calibration to JSon.

Parameters

js	json2
object	PMT high-voltage calibration

Definition at line 301 of file JDetectorCalibration.hh.

   {
     using namespace std;
     
     ostringstream os;
 
     os << object.getUPI();
 
     js[UPI_t]                      = os.str();
     js[Test_t + Result_t]          = object.result;
     js[Test_t + Parameters_t][0]   = json{ { Name_t,   PMTSupplyVoltage_t                     },
                                            { Unit_t,   Volt_t                                 },
                                            { Values_t, get_string_array(object.supplyVoltage) } };
 
     static const int version = JHVCalibration_t::getVersion();
     
     if (version < 2) {
       
       js[Test_t + Parameters_t][2] = json{ { Name_t,   PMTGain_t                              },
                                            { Unit_t,   Unitless_t                             },
                                            { Values_t, get_string_array(object.PMTgain)       } };
     }
 
     
     if (version < 3) {
 
       vector<string> runNumberList;
       
       for (vector<int>::const_iterator i = object.runNumbers.cbegin(); i != object.runNumbers.cend(); ++i) {
         runNumberList.push_back(to_string(*i));
       }
  
       js[Test_t + Parameters_t][1] = json{ { Name_t,   RunNumber_t                            },
                                            { Unit_t,   Unitless_t                             },
                                            { Values_t, runNumberList                          } };
     }
   }

void JDETECTOR::from_json	(	const json &	js,
		JHVCalibration_t &	object
	)

inline

Convert JSon to PMT high-voltage calibration.

Parameters

js	json
object	PMT high-voltage calibration

Definition at line 346 of file JDetectorCalibration.hh.

   {
     using namespace std;
     
     stringstream is(js.at(UPI_t).get<string>());
 
     is >> static_cast<JUPI_t&>(object);
     
     json parameters = js.at(Test_t + Parameters_t);
 
     if (JHVCalibration_t::getVersion() > 0 && parameters.size() > 0) {
       
       object.result        = js.at(Test_t + Result_t).get<string>();
       object.supplyVoltage = retrieve_value(parameters[0].at(Values_t).get<vector<string>>());
 
       if (JHVCalibration_t::getVersion() < 3 && parameters.size() > 1) {
       
         vector<string> runNumberList = parameters[1].at(Values_t).get<vector<string>>();
       
         for (vector<string>::const_iterator i = runNumberList.begin(); i != runNumberList.end(); ++i) {
           object.runNumbers.push_back(stoi(*i));
         }
       }
     
       if (JHVCalibration_t::getVersion() < 2 && parameters.size() > 2) {
         object.PMTgain = retrieve_value(parameters[2].at(Values_t).get<vector<string>>());
       }
       
     } else {
       
       THROW(JValueOutOfRange, "JHVCalibration_t::from_json(): No " << MAKE_STRING(Test_t + Parameters_t) << " found." << endl);
     }
   }

void JDETECTOR::to_json	(	json &	js,
		const JPMTThresholdCalibration_t &	object
	)

inline

Convert PMT threshold calibration to JSon.

Parameters

js	json
object	PMT threshold calibration

Definition at line 423 of file JDetectorCalibration.hh.

   {
     std::ostringstream os;
 
     os << object.getUPI();
 
     js[UPI_t]                    = os.str();
     js[Test_t + Result_t]        = object.result;
     js[Test_t + Parameters_t][0] = json{ { Name_t,   PMTThreshold_t                        },
                                          { Unit_t,   Unitless_t                            },
                                          { Values_t, get_string_array(object.threshold)    } };
     js[Test_t + Parameters_t][2] = json{ { Name_t,   RunNumber_t                           },
                                          { Unit_t,   Unitless_t                            },
                                          { Values_t, object.runNumberList                  } };
   }

void JDETECTOR::from_json	(	const json &	js,
		JPMTThresholdCalibration_t &	object
	)

inline

Convert JSon to PMT threshold calibration.

Parameters

js	json
object	PMT threshold calibration

Definition at line 446 of file JDetectorCalibration.hh.

   {
     using namespace std;
 
     stringstream is(js.at(UPI_t).get<string>());
 
     is >> static_cast<JUPI_t&>(object);
 
     object.result          = js.at(Test_t + Result_t).get<string>();
     object.threshold       = retrieve_value(js.at(Test_t + Parameters_t)[0].at(Values_t).get<vector<string>>());
     object.runNumberList   = js.at(Test_t + Parameters_t)[2].at(Values_t).get<vector<int>>();
   }

void JDETECTOR::to_json	(	json &	js,
		const JModulePosition_t &	object
	)

inline

Convert module position to JSon.

Parameters

js	json
object	module position

Definition at line 494 of file JDetectorCalibration.hh.

   {
     js = json{ { DOMId_t, object.getID() },
                { PX_t,    object.getX()  },
                { PY_t,    object.getY()  },
                { PZ_t,    object.getZ()  } };
   }

void JDETECTOR::from_json	(	const json &	js,
		JModulePosition_t &	object
	)

inline

Convert JSon to module position.

Parameters

js	json
object	module position

Definition at line 509 of file JDetectorCalibration.hh.

   {
     object.setID(js.at(DOMId_t).get<int>());
 
     object.setPosition(JPosition3D(js.at(PX_t).get<double>(),
                                    js.at(PY_t).get<double>(),
                                    js.at(PZ_t).get<double>()));
   }

void JDETECTOR::to_json	(	json &	js,
		const JModuleRotation_t &	object
	)

inline

Convert module rotation to JSon.

Parameters

js	json
object	module rotation

Definition at line 552 of file JDetectorCalibration.hh.

   {
     js = json{ { DOMId_t, object.getID() },
                { Q0_t,    object.getA()  },
                { QX_t,    object.getB()  },
                { QY_t,    object.getC()  },
                { QZ_t,    object.getD()  } };
   }

void JDETECTOR::from_json	(	const json &	js,
		JModuleRotation_t &	object
	)

inline

Convert JSon to module rotation.

Parameters

js	json
object	module rotation

Definition at line 568 of file JDetectorCalibration.hh.

   {
     object.setID(js.at(DOMId_t).get<int>());
 
     object.setQuaternion(JQuaternion3D(js.at(Q0_t).get<double>(),
                                        js.at(QX_t).get<double>(),
                                        js.at(QY_t).get<double>(),
                                        js.at(QZ_t).get<double>()));
   }

JUTMGrid JDETECTOR::getARCAUTMGrid ( )

inline

Get UTM grid for ARCA.

Returns: UTM grid

Definition at line 252 of file JDetectorHeader.hh.

   {
     return JUTMGrid("UTM", "WGS84", "33N");
   }

JUTMGrid JDETECTOR::getORCAUTMGrid ( )

inline

Get UTM grid for ORCA.

Returns: UTM grid

Definition at line 263 of file JDetectorHeader.hh.

   {
     return JUTMGrid("UTM", "WGS84", "32N");
   }

JDetectorHeader JDETECTOR::getARCADetectorHeader ( )

inline

Get detector header for ARCA.

Returns: detector header

Definition at line 274 of file JDetectorHeader.hh.

   {
     return JDetectorHeader(JUTCTimeRange(0.0, 999999999999.9), getARCAUTMGrid(), JUTMPosition(587600, 4016800, -3450));
   }

JDetectorHeader JDETECTOR::getORCADetectorHeader ( )

inline

Get detector header for ORCA.

Returns: detector header

Definition at line 285 of file JDetectorHeader.hh.

   {
     return JDetectorHeader(JUTCTimeRange(0.0, 999999999999.9), getORCAUTMGrid(), JUTMPosition(256500, 4743000, -2440));
   }

bool JDETECTOR::isARCADetector ( const JDetectorHeader & header )

inline

Check if given detector header is compatible with tat of ARCA.

Parameters

header header

Returns: true if ARCA; else false

Definition at line 297 of file JDetectorHeader.hh.

   {
     return header.getUTMGrid() == getARCADetectorHeader();
   }

bool JDETECTOR::isORCADetector ( const JDetectorHeader & header )

inline

Check if given detector header is compatible with that of ORCA.

Parameters

header header

Returns: true if ORCA; else false

Definition at line 309 of file JDetectorHeader.hh.

   {
     return header.getUTMGrid() == getORCADetectorHeader();
   }

double JDETECTOR::getMaximalDistance ( const JDetector & detector )

inline

Get maximal distance between modules in detector.

Parameters

detector detector

Returns: maximal distance [m]

Definition at line 78 of file JDetectorToolkit.hh.

   {
     using namespace JPP;
 
     double dmax = 0.0;
     
     for (JDetector::const_iterator i = detector.begin(); i != detector.end(); ++i) {
       for (JDetector::const_iterator j = detector.begin(); j != i; ++j) {
         if (getDistance(i->getPosition(), j->getPosition()) > dmax) {
           dmax = getDistance(i->getPosition(), j->getPosition());
         }
       }
     }
     
     return dmax;
   }

double JDETECTOR::GetXrotationG4 ( const JVersor3D dir )

inline

Get rotation over X axis in Geant4 coordinate system.

Parameters

dir direction

Returns: X-rotation [deg]

Definition at line 102 of file JDetectorToolkit.hh.

   {
     using namespace JPP;
 
     const double phi = atan2(dir.getDY(), dir.getDZ())*(180.0/PI);
 
     if (phi < 0.0){
       return phi + 360.0;
     }
     else{
       return phi;       
     }
   }

double JDETECTOR::GetYrotationG4 ( const JVersor3D dir )

inline

Get rotation over Y axis in Geant4 coordinate system.

Parameters

dir direction

Returns: Y-rotation [deg]

Definition at line 123 of file JDetectorToolkit.hh.

   {
     using namespace JPP;
 
     return asin(-dir.getDX())*(180.0/PI);
   }

void JDETECTOR::read_gdml	(	std::istream &	,
		JDetector &
	)

inline

Definition at line 131 of file JDetectorToolkit.hh.

   {
     THROW(JException, "Operation not defined.");
   }

void JDETECTOR::write_gdml	(	std::ostream &	out,
		const JDetector &	detector
	)

inline

Writes KM3Sim GDML input file from detector.

Parameters

out	output stream
detector	detector

Definition at line 143 of file JDetectorToolkit.hh.

   {
     using namespace std;
     using namespace JPP;
 
     const double DEFAULT_CAN_MARGIN_M   = 350.0;  // default can   margin [m]
     const double DEFAULT_WORLD_MARGIN_M =  50.0;  // default world margin [m]
 
     const JCylinder3D cylinder(detector.begin(), detector.end());
 
     double can_margin;
 
     if (CAN_MARGIN_M) {
       can_margin = atof(CAN_MARGIN_M);
     } else {
       cerr << "CAN_MARGIN_M not defined! Setting standard CAN_MARGIN_M " << DEFAULT_CAN_MARGIN_M << " m." << endl;
       can_margin = DEFAULT_CAN_MARGIN_M; //this is given in meters like all the dimensions in the GDML file (look at the unit field of every position and solid definition)
     }
 
     const double WorldCylinderHeight = 2*(cylinder.getZmax() - cylinder.getZmin() + can_margin + DEFAULT_WORLD_MARGIN_M);
     const double WorldRadius         = cylinder.getLength() + cylinder.getRadius() + can_margin + DEFAULT_WORLD_MARGIN_M;
 
     const double Crust_Z_size     =  WorldCylinderHeight/2;
     const double Crust_Z_position = -WorldCylinderHeight/4;                     
 
     out << "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<gdml xmlns:gdml=\"http://cern.ch/2001/Schemas/GDML\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"";
     if (!GDML_SCHEMA) {
       cerr << "GDML_SCHEMA_DIR NOT DEFINED! Setting default path." << endl;
       out << G4GDML_DEFAULT_SCHEMALOCATION << "\">\n\n\n";
     } else {
       out << GDML_SCHEMA << "gdml.xsd\">\n\n\n";
     }
     out << "<!-- Jpp version: "<< getGITVersion() << " -->\n";
     out << "<define>\n";
     out << "<rotation name=\"identity\"/>\n<position name=\"zero\"/>\n";
 
     int PMTs_NO = 0;
 
     for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
                         
       if (module->getFloor() != 0) {
 
         const JVector3D center = module->getCenter();
 
         out << "<position name=\"PosString" << module->getString() << "_Dom" << module->getID() << "\" unit=\"m\" x=\"" << module->getX() << "\" y=\"" << module->getY() << "\" z=\"" << module->getZ() << "\"/>\n";
                                         
         for (JModule::const_iterator pmt = module->begin(); pmt != module->end(); ++pmt) {
                                 
           const JVector3D vec = static_cast<JVector3D>(*pmt).sub(center);
           out << "<position name=\"CathodPosition" << pmt->getID() << "_" << module->getID() << "\" unit=\"m\" x=\"" << vec.getX() << "\" y=\"" << vec.getY() << "\" z=\"" << vec.getZ() << "\"/>\n";
           out << "<rotation name=\"CathodRotation" << pmt->getID() << "_" << module->getID() << "\" unit=\"deg\" x=\"" << GetXrotationG4(*pmt) << "\" y=\"" << GetYrotationG4(*pmt) << "\" z=\"0.000000\"/>\n";
           out << "<constant name=\"CathodID_" << PMTs_NO << "\" value=\"" << pmt->getID() << "\"/>\n";
           PMTs_NO++;
         }
       }
     }
 
     out << "<position name=\"OMShift\" unit=\"m\" x=\"0\" y=\"0\" z=\"0.0392\"/>\n";
     out << "\n\n\n";
     out << "<!-- end of DU position definitions -->\n<position name=\"CrustPosition\"   unit=\"m\" x=\"0\" y=\"0\" z=\"" << Crust_Z_position << "\"/>\n";
                 
     out << "</define>\n";
     out << "<materials>\n";
     out << "</materials>\n";
     out << "<solids>\n";
     out << "    <box name=\"CrustBox\" lunit=\"m\" x=\"2200\" y=\"2200\" z=\"" << Crust_Z_size << "\"/>\n";
     out << "    <box name=\"StoreyBox\" lunit=\"m\" x=\"0.6\" y=\"0.6\" z=\"0.6\"/>\n";
     out << "    <sphere name=\"OMSphere\" lunit=\"cm\" aunit=\"deg\" rmin=\"0.0\" rmax=\"21.6\" startphi=\"0.0\" deltaphi=\"360.0\" starttheta=\"0.0\" deltatheta=\"180.0\"/>\n";
     out << "    <tube name=\"CathodTube\" lunit=\"cm\" aunit=\"deg\" rmin=\"0.0\" rmax=\"4.7462\" z=\"0.5\" startphi=\"0.0\" deltaphi=\"360.0\"/>\n";
     out << "    <tube name=\"WorldTube\" lunit=\"m\" aunit=\"deg\" rmin=\"0.0\" rmax=\"" << WorldRadius << "\" z=\"" << WorldCylinderHeight << "\" startphi=\"0.0\" deltaphi=\"360.0\"/>\n";    
     out << "</solids>\n\n\n";
                 
     out << "<structure>\n";
     out << "    <volume name=\"CathodVolume\">\n";
     out << "            <materialref ref=\"Cathod\"/>\n";
     out << "            <solidref ref=\"CathodTube\"/>\n";
     out << "    </volume>\n";
 
     out << "<!-- OMVolume(s) construction -->\n";
 
     for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
 
       out << "  <volume name=\"OMVolume" << module->getID() << "\">\n";
       out << "          <materialref ref=\"Water\"/>\n";
       out << "          <solidref ref=\"OMSphere\"/>\n";
 
       for (JModule::const_iterator pmt = module->begin(); pmt != module->end(); ++pmt) {
         out << "                <physvol>\n";
         out << "                        <volumeref ref=\"CathodVolume\"/>\n";
         out << "                        <positionref ref=\"CathodPosition" << pmt->getID() << "_" << module->getID() << "\"/>\n";
         out << "                        <rotationref ref=\"CathodRotation" << pmt->getID() << "_" << module->getID() << "\"/>\n";
         out << "                </physvol>\n";
       }
 
       out << "  </volume>\n";
     }
 
     out << "<!-- StoreyVolume(s) construction -->\n";
 
     for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
       out << "  <volume name=\"StoreyVolume" << module->getID() << "\">\n";
       out << "          <materialref ref=\"Water\"/>\n";
       out << "          <solidref ref=\"StoreyBox\"/>\n";
       out << "          <physvol>\n";
       out << "                  <volumeref ref=\"OMVolume" << module->getID() << "\"/>\n";
       out << "                  <positionref ref=\"OMShift\"/>\n";
       out << "                  <rotationref ref=\"identity\"/>\n";
       out << "          </physvol>\n";
       out << "  </volume>\n";
     }
 
     out << "<!-- Crust Volume construction-->\n";
     out << "<volume name=\"CrustVolume\">\n";
     out << "    <materialref ref=\"Crust\"/>\n";
     out << "    <solidref ref=\"CrustBox\"/>\n";
     out << "</volume>\n";
 
     out << "<!-- World Volume construction-->\n";
     out << "<volume name=\"WorldVolume\">\n";
     out << "    <materialref ref=\"Water\"/>\n";
     out << "    <solidref ref=\"WorldTube\"/>\n";
 
     out << "    <physvol>\n";
     out << "            <volumeref ref=\"CrustVolume\"/>\n";
     out << "            <positionref ref=\"CrustPosition\"/>\n";
     out << "            <rotationref ref=\"identity\"/>\n";
     out << "    </physvol>\n";
 
     for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
       out << "  <physvol>\n";
       out << "          <volumeref ref=\"StoreyVolume" << module->getID() << "\"/>\n";
       out << "          <positionref ref=\"PosString" <<  module->getString()  << "_Dom" <<  module->getID()  << "\"/>\n";
       out << "                  <rotationref ref=\"identity\"/>\n";
       out << "  </physvol>\n";  
     }
 
     out << "</volume>\n";
 
     out << "</structure>\n";
     out << "<setup name=\"Default\" version=\"1.0\">\n";
     out << "<world ref=\"WorldVolume\"/>\n";
     out << "</setup>\n";
     out << "</gdml>\n";
   }

double JDETECTOR::getMaximalTime ( const JDetector & detector )

inline

Get maximal time between modules in detector following causality.

Parameters

detector detector

Returns: maximal time [ns]

Definition at line 295 of file JDetectorToolkit.hh.

   {
     using namespace JPP;
 
     return getMaximalDistance(detector) * getIndexOfRefraction() * getInverseSpeedOfLight();
   }

double JDETECTOR::getMaximalTime	(	const JDetector &	detector,
		const double	roadWidth_m
	)

inline

Get maximal time between modules in detector following causality.

The road width corresponds to the maximal distance traveled by the light.

Parameters

detector	detector
roadWidth_m	road width [m]

Returns: maximal time [ns]

Definition at line 311 of file JDetectorToolkit.hh.

   {
     using namespace JPP;
 
     const double Dmax_m = getMaximalDistance(detector);
 
     return (sqrt((Dmax_m + roadWidth_m*getSinThetaC()) * 
                  (Dmax_m - roadWidth_m*getSinThetaC()))  +  
             roadWidth_m * getSinThetaC() * getTanThetaC()) * getInverseSpeedOfLight();
   }

JTimeRange JDETECTOR::getTimeRange	(	const JTimeRange &	timeRange,
		const JModule &	module
	)

inline

Get de-calibrated time range.

The de-calibrated time range is corrected for minimal and maximal time offset of PMTs in given module.

Parameters

timeRange	time range [ns]
module	module

Returns: time range [ns]

Definition at line 332 of file JDetectorToolkit.hh.

   {
     if (!module.empty()) {
 
       JTimeRange time_range(JTimeRange::DEFAULT_RANGE);
       
       for (JModule::const_iterator pmt = module.begin(); pmt != module.end(); ++pmt) {
         
         const JCalibration& calibration = pmt->getCalibration();
         
         time_range.include(putTime(timeRange.getLowerLimit(), calibration));
         time_range.include(putTime(timeRange.getUpperLimit(), calibration));
       }
       
       return time_range;
 
     } else {
       
       return timeRange;
     }
   }

int JDETECTOR::getNumberOfPMTs ( const JModule & module )

inline

Get number of PMTs.

Parameters

module module

Returns: number of PMTs

Definition at line 361 of file JDetectorToolkit.hh.

   {
     return module.size();
   }

int JDETECTOR::getNumberOfPMTs ( const JDetector & detector )

inline

Get number of PMTs.

Parameters

detector detector

Returns: number of PMTs

Definition at line 373 of file JDetectorToolkit.hh.

   {
     int number_of_pmts = 0;
     
     for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
       number_of_pmts += getNumberOfPMTs(*module);
     }
 
     return number_of_pmts;
   }

std::set<int> JDETECTOR::getStringIDs ( const JDetector & detector )

inline

Get list of strings identifiers.

Parameters

detector detector

Returns: list of string identifiers

Definition at line 391 of file JDetectorToolkit.hh.

   {
     std::set<int> buffer;
     
     for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
       buffer.insert(module->getString());
     }
 
     return buffer;
   }

int JDETECTOR::getNumberOfFloors ( const JDetector & detector )

inline

Get number of floors.

Parameters

detector detector

Returns: number of floors

Definition at line 409 of file JDetectorToolkit.hh.

   {
     std::set<int> buffer;
     
     for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
       buffer.insert(module->getFloor());
     }
 
     return buffer.size();
   }

floor_range JDETECTOR::getRangeOfFloors ( const JDetector & detector )

inline

Get range of floors.

Parameters

detector detector

Returns: range of floors

Definition at line 433 of file JDetectorToolkit.hh.

   {
     floor_range buffer = floor_range::DEFAULT_RANGE;
     
     for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
       buffer.include(module->getFloor());
     }
 
     return buffer;
   }

int JDETECTOR::getNumberOfModules ( const JDetector & detector )

inline

Get number of modules.

Parameters

detector detector

Returns: number of modules

Definition at line 451 of file JDetectorToolkit.hh.

   {
     std::set<int> buffer;
     
     for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
       buffer.insert(module->getID());
     }
 
     return buffer.size();
   }

void JDETECTOR::load	(	const std::string &	file_name,
		JDetector &	detector
	)

inline

Load detector from input file.

Supported file formats:

ASCII file, extension JDETECTOR::GENDET_DETECTOR_FILE_FORMAT, gendet format;
binary file, extension JDETECTOR::BINARY_DETECTOR_FILE_FORMAT, Jpp internal format;
ASCII file, extension JDETECTOR::KM3NET_DETECTOR_FILE_FORMAT, KM3NeT standard format;
gzipped file, extension JDETECTOR::ZIPPED_DETECTOR_FILE_FORMAT, KM3NeT standard format;

Parameters

file_name	file name
detector	detector

Definition at line 475 of file JDetectorToolkit.hh.

   {
     using namespace std;
     using namespace JPP;
     
     if        (getFilenameExtension(file_name) == GENDET_DETECTOR_FILE_FORMAT) {
 
       JMonteCarloDetector buffer(true);
 
       ifstream in(file_name.c_str());
 
       if (!in) {
         THROW(JFileOpenException, "File not opened: " << file_name);
       }
       
       in >> buffer;
 
       in.close();
 
       detector.swap(buffer);
 
     } else if (getFilenameExtension(file_name) == BINARY_DETECTOR_FILE_FORMAT[0] ||
                getFilenameExtension(file_name) == BINARY_DETECTOR_FILE_FORMAT[1]) {
 
       JFileStreamReader in(file_name.c_str());
 
       if (!in) {
         THROW(JFileOpenException, "File not opened: " << file_name);
       }
       
       try {
 
         detector.read(in);
 
       } catch(const exception& error) {
 
         // recovery procedure for old format of comments
 
         JDetector::setStartOfComment(JDetector::OLD_START_OF_COMMENT);
 
         in.clear();
         in.rewind();
 
         detector.read(in);
 
         JDetector::setStartOfComment(JDetector::NEW_START_OF_COMMENT);
       }
 
       in.close();
  
     } else if (getFilenameExtension(file_name) == KM3NET_DETECTOR_FILE_FORMAT) {
       
       ifstream in(file_name.c_str());
 
       if (!in) {
         THROW(JFileOpenException, "File not opened: " << file_name);
       }
 
       in >> detector;
 
       in.close();
 
     } else if (getFilenameExtension(file_name) == ZIPPED_DETECTOR_FILE_FORMAT) {
       
       igzstream in(file_name.c_str());
 
       if (!in) {
         THROW(JFileOpenException, "File not opened: " << file_name);
       }
       
       in >> detector;
 
       in.close();
 
     } else {
 
       THROW(JProtocolException, "Protocol not defined: " << file_name);
     }
   }

void JDETECTOR::store	(	const std::string &	file_name,
		const JDetector &	detector
	)

inline

Store detector to output file.

Supported file formats:

binary file, extension JDETECTOR::BINARY_DETECTOR_FILE_FORMAT, Jpp internal format;
ASCII file, extension JDETECTOR::KM3NET_DETECTOR_FILE_FORMAT, KM3NeT standard format;
gzipped file, extension JDETECTOR::ZIPPED_DETECTOR_FILE_FORMAT, KM3NeT standard format;
gdml file, extension JDETECTOR::GDML_DETECTOR_FILE_FORMAT, KM3Sim input format;

Parameters

file_name	file name
detector	detector

Definition at line 568 of file JDetectorToolkit.hh.

   {
     using namespace std;
     using namespace JPP;
     
     if        (getFilenameExtension(file_name) == BINARY_DETECTOR_FILE_FORMAT[1]) {
 
       JFileStreamWriter out(file_name.c_str());
 
       detector.write(out);
 
       out.close();
  
     } else if (getFilenameExtension(file_name) == KM3NET_DETECTOR_FILE_FORMAT) {
       
       std::ofstream out(file_name.c_str());
 
       out << detector;
 
       out.close();
 
     } else if (getFilenameExtension(file_name) == ZIPPED_DETECTOR_FILE_FORMAT) {
       
       ogzstream out(file_name.c_str());
 
       out << detector;
 
       out.close();
 
     } else if (getFilenameExtension(file_name) == GDML_DETECTOR_FILE_FORMAT) {
       
       std::ofstream out(file_name.c_str());
 
       write_gdml(out, detector);
 
       out.close();
 
     }  else {
 
       THROW(JProtocolException, "Protocol not defined: " << file_name);
     }
   }

const JModule& JDETECTOR::getModule	(	const JModuleAddressMap &	memo,
		const int	id = `-1`,
		const JLocation &	location = `JLocation()`
	)

inline

Get module according module address map.

Parameters

memo	module address map
id	module identifier
location	module location

Returns: module

Definition at line 620 of file JDetectorToolkit.hh.

   {
     static JModule module;
 
 
     module.setID(id);
 
     module.setLocation(location);
 
     module.resize(memo.size());
     
     if (memo.has( 0)) { module[memo[ 0].tdc] = JPMT( 1, JAxis3D(JVector3D(+0.000, +0.000, -0.200), JVersor3D(+0.000, +0.000, -1.000))); }
 
     if (memo.has( 1)) { module[memo[ 1].tdc] = JPMT( 2, JAxis3D(JVector3D(+0.000, +0.105, -0.170), JVersor3D(+0.000, +0.527, -0.850))); }
     if (memo.has( 2)) { module[memo[ 2].tdc] = JPMT( 3, JAxis3D(JVector3D(+0.091, +0.053, -0.170), JVersor3D(+0.456, +0.263, -0.850))); }
     if (memo.has( 3)) { module[memo[ 3].tdc] = JPMT( 4, JAxis3D(JVector3D(+0.091, -0.053, -0.170), JVersor3D(+0.456, -0.263, -0.850))); }
     if (memo.has( 4)) { module[memo[ 4].tdc] = JPMT( 5, JAxis3D(JVector3D(+0.000, -0.105, -0.170), JVersor3D(+0.000, -0.527, -0.850))); }
     if (memo.has( 5)) { module[memo[ 5].tdc] = JPMT( 6, JAxis3D(JVector3D(-0.091, -0.053, -0.170), JVersor3D(-0.456, -0.263, -0.850))); }
     if (memo.has( 6)) { module[memo[ 6].tdc] = JPMT( 7, JAxis3D(JVector3D(-0.091, +0.053, -0.170), JVersor3D(-0.456, +0.263, -0.850))); }
 
     if (memo.has( 7)) { module[memo[ 7].tdc] = JPMT( 8, JAxis3D(JVector3D(+0.083, +0.144, -0.111), JVersor3D(+0.416, +0.720, -0.555))); }
     if (memo.has( 8)) { module[memo[ 8].tdc] = JPMT( 9, JAxis3D(JVector3D(+0.166, +0.000, -0.111), JVersor3D(+0.832, +0.000, -0.555))); }
     if (memo.has( 9)) { module[memo[ 9].tdc] = JPMT(10, JAxis3D(JVector3D(+0.083, -0.144, -0.111), JVersor3D(+0.416, -0.720, -0.555))); }
     if (memo.has(10)) { module[memo[10].tdc] = JPMT(11, JAxis3D(JVector3D(-0.083, -0.144, -0.111), JVersor3D(-0.416, -0.720, -0.555))); }
     if (memo.has(11)) { module[memo[11].tdc] = JPMT(12, JAxis3D(JVector3D(-0.166, +0.000, -0.111), JVersor3D(-0.832, +0.000, -0.555))); }
     if (memo.has(12)) { module[memo[12].tdc] = JPMT(13, JAxis3D(JVector3D(-0.083, +0.144, -0.111), JVersor3D(-0.416, +0.720, -0.555))); }
 
     if (memo.has(13)) { module[memo[13].tdc] = JPMT(14, JAxis3D(JVector3D(+0.000, +0.191, -0.059), JVersor3D(+0.000, +0.955, -0.295))); }
     if (memo.has(14)) { module[memo[14].tdc] = JPMT(15, JAxis3D(JVector3D(+0.165, +0.096, -0.059), JVersor3D(+0.827, +0.478, -0.295))); }
     if (memo.has(15)) { module[memo[15].tdc] = JPMT(16, JAxis3D(JVector3D(+0.165, -0.096, -0.059), JVersor3D(+0.827, -0.478, -0.295))); }
     if (memo.has(16)) { module[memo[16].tdc] = JPMT(17, JAxis3D(JVector3D(+0.000, -0.191, -0.059), JVersor3D(+0.000, -0.955, -0.295))); }
     if (memo.has(17)) { module[memo[17].tdc] = JPMT(18, JAxis3D(JVector3D(-0.165, -0.096, -0.059), JVersor3D(-0.827, -0.478, -0.295))); }
     if (memo.has(18)) { module[memo[18].tdc] = JPMT(19, JAxis3D(JVector3D(-0.165, +0.096, -0.059), JVersor3D(-0.827, +0.478, -0.295))); }
 
     if (memo.has(19)) { module[memo[19].tdc] = JPMT(20, JAxis3D(JVector3D(+0.096, +0.165, +0.059), JVersor3D(+0.478, +0.827, +0.295))); }
     if (memo.has(20)) { module[memo[20].tdc] = JPMT(21, JAxis3D(JVector3D(+0.191, +0.000, +0.059), JVersor3D(+0.955, +0.000, +0.295))); }
     if (memo.has(21)) { module[memo[21].tdc] = JPMT(22, JAxis3D(JVector3D(+0.096, -0.165, +0.059), JVersor3D(+0.478, -0.827, +0.295))); }
     if (memo.has(22)) { module[memo[22].tdc] = JPMT(23, JAxis3D(JVector3D(-0.096, -0.165, +0.059), JVersor3D(-0.478, -0.827, +0.295))); }
     if (memo.has(23)) { module[memo[23].tdc] = JPMT(24, JAxis3D(JVector3D(-0.191, +0.000, +0.059), JVersor3D(-0.955, +0.000, +0.295))); }
     if (memo.has(24)) { module[memo[24].tdc] = JPMT(25, JAxis3D(JVector3D(-0.096, +0.165, +0.059), JVersor3D(-0.478, +0.827, +0.295))); }
 
     if (memo.has(25)) { module[memo[25].tdc] = JPMT(26, JAxis3D(JVector3D(+0.000, +0.166, +0.111), JVersor3D(+0.000, +0.832, +0.555))); }
     if (memo.has(26)) { module[memo[26].tdc] = JPMT(27, JAxis3D(JVector3D(+0.144, +0.083, +0.111), JVersor3D(+0.720, +0.416, +0.555))); }
     if (memo.has(27)) { module[memo[27].tdc] = JPMT(28, JAxis3D(JVector3D(+0.144, -0.083, +0.111), JVersor3D(+0.720, -0.416, +0.555))); }
     if (memo.has(28)) { module[memo[28].tdc] = JPMT(29, JAxis3D(JVector3D(+0.000, -0.166, +0.111), JVersor3D(+0.000, -0.832, +0.555))); }
     if (memo.has(29)) { module[memo[29].tdc] = JPMT(30, JAxis3D(JVector3D(-0.144, -0.083, +0.111), JVersor3D(-0.720, -0.416, +0.555))); }
     if (memo.has(30)) { module[memo[30].tdc] = JPMT(31, JAxis3D(JVector3D(-0.144, +0.083, +0.111), JVersor3D(-0.720, +0.416, +0.555))); }
 
     module.compile();
 
     return module;
   }

template<class JDetector_t >

const JModule& JDETECTOR::getModule	(	const JType< JDetector_t >	type,
		const int	id,
		const JLocation &	location = `JLocation()`
	)

inline

Get module according given detector type.

Parameters

type	detector type
id	module identifier
location	module location

Returns: module

Definition at line 685 of file JDetectorToolkit.hh.

   {
     return getModule(getModuleAddressMap<JDetector_t>(id), id, location);
   }

const JModule& JDETECTOR::getModule	(	const JType< JAntares_t >	type,
		const int	id,
		const JLocation &	location = `JLocation()`
	)

inline

Get module according Antares detector type.

Parameters

type	Antares detector type
id	module identifier
location	module location

Returns: module

Definition at line 701 of file JDetectorToolkit.hh.

   {
     static JModule module;
 
     module.setID(id);
 
     module.setLocation(location);
 
     if (module.empty()) {
 
       module.resize(3);
       
       const double R  = 0.5;           // [m]
       
       const double st = sin(0.75*PI);
       const double ct = cos(0.75*PI);
       
       for (int i = 0; i != 3; ++i) {
         
         const double phi = (2.0*PI*i) / 3.0;
         const double cp  = cos(phi);
         const double sp  = sin(phi);
         
         module[i] = JPMT(i, JAxis3D(JVector3D(R*st*cp, R*st*sp, R*ct), JVersor3D(st*cp, st*sp, ct)));
       }
     }
 
     return module;
   }

template<class JDetector_t >

const JModule& JDETECTOR::getModule	(	const int	id,
		const JLocation &	location = `JLocation()`
	)

inline

Get module according detector template.

Parameters

id	module identifier
location	module location

Returns: module

Definition at line 742 of file JDetectorToolkit.hh.

   {
     return getModule(JType<JDetector_t>(), id, location);
   }

JPosition3D JDETECTOR::getPosition	(	const JModule &	first,
		const JModule &	second
	)

inline

Get position to go from first to second module.

Parameters

first	first module
second	second module

Returns: position

Definition at line 883 of file JDetectorToolkit.hh.

   {
     return second.getPosition() - first.getPosition();
   }

JCalibration JDETECTOR::getCalibration	(	const JCalibration &	first,
		const JCalibration &	second
	)

inline

Get calibration to go from first to second calibration.

Parameters

first	first calibration
second	second calibration

Returns: calibration

Definition at line 896 of file JDetectorToolkit.hh.

   {
     return JCalibration(second.getT0() - first.getT0());
   }

std::vector<std::string> JDETECTOR::getDetectorVersions ( const JType< std::string > & type )

inline

Get detector versions.

Note that the order of the versions is descending.

Parameters

type type

Returns: versions

Definition at line 317 of file JDetectorVersion.hh.

   {
     return JLANG::make_array(putDetectorVersion.rbegin(), putDetectorVersion.rend(), &JPutDetectorVersion::value_type::second);
   }

std::vector<JDetectorVersion::JVersion_t> JDETECTOR::getDetectorVersions ( const JType< JDetectorVersion::JVersion_t > & type )

inline

Get detector versions.

Note that the order of the versions is descending.

Parameters

type type

Returns: numerical values

Definition at line 331 of file JDetectorVersion.hh.

   {
     return JLANG::make_array(putDetectorVersion.rbegin(), putDetectorVersion.rend(), &JPutDetectorVersion::value_type::first);
   }

template<class T >

std::vector<T> JDETECTOR::getDetectorVersions ( )

inline

Get detector versions.

Returns: versions

Definition at line 343 of file JDetectorVersion.hh.

   {
     return getDetectorVersions(JType<T>());
   }

std::string JDETECTOR::getLatestDetectorVersion ( const JType< std::string > & type )

inline

Get latest detector version.

Parameters

type type

Returns: version

Definition at line 355 of file JDetectorVersion.hh.

   {
     return putDetectorVersion.rbegin()->second;
   }

JVersion JDETECTOR::getLatestDetectorVersion ( const JType< JVersion > & type )

inline

Get latest detector version.

Parameters

type type

Returns: version

Definition at line 367 of file JDetectorVersion.hh.

   {
     return putDetectorVersion.rbegin()->second;
   }

JDetectorVersion::JVersion_t JDETECTOR::getLatestDetectorVersion ( const JType< JDetectorVersion::JVersion_t > & type )

inline

Get latest detector version.

Parameters

type type

Returns: version

Definition at line 379 of file JDetectorVersion.hh.

   {
     return putDetectorVersion.rbegin()->first;
   }

template<class T >

T JDETECTOR::getLatestDetectorVersion ( )

inline

Get latest detector version.

Returns: version

Definition at line 391 of file JDetectorVersion.hh.

   {
     return getLatestDetectorVersion(JType<T>());
   }

std::string JDETECTOR::getLabel ( const JLocation & location )

inline

Get module label for monitoring and other applications.

The format is "(XXXX,YY)", where XXXX is the string number and YY the floor.

Parameters

location module location

Returns: label

Definition at line 246 of file JLocation.hh.

   {
     using namespace std;
     using namespace JPP;
 
     return MAKE_STRING("(" << FILL(4,'0') << location.getString() << "." << FILL(2,'0') << location.getFloor() << ")");
   }

template<class JAttributes_t >

void JDETECTOR::setAttributes	(	const JModule &	first,
		const JModule &	second,
		JAttributes_t &	attributes
	)

Template method to set module attributes.

This method should be overloaded for each type of module attributes.

Parameters

first	first module
second	second module
attributes	module attributes

template<>

void JDETECTOR::setAttributes< JNullType >	(	const JModule &	first,
		const JModule &	second,
		JNullType &	attributes
	)

Template specialisation to set no attributes for the default empty object.

Parameters

first	first module
second	second module
attributes	module attributes

Definition at line 49 of file JModuleMapper.hh.

52 {}

std::vector<std::string> JDETECTOR::getModuleStatusBits ( const JType< std::string > & type )

inline

Get module status bits.

Parameters

type type

Returns: status bits

Definition at line 79 of file JModuleStatus.hh.

   {
     return JPP::get_keys(getModuleStatusBit);
   }

std::vector<int> JDETECTOR::getModuleStatusBits ( const JType< int > & type )

inline

Get module status bits.

Parameters

type type

Returns: status bits

Definition at line 91 of file JModuleStatus.hh.

   {
     return JPP::get_keys(putModuleStatusBit);
   }

template<class T >

std::vector<T> JDETECTOR::getModuleStatusBits ( )

inline

Get module status bits.

Returns: status bits

Definition at line 103 of file JModuleStatus.hh.

   {
     return getModuleStatusBits(JType<T>());
   }

JPosition3D JDETECTOR::getPiezoPosition ( )

inline

Get relative position of piezo in optical module.

Returns: position [m]

Definition at line 28 of file JModuleSupportkit.hh.

   {
     return JPosition3D(0.0, 0.0, -0.20);
   }

double JDETECTOR::getTimeOverThresholdProbability	(	const JPMTAnalogueSignalProcessor &	pmt,
		const double	tot_ns,
		const double	NPE,
		const double	precision = `1.0e-4`
	)

inline

Get time-over-threshold probability.

Parameters

pmt	PMT signal processor
tot_ns	time-over-threshold [ns]
NPE	expected number of photo-electrons
precision	precision

Returns: probability

Definition at line 853 of file JPMTAnalogueSignalProcessor.hh.

   {
     int i = (int) (NPE - 5.0 * sqrt(NPE) - 0.5);
     int M = (int) (NPE + 5.0 * sqrt(NPE) + 0.5);
 
     if (i < 1) { i = 1; }
     if (M < i) { M = i; }
 
     double p = NPE * exp(-NPE) / (double) 1;
 
     for (int __i = 1; __i != i; ++__i) {
       p *= NPE / __i;
     }
 
     double P = 0.0;
 
     for (double p0 = 0.0; (p >= p0 || p > precision) && i != M; ++i, p0 = p, p *= NPE / (double) i) {
       P += pmt.getTimeOverThresholdProbability(tot_ns, i) * p;
     }
 
     return P;
   }

bool JDETECTOR::operator<	(	const JPMTIdentifier &	first,
		const JPMTIdentifier &	second
	)

inline

Less than operator for PMT identifiers.

Parameters

first	PMT identifier
second	PMT identifier

Returns: true if first PMT lower than second PMT; else false

Definition at line 187 of file JPMTIdentifier.hh.

   {
     if (first.getModuleID() == second.getModuleID())
       return first.getPMTAddress() < second.getPMTAddress();
     else
       return first.getModuleID()   < second.getModuleID();
   }

bool JDETECTOR::operator==	(	const JPMTIdentifier &	first,
		const JPMTIdentifier &	second
	)

inline

Equal operator for PMT identifiers.

Parameters

first	PMT identifier
second	PMT identifier

Returns: true if first PMT equal second PMT; else false

Definition at line 203 of file JPMTIdentifier.hh.

   {
     return (first.getModuleID()   == second.getModuleID()  &&
             first.getPMTAddress() == second.getPMTAddress());
   }

std::string JDETECTOR::getLabel ( const JPMTIdentifier & id )

inline

Get PMT label for monitoring and other applications.

The format is "(XXXXXXXXXX,YY)", where XXXXXXXXXX is the module idetifier and YY the PMT readout channel.

Parameters

id	PMT identifier

Returns: label

Definition at line 217 of file JPMTIdentifier.hh.

   {
     using namespace std;
     using namespace JPP;
 
     return MAKE_STRING("(" << FILL(10,'0') << id.getID() << "," << FILL(2,'0') << id.getPMTAddress() << ")");
   }

double JDETECTOR::getSurvivalProbability ( const JPMTParameters & parameters )

inline

Get model dependent probability that a one photo-electron hit survives the simulation of the PMT assuming QE = 1.

Parameters

parameters PMT parameters

Returns: probability

Definition at line 32 of file JPMTParametersToolkit.hh.

   {
     JPMTParameters data = parameters;
     const int      NPE  = 1;
 
     data.QE = 1.0;
 
     return JPMTAnalogueSignalProcessor(data).getSurvivalProbability(NPE);
   }

double JDETECTOR::getHitProbability	(	const double	QE,
		const double	mu
	)

inline

Get ratio of hit probabilities for given QE and expectation value of the number of photo-electrons.

The ratio corresponds to the hit probability with given QE divided by that with QE = 1.
The expectation value is defined for a two-fold (or higher) coincidence.

Parameters

QE	QE
mu	expectation value

Returns: ratio

Definition at line 52 of file JPMTParametersToolkit.hh.

   {
     if (mu > 0.0)
       return (1.0 - exp(-QE*mu)) / (1.0 - exp(-mu));
     else
       return QE;
   }

double JDETECTOR::getMaximalHitProbability ( const double mu )

inline

Get maximal ratio of hit probabilities for given QE and expectation value of the number of photo-electrons.

The ratio corresponds to the hit probability with infinite QE divided by that with QE = 1.
The expectation value is defined for a two-fold (or higher) coincidence.

Parameters

mu	expectation value

Returns: ratio

Definition at line 69 of file JPMTParametersToolkit.hh.

   {
     using namespace std;
 
     if (mu > 0.0)
       return 1.0 / (1.0 - exp(-mu));
     else
       return numeric_limits<double>::max();
   }

double JDETECTOR::getQE	(	const double	R,
		const double	mu
	)

inline

Get QE for given ratio of hit probabilities and expectation value of the number of photo-electrons.

The ratio corresponds to the hit probability with given QE divided by that with QE = 1.
The expectation value is defined for a two-fold (or higher) coincidence.

Parameters

R	ratio
mu	expectation value

Returns: QE

Definition at line 89 of file JPMTParametersToolkit.hh.

   {
     if (R < getMaximalHitProbability(mu)) {
       
       if (mu > 0.0)
         return -log(1.0 - R*(1.0 - exp(-mu))) / mu;
       else
         return R;
 
     } else {
 
       THROW(JValueOutOfRange, "Inconsistent arguments at method getQE(" << R << "," << mu <<")");
     }
   }

double JDETECTOR::getChargeProbability	(	const JPMTSignalProcessorInterface &	pmt,
		const double	npe,
		const double	NPE,
		const double	precision = `1.0e-4`
	)

inline

Get charge probability.

Parameters

pmt	PMT signal processor
npe	measured number of photo-electrons
NPE	expected number of photo-electrons
precision	precision

Returns: probability

Definition at line 415 of file JPMTSignalProcessorInterface.hh.

   {
     int i = (int) (NPE - 5.0 * sqrt(NPE));
 
     if (i < 1) {
       i = 1;
     }
 
     double p = NPE * exp(-NPE) / (double) 1;
 
     for (int __i = 1; __i != i; ++__i) {
       p *= NPE / __i;
     }
 
     double P = 0.0;
 
     for (double p0 = 0.0; (p >= p0 || p > precision); ++i, p0 = p, p *= NPE / (double) i) {
       P += pmt.getChargeProbability(npe, i) * p;
     }
 
     return P;
   }

bool JDETECTOR::operator<	(	const JPhotoElectron &	first,
		const JPhotoElectron &	second
	)

inline

Less than operator for photo-elecrons.

Parameters

first	first photo-electron
second	second photo-electron

Returns: true if first photo-electron earlier than second; else false

Definition at line 70 of file JPMTSimulator.hh.

   {
     return first.t_ns < second.t_ns;
   }

bool JDETECTOR::operator<	(	const JPMTSignal &	first,
		const JPMTSignal &	second
	)

inline

Less than operator for PMT signals.

Parameters

first	first PMT signal
second	second PMT signal

Returns: true if first PMT signal earlier than second; else false

Definition at line 114 of file JPMTSimulator.hh.

   {
     return first.t_ns < second.t_ns;
   }

bool JDETECTOR::operator<	(	const JPMTPulse &	first,
		const JPMTPulse &	second
	)

inline

Less than operator for PMT pulses.

Parameters

first	first PMT pulse
second	second PMT pulse

Returns: true if first PMT pulse earlier than second; else false

Definition at line 158 of file JPMTSimulator.hh.

   {
     return first.t_ns < second.t_ns;
   }

JTimeRange JDETECTOR::getTimeRange ( const JPMTData< JPMTSignal > & input )

inline

Get time range (i.e. earlist and latest hit time) of PMT data.

Parameters

input PMT data

Returns: time range

Definition at line 287 of file JPMTSimulator.hh.

   {
     JTimeRange range(JTimeRange::DEFAULT_RANGE);
 
     for (JPMTData<JPMTSignal>::const_iterator hit = input.begin(); hit != input.end(); ++hit) {
       range.include(hit->t_ns);
     }
 
     return range;
   }

JTimeRange JDETECTOR::getTimeRange ( const JModuleData & input )

inline

Get time range (i.e. earlist and latest hit time) of module data.

Parameters

input module data

Returns: time range

Definition at line 305 of file JPMTSimulator.hh.

   {
     JTimeRange range(JTimeRange::DEFAULT_RANGE);
 
     for (JModuleData::const_iterator frame = input.begin(); frame != input.end(); ++frame) {
       for (JModuleData::value_type::const_iterator hit = frame->begin(); hit != frame->end(); ++hit) {
         range.include(hit->t_ns);
       }
     }
 
     return range;
   }

std::vector<std::string> JDETECTOR::getPMTStatusBits ( const JType< std::string > & type )

inline

Get PMT status bits.

Parameters

type type

Returns: status bits

Definition at line 80 of file JPMTStatus.hh.

   {
     return JPP::get_keys(getPMTStatusBit);
   }

std::vector<int> JDETECTOR::getPMTStatusBits ( const JType< int > & type )

inline

Get PMT status bits.

Parameters

type type

Returns: status bits

Definition at line 92 of file JPMTStatus.hh.

   {
     return JPP::get_keys(putPMTStatusBit);
   }

template<class T >

std::vector<T> JDETECTOR::getPMTStatusBits ( )

inline

Get PMT status bits.

Returns: status bits

Definition at line 104 of file JPMTStatus.hh.

   {
     return getPMTStatusBits(JType<T>());
   }

Variable Documentation

const double JDETECTOR::TIME_OVER_THRESHOLD_NS = 25.08

Specification for time-over-threshold corresponding to a one photo-electron pulse.

Definition at line 30 of file JDetector/JCalibration.hh.

const double JDETECTOR::NOMINAL_GAIN = 1.0

Specification for normalized gain corresponding to a one photo-electron pulse.

Definition at line 35 of file JDetector/JCalibration.hh.

const std::string JDETECTOR::User_t = "User"

static

Detector calibration key words for JSON I/O.

Definition at line 50 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Location_t = "Location"

static

Definition at line 51 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Time_t = "Time"

static

Definition at line 52 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Start_t = "Start"

static

Definition at line 53 of file JDetectorCalibration.hh.

const std::string JDETECTOR::End_t = "End"

static

Definition at line 54 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Comment_t = "Comment"

static

Definition at line 55 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Encoding_t = "Encoding"

static

Definition at line 56 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Input_t = "Inputs"

static

Definition at line 57 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Error_t = "Error"

static

Definition at line 58 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Message_t = "Message"

static

Definition at line 59 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Code_t = "Code"

static

Definition at line 60 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Provenance_t = "Provenance"

static

Definition at line 61 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Info_t = "Info"

static

Definition at line 62 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Configuration_t = "Configuration"

static

Definition at line 63 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Arguments_t = "Arguments"

static

Definition at line 64 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Inputs_t = "Inputs"

static

Definition at line 65 of file JDetectorCalibration.hh.

const std::string JDETECTOR::UUID_t = "UUID"

static

Definition at line 66 of file JDetectorCalibration.hh.

const std::string JDETECTOR::APIVersion_t = "APIVersion"

static

Definition at line 67 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Type_t = "Type"

static

Definition at line 70 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Test_t = "Test"

static

Definition at line 71 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Tests_t = "Tests"

static

Definition at line 72 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Data_t = "Data"

static

Definition at line 73 of file JDetectorCalibration.hh.

const std::string JDETECTOR::URL_t = "URL"

static

Definition at line 74 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Name_t = "Name"

static

Definition at line 75 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Unit_t = "Unit"

static

Definition at line 76 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Values_t = "Values"

static

Definition at line 77 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Parameters_t = "Parameters"

static

Definition at line 78 of file JDetectorCalibration.hh.

const std::string JDETECTOR::RunNumber_t = "RUN_NUMBER"

static

Definition at line 79 of file JDetectorCalibration.hh.

const std::string JDETECTOR::PMTT0s_t = "PMTT0s"

static

Definition at line 82 of file JDetectorCalibration.hh.

const std::string JDETECTOR::PMTSupplyVoltage_t = "PMT_Supply_Voltage"

static

Definition at line 83 of file JDetectorCalibration.hh.

const std::string JDETECTOR::PMTThreshold_t = "PMT_Threshold"

static

Definition at line 84 of file JDetectorCalibration.hh.

const std::string JDETECTOR::DOMPositions_t = "DOMPositions"

static

Definition at line 85 of file JDetectorCalibration.hh.

const std::string JDETECTOR::DOMRotations_t = "DOMRotations"

static

Definition at line 86 of file JDetectorCalibration.hh.

const std::string JDETECTOR::PMTGain_t = "PMT_Gain"

static

Definition at line 87 of file JDetectorCalibration.hh.

const std::string JDETECTOR::UPI_t = "UPI"

static

Definition at line 90 of file JDetectorCalibration.hh.

const std::string JDETECTOR::PBS_t = "PBS"

static

Definition at line 91 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Variant_t = "Variant"

static

Definition at line 92 of file JDetectorCalibration.hh.

const std::string JDETECTOR::PMTSerial_t = "PMTSerial"

static

Definition at line 93 of file JDetectorCalibration.hh.

const std::string JDETECTOR::DOMSerial_t = "DOMSerial"

static

Definition at line 94 of file JDetectorCalibration.hh.

const std::string JDETECTOR::DOMId_t = "DOMId"

static

Definition at line 95 of file JDetectorCalibration.hh.

const std::string JDETECTOR::T0_t = "T0"

static

Definition at line 98 of file JDetectorCalibration.hh.

const std::string JDETECTOR::PX_t = "PX"

static

Definition at line 99 of file JDetectorCalibration.hh.

const std::string JDETECTOR::PY_t = "PY"

static

Definition at line 100 of file JDetectorCalibration.hh.

const std::string JDETECTOR::PZ_t = "PZ"

static

Definition at line 101 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Q0_t = "Q0"

static

Definition at line 102 of file JDetectorCalibration.hh.

const std::string JDETECTOR::QX_t = "QX"

static

Definition at line 103 of file JDetectorCalibration.hh.

const std::string JDETECTOR::QY_t = "QY"

static

Definition at line 104 of file JDetectorCalibration.hh.

const std::string JDETECTOR::QZ_t = "QZ"

static

Definition at line 105 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Unitless_t = "-"

static

Definition at line 108 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Volt_t = "V"

static

Definition at line 109 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Result_t = "Result"

static

Definition at line 112 of file JDetectorCalibration.hh.

const std::string JDETECTOR::OK_t = "OK"

static

Definition at line 113 of file JDetectorCalibration.hh.

const std::string JDETECTOR::Fail_t = "FAIL"

static

Definition at line 114 of file JDetectorCalibration.hh.

const double JDETECTOR::ORCA_TBARZ_M = 0.91

static

ORCA T-bar position relative to seabed [m].

Definition at line 17 of file JDetectorSupportkit.hh.

const double JDETECTOR::ARCA_TBARZ_M = 0.95

static

ORCA T-bar position relative to seabed [m].

Definition at line 18 of file JDetectorSupportkit.hh.

const char* const JDETECTOR::GENDET_DETECTOR_FILE_FORMAT = "det"

static

File name extensions.

file format used by gendet

Definition at line 61 of file JDetectorToolkit.hh.

const char* const JDETECTOR::BINARY_DETECTOR_FILE_FORMAT[] = { "dat", "datx" }

static

JIO binary file format.

Definition at line 62 of file JDetectorToolkit.hh.

const char* const JDETECTOR::KM3NET_DETECTOR_FILE_FORMAT = "detx"

static

KM3NeT standard ASCII format

Definition at line 63 of file JDetectorToolkit.hh.

const char* const JDETECTOR::ZIPPED_DETECTOR_FILE_FORMAT = "gz"

static

zipped KM3NeT standard ASCII format

Definition at line 64 of file JDetectorToolkit.hh.

const char* const JDETECTOR::GDML_DETECTOR_FILE_FORMAT = "gdml"

static

KM3Sim input format.

Definition at line 65 of file JDetectorToolkit.hh.

const char* const JDETECTOR::GDML_SCHEMA = getenv("GDML_SCHEMA_DIR")

static

directory necessary for correct GDML header output

Definition at line 67 of file JDetectorToolkit.hh.

const char* const JDETECTOR::CAN_MARGIN_M = getenv("CAN_MARGIN_M")

static

extension of the detector size to comply with the can definition

Definition at line 68 of file JDetectorToolkit.hh.

const char* const JDETECTOR::G4GDML_DEFAULT_SCHEMALOCATION = "http://service-spi.web.cern.ch/service-spi/app/releases/GDML/schema/gdml.xsd"

static

Definition at line 69 of file JDetectorToolkit.hh.

JRotation JDETECTOR::getRotation

static

Function object to get rotation matrix to go from first to second module.

Definition at line 873 of file JDetectorToolkit.hh.

const JGetDetectorVersion JDETECTOR::getDetectorVersion

static

Function object to map detector version to numerical value.

Definition at line 300 of file JDetectorVersion.hh.

const JPutDetectorVersion JDETECTOR::putDetectorVersion(getDetectorVersion)

static

Function object to map numerical value to detector version.

const JGetModuleStatusBit JDETECTOR::getModuleStatusBit

static

Function object to map key to module status bit.

Definition at line 64 of file JModuleStatus.hh.

const JPutModuleStatusBit JDETECTOR::putModuleStatusBit(getModuleStatusBit)

static

Function object to map module status bit to key.

const double JDETECTOR::PIEZO_DELAYTIME_US = 170.0

static

Piezo delay time [us].

Definition at line 19 of file JModuleSupportkit.hh.

const double JDETECTOR::HYDROPHONE_DELAYTIME_US = 50.0

static

Hydrophone delay time [us].

Definition at line 20 of file JModuleSupportkit.hh.

const int JDETECTOR::LED_BEACON_PMT_TYPE = 2

static

PMT type of LED beacon.

Definition at line 37 of file JMonteCarloDetector.hh.

const JGetPMTStatusBit JDETECTOR::getPMTStatusBit

static

Function object to map key to PMT status bit.

Definition at line 65 of file JPMTStatus.hh.

const JPutPMTStatusBit JDETECTOR::putPMTStatusBit(getPMTStatusBit)

static

Function object to map PMT status bit to key.

const JTransitionTimeProbability38 JDETECTOR::p38

Definition at line 3156 of file JPMTTransitTimeGenerator.hh.

const JTransitionTimeProbability41 JDETECTOR::p41

Definition at line 3157 of file JPMTTransitTimeGenerator.hh.

JDETECTOR::getTransitionTime

static

Function object to generate transition time.

JDETECTOR::getTransitionTimeProbability

static

Function object of transition time prabability.

const JTransitionTimeProbability2D JDETECTOR::getTransitionTimeProbability2D

static

Function object of twofold transition time prabability.

Definition at line 2153 of file JPMTTransitTimeProbability.hh.

const JStringCounter JDETECTOR::getNumberOfStrings

static

Function object to count unique strings.

Definition at line 95 of file JStringCounter.hh.

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

Function Documentation

Variable Documentation