Jpp
15.0.1
the software that should make you happy
|
Detector data structure. More...
#include <JDetector.hh>
Public Types | |
enum | start_of_comment_type { OLD_START_OF_COMMENT, NEW_START_OF_COMMENT } |
Enumeration for different lengths of start of comment in binary I/O. More... | |
enum | JVersion_t { V1 = 1, V2 = 2, V3 = 3, V4 = 4, V5 = 5 } |
Enumeration of version types. More... | |
typedef std::pair< T, T > | pair_type |
typedef JRange< T, JComparator_t > | range_type |
typedef JLANG::JClass< T > ::argument_type | argument_type |
typedef T | key_type |
typedef T | mapped_type |
Public Member Functions | |
JDetector () | |
Default constructor. More... | |
JDetector (const JDetectorID &id, const JVersion &version, const JDetectorHeader &header) | |
Constructor. More... | |
void | setVersion (const JVersion &version) |
Set version. More... | |
bool | setVersion (const JDetectorVersion::JVersion_t &version, const bool force=false) |
Set version. More... | |
bool | setToLatestVersion () |
Set to latest version. More... | |
JDetector & | operator+= (const JVector3D &pos) |
Move detector elements. More... | |
JDetector & | operator-= (const JVector3D &pos) |
Move detector elements. More... | |
const JModule & | getModule (const JModuleAddress &address) const |
Get module parameters. More... | |
JModule & | getModule (const JModuleAddress &address) |
Get module parameters. More... | |
const JModule & | getModule (const JLocation &location) const |
Get module parameters. More... | |
JModule & | getModule (const JLocation &location) |
Get module parameters. More... | |
const JPMT & | getPMT (const JPMTAddress &address) const |
Get PMT parameters. More... | |
JPMT & | getPMT (const JPMTAddress &address) |
Get PMT parameters. More... | |
virtual JReader & | read (JReader &in) override |
Read from input. More... | |
virtual JWriter & | write (JWriter &out) const override |
Write to output. More... | |
int | getID () const |
Get identifier. More... | |
int & | getID () |
Get identifier. More... | |
void | setID (const int id) |
Set identifier. More... | |
bool | less (const JObjectID &object) const |
Less than method. More... | |
bool | less (const int id) const |
Less than method. More... | |
bool | more (const int id) const |
More than method. More... | |
const std::string & | getVersion () const |
Get version. More... | |
void | setVersion (const std::string &version) |
Set version. More... | |
bool | less (const JVersion &version) const |
Less-than method. More... | |
const JDetectorHeader & | getDetectorHeader () const |
Get detector header. More... | |
bool | equals (const JDetectorHeader &header, const double precision=std::numeric_limits< double >::min()) const |
Check equality. More... | |
bool | equals (const range_type &range) const |
Equal method. More... | |
bool | equals (const JUTMGrid &grid) const |
Check equality. More... | |
JProperties | getProperties (const JEquationParameters &equation=JDetectorHeader::getEquationParameters()) |
Get properties of this class. More... | |
JProperties | getProperties (const JEquationParameters &equation=JDetectorHeader::getEquationParameters()) const |
Get properties of this class. More... | |
const JUTCTimeRange & | getUTCTimeRange () const |
Get UTC time range. More... | |
void | setUTCTimeRange (const JRange< double > &timerange) |
Set UTC time range. More... | |
operator pair_type () const | |
Type conversion operator. More... | |
const range_type & | getRange () const |
Get range. More... | |
void | setRange (const range_type &range) |
Set range. More... | |
void | setRange (argument_type x, argument_type y) |
Set lower and upper limit. More... | |
template<class R > | |
void | setRange (R first, R second) |
Set range. More... | |
template<class JElement_t , class JAllocator_t > | |
void | setRange (const array_type< JElement_t, JAllocator_t > &buffer) |
Set lower and upper limit according to input data. More... | |
T | getLowerLimit () const |
Get lower limit. More... | |
T | getUpperLimit () const |
Get upper limit. More... | |
void | setLowerLimit (argument_type x) |
Set lower limit. More... | |
void | setUpperLimit (argument_type y) |
Set upper limit. More... | |
void | fixLowerLimit (argument_type x) |
Fix lower limit. More... | |
void | fixUpperLimit (argument_type y) |
Fix upper limit. More... | |
T | getLength () const |
Get length (difference between upper and lower limit). More... | |
void | setLength (argument_type length) |
Set length (difference between upper and lower limit). More... | |
bool | is_valid () const |
Check validity of range. More... | |
bool | in_range (argument_type x) const |
Test whether value is inside range. More... | |
bool | operator() (argument_type x) const |
Test whether value is inside range. More... | |
T | constrain (argument_type x) const |
Constrain value to range. More... | |
T | mod (argument_type x) const |
Modulo value with respect to range. More... | |
bool | overlap (const range_type &range) const |
Test overlap with given range. More... | |
range_type | include (argument_type x) |
Include given value to range. More... | |
range_type & | join (const range_type &range) |
Join ranges. More... | |
range_type & | combine (const range_type &range) |
Combine ranges. More... | |
range_type & | add (argument_type x) |
Add offset. More... | |
range_type & | add (const range_type &range) |
Add offsets. More... | |
JUTMPosition & | add (const JUTMPosition &pos) |
Add UTM position. More... | |
range_type & | sub (argument_type x) |
Subtract offset. More... | |
range_type & | sub (const range_type &range) |
Subtract offsets. More... | |
JUTMPosition & | sub (const JUTMPosition &pos) |
Subtract UTM position. More... | |
range_type & | mul (const double factor) |
Multiply range. More... | |
JFirst_t & | mul (const JSecond_t &object) |
Multiply with object. More... | |
JUTMPosition & | mul (const double factor) |
Scale UTM position. More... | |
JFirst_t & | mul (const JSecond_t &object) |
Multiply with object. More... | |
range_type & | div (const double factor) |
Divide range. More... | |
JUTMPosition & | div (const double factor) |
Scale UTM position. More... | |
T | getN (const double R) const |
Get expected number of occurances of given rate within this interval. More... | |
const key_type & | getKey () const |
const std::string & | getKey () const |
Get key. More... | |
const mapped_type & | getValue () const |
mapped_type & | getValue () |
const JUTMGrid & | getUTMGrid () const |
Get UTM grid. More... | |
void | setUTMGrid (const JUTMGrid &grid) |
Set UTM grid. More... | |
const std::string & | getWGS () const |
Get WGS. More... | |
const std::string & | getUTMZone () const |
Get UTM zone. More... | |
int | getUTMValue () const |
Get UTM zone by numerical value. More... | |
std::string | toString () const |
Convert UTM grid. More... | |
const JUTMPosition & | getUTMPosition () const |
Get UTM position. More... | |
void | setUTMPosition (const JUTMPosition &position) |
Set UTM position. More... | |
JPosition3D | getPosition () const |
Get position. More... | |
operator JPosition3D () const | |
Type conversion operator. More... | |
double | getUTMEast () const |
Get UTM east. More... | |
double | getUTMNorth () const |
Get UTM north. More... | |
double | getUTMZ () const |
Get UTM Z. More... | |
JUTMPosition & | negate () |
Negate UTM position. More... | |
double | getDisplacement (const JUTMPosition &position) const |
Get displacement to position. More... | |
Static Public Member Functions | |
static start_of_comment_type | getStartOfComment () |
Get option for short start of comment in binary I/O. More... | |
static void | setStartOfComment (const start_of_comment_type option) |
Set option for short start of comment in binary I/O. More... | |
static JEquationParameters & | getEquationParameters () |
Get equation parameters. More... | |
static void | setEquationParameters (const JEquationParameters &equation) |
Set equation parameters. More... | |
static T | getMinimum () |
Get minimum possible value. More... | |
static T | getMaximum () |
Get maximum possible value. More... | |
static JUTMGrid | valueOf (const std::string &buffer) |
Extract UTM grid. More... | |
Public Attributes | |
JComment | comment |
JComparator_t | compare |
Function object. More... | |
T | first |
T | second |
Static Public Attributes | |
static const JRange< T, JComparator_t > | DEFAULT_RANGE |
Default range. More... | |
Protected Member Functions | |
void | setVersion () const |
Set version. More... | |
template<class R > | |
void | setRange (R first, R second, const JLANG::JBool< false > &option) |
Set range. More... | |
template<class R > | |
void | setRange (R first, R second, const JLANG::JBool< true > &option) |
Set range. More... | |
Static Protected Member Functions | |
static start_of_comment_type & | get_start_of_comment () |
Get option for short start of comment in binary I/O. More... | |
Protected Attributes | |
int | __id |
std::string | version |
std::string | key |
std::string | wgs |
std::string | zone |
double | east |
double | north |
double | z |
Static Protected Attributes | |
static const size_t | LENGTH_START_OF_COMMENT = sizeof(JDetectorID) |
Length of start of comment in binary I/O. More... | |
Friends | |
std::istream & | operator>> (std::istream &in, JDetector &detector) |
Read detector from input. More... | |
std::ostream & | operator<< (std::ostream &out, const JDetector &detector) |
Write detector to output. More... | |
Detector data structure.
A detector consists of a header and a list of modules, each of which consists of a list of PMTs. Each PMT comprises position, orientation and time calibration data. Note that the index of the PMT in the module data structure corresponds to the readout channel (TDC).
The following formats and file name extension are supported:
extension | format | function |
---|---|---|
".detx" | ASCII | I/O |
".gz" | gzipped ASCII | I/O |
".dat" | binary | I/O |
".det" | ASCII | I |
The different formats can transparently be read and written using the methods:
inline void load(const JString& file_name, JDetector& detector); inline void store(const JString& file_name, const JDetector& detector);
respectively. These methods are available in the include file JDetectorToolkit.hh.
The JDETECTOR::JModuleRouter and JDETECTOR::JPMTRouter classes provide for fast look-up methods of module and PMT calibration data for real data and Monte Carlo data, respectively.
Note that the (not) equal operator strictly applies to the detector identifier and version. For quantitative comparisons, use JCompareDetector.cc.
The official detector description document is available on the google drive for anyone with a KM3NeT account.
It can directly be found at this link.
For a given detector, the module identifier (JModule::getID) and the PMT identifier (JPMT::getID) are unique.
The serial number in the UPI of a PMT is equal to its identifier in the detector description.
For more information on the PBS (product breakdown structure) and UPI (universal product identifier), see this link.
Definition at line 89 of file JDetector.hh.
|
inherited |
|
inherited |
|
inherited |
Enumeration for different lengths of start of comment in binary I/O.
Enumerator | |
---|---|
OLD_START_OF_COMMENT | |
NEW_START_OF_COMMENT |
Definition at line 495 of file JDetector.hh.
|
inherited |
Enumeration of version types.
Note that additional version types should be included in JGetDetectorVersion::JGetDetectorVersion.
Definition at line 48 of file JDetectorVersion.hh.
|
inline |
Default constructor.
Definition at line 101 of file JDetector.hh.
|
inline |
Constructor.
id | detector identifier |
version | version |
header | header |
Definition at line 117 of file JDetector.hh.
|
inline |
Set version.
version | version |
Definition at line 135 of file JDetector.hh.
|
inline |
Set version.
Note that the version is only set to a higher version or when forced to set it.
version | version |
force | force setting of version |
Definition at line 152 of file JDetector.hh.
|
inline |
Move detector elements.
pos | offset position |
Definition at line 182 of file JDetector.hh.
Move detector elements.
pos | offset position |
Definition at line 198 of file JDetector.hh.
|
inline |
Get module parameters.
address | module address |
Definition at line 214 of file JDetector.hh.
|
inline |
Get module parameters.
address | module address |
Definition at line 226 of file JDetector.hh.
Get module parameters.
location | module location |
Definition at line 238 of file JDetector.hh.
Get module parameters.
location | module location |
Definition at line 256 of file JDetector.hh.
|
inline |
Get PMT parameters.
address | JPMTAddress |
Definition at line 274 of file JDetector.hh.
|
inline |
Get PMT parameters.
address | JPMTAddress |
Definition at line 286 of file JDetector.hh.
Read from input.
in | reader |
Implements JIO::JSerialisable.
Definition at line 399 of file JDetector.hh.
Write to output.
out | writer |
Implements JIO::JSerialisable.
Definition at line 451 of file JDetector.hh.
|
inlinestatic |
Get option for short start of comment in binary I/O.
Definition at line 506 of file JDetector.hh.
|
inlinestatic |
Set option for short start of comment in binary I/O.
option | option |
Definition at line 517 of file JDetector.hh.
|
inlineprotected |
Set version.
This method should be called to set up the handling of detector version specific module and PMT I/O.
Definition at line 528 of file JDetector.hh.
|
inlinestaticprotected |
Get option for short start of comment in binary I/O.
Definition at line 540 of file JDetector.hh.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Less than method.
object | object identifier |
Definition at line 84 of file JObjectID.hh.
|
inlineinherited |
Less than method.
id | identifier |
Definition at line 96 of file JObjectID.hh.
|
inlineinherited |
More than method.
id | identifier |
Definition at line 108 of file JObjectID.hh.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Less-than method.
version | version |
Definition at line 73 of file JDetector/JVersion.hh.
|
inlineinherited |
|
inlineinherited |
Check equality.
header | header |
precision | precision |
Definition at line 89 of file JDetectorHeader.hh.
|
inlineinherited |
Equal method.
range | range |
Definition at line 275 of file JRange.hh.
|
inlineinherited |
Check equality.
grid | UTM grid |
Definition at line 151 of file JUTMGrid.hh.
|
inlinestaticinherited |
Get equation parameters.
Definition at line 173 of file JDetectorHeader.hh.
|
inlinestaticinherited |
Set equation parameters.
equation | equation parameters |
Definition at line 187 of file JDetectorHeader.hh.
|
inlineinherited |
Get properties of this class.
equation | equation parameters |
Definition at line 198 of file JDetectorHeader.hh.
|
inlineinherited |
Get properties of this class.
equation | equation parameters |
Definition at line 209 of file JDetectorHeader.hh.
|
inlineinherited |
|
inlineinherited |
Set UTC time range.
timerange | UTC time range |
Definition at line 74 of file JUTCTimeRange.hh.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Set range.
range | range |
Definition at line 146 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
Set range.
The arguments could be values or iterators.
first | first |
second | second |
Definition at line 173 of file JRange.hh.
|
inlineinherited |
Set lower and upper limit according to input data.
buffer | input data |
Definition at line 187 of file JRange.hh.
|
inlineprotectedinherited |
Set range.
first | first |
second | second |
option | false |
Definition at line 589 of file JRange.hh.
|
inlineprotectedinherited |
Set range.
first | first |
second | second |
option | true |
Definition at line 603 of file JRange.hh.
|
inlineinherited |
Get lower limit.
|
inlineinherited |
Get upper limit.
|
inlineinherited |
|
inlineinherited |
Set upper limit.
y | upper limit |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Set length (difference between upper and lower limit).
length | length |
Definition at line 300 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Test whether value is inside range.
x | value |
Definition at line 336 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
Modulo value with respect to range.
x | value |
Definition at line 365 of file JRange.hh.
|
inlineinherited |
Test overlap with given range.
The result is equivalent to join(range).is_valid().
range | range |
Definition at line 383 of file JRange.hh.
|
inlineinherited |
Include given value to range.
The new lower limit is the minimim of the original lower limit and given value and
the new upper limit is the maximum of the original upper limit and given value;
x | value |
Definition at line 398 of file JRange.hh.
|
inlineinherited |
Join ranges.
The new lower limit is the maximim of the two lower limits and
the new upper limit is the minimum of the two upper limits.
This operation results in an equal or smaller range and may result in an unphysical range (i.e. lower limit > upper limit).
range | range |
Definition at line 416 of file JRange.hh.
|
inlineinherited |
Combine ranges.
The new lower limit is the minimim of the two lower limits and
the new upper limit is the maximum of the two upper limits.
This operation results in an equal or larger range.
range | range |
Definition at line 433 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
Add offsets.
The new lower limit is the sum of the two lower limits and
the new upper limit is the sum of the two upper limits.
range | offset |
Definition at line 477 of file JRange.hh.
|
inlineinherited |
Add UTM position.
pos | UTM position |
Definition at line 177 of file JUTMPosition.hh.
|
inlineinherited |
|
inlineinherited |
Subtract offsets.
The new lower limit is the difference of the two lower limits and
the new upper limit is the difference of the two upper limits.
range | offset |
Definition at line 493 of file JRange.hh.
|
inlineinherited |
Subtract UTM position.
pos | UTM position |
Definition at line 193 of file JUTMPosition.hh.
|
inlineinherited |
|
inlineinherited |
Multiply with object.
object | object |
Definition at line 357 of file JMath.hh.
|
inlineinherited |
Scale UTM position.
factor | multiplication factor |
Definition at line 209 of file JUTMPosition.hh.
|
inlineinherited |
Multiply with object.
object | object |
Definition at line 357 of file JMath.hh.
|
inlineinherited |
|
inlineinherited |
Scale UTM position.
factor | division factor |
Definition at line 225 of file JUTMPosition.hh.
|
inlineinherited |
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlinestaticinherited |
Extract UTM grid.
buffer | WGS and UTM zone |
Definition at line 176 of file JUTMGrid.hh.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Type conversion operator.
Definition at line 117 of file JUTMPosition.hh.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Get displacement to position.
The displacement corresponds to the 2D distance in the (East,North) plane.
position | position |
Definition at line 243 of file JUTMPosition.hh.
|
friend |
Read detector from input.
in | input stream |
detector | detector |
Definition at line 299 of file JDetector.hh.
|
friend |
Write detector to output.
out | output stream |
detector | detector |
Definition at line 352 of file JDetector.hh.
JComment JDETECTOR::JDetector::comment |
Definition at line 489 of file JDetector.hh.
|
staticprotected |
Length of start of comment in binary I/O.
Definition at line 551 of file JDetector.hh.
|
protectedinherited |
Definition at line 140 of file JObjectID.hh.
|
protectedinherited |
Definition at line 79 of file JDetector/JVersion.hh.
|
staticinherited |
|
inherited |
|
protectedinherited |
Definition at line 246 of file JUTMGrid.hh.
|
protectedinherited |
Definition at line 247 of file JUTMGrid.hh.
|
protectedinherited |
Definition at line 248 of file JUTMGrid.hh.
|
protectedinherited |
Definition at line 311 of file JUTMPosition.hh.
|
protectedinherited |
Definition at line 312 of file JUTMPosition.hh.
|
protectedinherited |
Definition at line 313 of file JUTMPosition.hh.