Detector data structure. More...

#include <JDetector.hh>

Inheritance diagram for JDETECTOR::JDetector:

Public Types
enum	JVersion_t { V1 = 1, V2 = 2, V3 = 3 }
	Enumeration of version types. More...

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 JObjectID &id, const JVersion &version, const JDetectorHeader &header)
	Constructor. More...

void	setVersion (const JVersion &version)
	Set version. More...

void	setVersion (const JDetectorVersion::JVersion_t &version)
	Set 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 JModuleLocation &location) const
	Get module parameters. More...

JModule &	getModule (const JModuleLocation &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)
	Read from input. More...

virtual JWriter &	write (JWriter &out) const
	Write to output. More...

int	getID () const
	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 JVersion &	getVersion () const
	Get version. More...

JVersion &	getVersion ()
	Get version. More...

const std::string &	getVariant () const
	Get variant. More...

void	setVariant (const std::string &variant)
	Set variant. More...

bool	equals (const JVersion &version) const
	Equal method. 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 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 iterator_type , class value_type , class result_type >
void	setRange (iterator_type __begin, iterator_type __end, result_type value_type::*member)
	Set lower and upper limit according to minimal and maximal value in input data, respectively. More...

template<class iterator_type , class value_type , class result_type >
void	setRange (iterator_type __begin, iterator_type __end, result_type(value_type::*function)() const)
	Set lower and upper limit according to minimal and maximal value in input data, respectively. 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...

bool	equals (const range_type &range) const
	Equal method. More...

T	getLength () const
	Get length (difference between upper and lower limit). More...

bool	is_valid () const
	Check validity of 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...

JUTMPosition &	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 std::string &	getWGS () const
	Get WGS. More...

const std::string &	getUTMZone () const
	Get UTM zone. More...

std::string	toString () const
	Convert UTM grid. More...

const JUTMPosition &	getUTMPosition () const
	Get UTM position. More...

JPosition3D	getPosition () const
	Get position. 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...

Static Public Member Functions
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
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
template<class JHead_t , class JTail_t >
static bool	eq (const JClass_t &first, const JClass_t &second, const JType< JTypeList< JHead_t, JTail_t > > &type)
	Equals method for composite data types. More...

template<class JHead_t >
static bool	eq (const JClass_t &first, const JClass_t &second, const JType< JTypeList< JHead_t, JNullType > > &type)
	Equals method for composite data types. More...

Protected Attributes
int	__id

std::string	__variant

std::string	key

std::string	wgs

std::string	zone

double	east

double	north

double	z

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...

Detailed Description

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 for anyone with a KM3NeT account at the <a href="https://drive.google.com/open?id=0B6l8SNtndcwaUTZPOWZOXzd6R3M> google drive .

Definition at line 80 of file JDetector.hh.

Member Typedef Documentation

◆ range_type

template<class T, class JComparator_t = std::less<T>>

typedef JRange<T, JComparator_t> JTOOLS::JRange< T, JComparator_t >::range_type

inherited

Definition at line 41 of file JRange.hh.

◆ argument_type

template<class T, class JComparator_t = std::less<T>>

typedef JLANG::JClass<T>::argument_type JTOOLS::JRange< T, JComparator_t >::argument_type

inherited

Definition at line 42 of file JRange.hh.

◆ key_type

typedef T JTOOLS::JPair< T , T >::key_type

inherited

Definition at line 32 of file JPair.hh.

◆ mapped_type

typedef T JTOOLS::JPair< T , T >::mapped_type

inherited

Definition at line 33 of file JPair.hh.

Member Enumeration Documentation

◆ JVersion_t

enum JDETECTOR::JDetectorVersion::JVersion_t

inherited

Enumeration of version types.

Additional version types should be included in JGetDetectorVersion::JGetDetectorVersion.

Enumerator
V1	First version.
V2	Version with UTC time and UTM position data.
V3	Version with PMT status field and comments.

Definition at line 42 of file JDetectorVersion.hh.

                     {
       V1 = 1,        //!< First version
       V2 = 2,        //!< Version with UTC time and UTM position data
       V3 = 3         //!< Version with PMT status field and comments
     };

Constructor & Destructor Documentation

◆ JDetector() [1/2]

JDETECTOR::JDetector::JDetector ( )

inline

Default constructor.

Definition at line 92 of file JDetector.hh.

                 :
       JObjectID(),
       JDetectorVersion(),
       JDetectorHeader (),
       std::vector<JModule>(),
       JSerialisable()
     {}

◆ JDetector() [2/2]

JDETECTOR::JDetector::JDetector	(	const JObjectID &	id,
		const JVersion &	version,
		const JDetectorHeader &	header
	)

inline

Constructor.

Parameters

id	detector identifier
version	version
header	header

Definition at line 108 of file JDetector.hh.

                                              :
       JObjectID(id),
       JDetectorVersion(version),
       JDetectorHeader (header),
       std::vector<JModule>(),
       JSerialisable()
     {
       JPMT::setVersion(getVersion());
     }

Member Function Documentation

◆ setVersion() [1/2]

void JDETECTOR::JDetector::setVersion ( const JVersion & version )

inline

Set version.

Parameters

version version

Definition at line 126 of file JDetector.hh.

     {
       static_cast<JDetectorVersion&>(*this).setVersion(version);
  
       JPMT::setVersion(getVersion());
     }

◆ setVersion() [2/2]

void JDETECTOR::JDetector::setVersion ( const JDetectorVersion::JVersion_t & version )

inline

Set version.

Parameters

version version

Definition at line 139 of file JDetector.hh.

     {
       setVersion(putDetectorVersion(version));
     }

◆ operator+=()

JDetector& JDETECTOR::JDetector::operator+= ( const JVector3D & pos )

inline

Move detector elements.

Parameters

pos	offset position

Returns: this JDetector

Definition at line 151 of file JDetector.hh.

     {
       for (iterator i = begin(); i != end(); ++i) {
         i->add(pos);
       }
  
       return *this;
     }

◆ operator-=()

JDetector& JDETECTOR::JDetector::operator-= ( const JVector3D & pos )

inline

Move detector elements.

Parameters

pos	offset position

Returns: this JDetector

Definition at line 167 of file JDetector.hh.

     {
       for (iterator i = begin(); i != end(); ++i) {
         i->sub(pos);
       }
  
       return *this;
     }

◆ getModule() [1/4]

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

inline

Get module parameters.

Parameters

address module address

Returns: module parameters

Definition at line 183 of file JDetector.hh.

     {
       return at(address.first);
     }

◆ getModule() [2/4]

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

inline

Get module parameters.

Parameters

address module address

Returns: module parameters

Definition at line 195 of file JDetector.hh.

     {
       return at(address.first);
     }

◆ getModule() [3/4]

const JModule& JDETECTOR::JDetector::getModule ( const JModuleLocation & location ) const

inline

Get module parameters.

Parameters

location module location

Returns: module parameters

Definition at line 207 of file JDetector.hh.

     {
       for (JDetector::const_iterator module = this->begin(); module != this->end(); ++module) {
         if (*module == location) {
           return *module;
         }
       }
  
       THROW(JIndexOutOfRange, "JDetector::getModule()");
     }

◆ getModule() [4/4]

JModule& JDETECTOR::JDetector::getModule ( const JModuleLocation & location )

inline

Get module parameters.

Parameters

location module location

Returns: module parameters

Definition at line 225 of file JDetector.hh.

     {
       for (JDetector::iterator module = this->begin(); module != this->end(); ++module) {
         if (*module == location) {
           return *module;
         }
       }
  
       THROW(JIndexOutOfRange, "JDetector::getModule()");
     }

◆ getPMT() [1/2]

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

inline

Get PMT parameters.

Parameters

address JPMTAddress

Returns: JPMT

Definition at line 243 of file JDetector.hh.

     {
       return at(address.first).at(address.second);
     }

◆ getPMT() [2/2]

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

inline

Get PMT parameters.

Parameters

address JPMTAddress

Returns: JPMT

Definition at line 255 of file JDetector.hh.

     {
       return at(address.first).at(address.second);
     }

◆ read()

virtual JReader& JDETECTOR::JDetector::read ( JReader & in )

inlinevirtual

Read from input.

Parameters

in reader

Returns: reader

Implements JIO::JSerialisable.

Definition at line 370 of file JDetector.hh.

     {
       clear();
  
       int n;
  
       in >> static_cast<JObjectID&>       (*this);
       in >> static_cast<JDetectorVersion&>(*this);
       in >> static_cast<JDetectorHeader&> (*this);
       in >> n;
  
       JPMT::setVersion(getVersion());
  
       for (JModule module; n != 0; --n) {
  
         in >> module;
  
         push_back(module);
       }
  
       return in;
     }

◆ write()

virtual JWriter& JDETECTOR::JDetector::write ( JWriter & out ) const

inlinevirtual

Write to output.

Parameters

out writer

Returns: writer

Implements JIO::JSerialisable.

Definition at line 400 of file JDetector.hh.

     {
       int n = size();
  
       out << static_cast<const JObjectID&>       (*this);
       out << static_cast<const JDetectorVersion&>(*this);
       out << static_cast<const JDetectorHeader&> (*this);
       out << n;
  
       for (const_iterator i = begin(); i != end(); ++i) {
         out << *i;
       }
  
       return out;
     }

◆ getID()

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns: identifier

Definition at line 55 of file JObjectID.hh.

     { 
       return __id;
     }

◆ setID()

void JLANG::JObjectID::setID ( const int id )

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 66 of file JObjectID.hh.

     { 
       this->__id = id;
     }

◆ less() [1/2]

bool JLANG::JObjectID::less ( const JObjectID & object ) const

inlineinherited

Less than method.

Parameters

object object identifier

Returns: true if this identifier less than given identifier; else false

Definition at line 78 of file JObjectID.hh.

     { 
       return this->getID() < object.getID();
     }

◆ less() [2/2]

bool JLANG::JObjectID::less ( const int id ) const

inlineinherited

Less than method.

Parameters

id	identifier

Returns: true if this identifier less than given identifier; else false

Definition at line 90 of file JObjectID.hh.

     { 
       return this->getID() < id;
     }

◆ more()

bool JLANG::JObjectID::more ( const int id ) const

inlineinherited

More than method.

Parameters

id	identifier

Returns: true if this identifier greater than given identifier; else false

Definition at line 102 of file JObjectID.hh.

     { 
       return this->getID() > id;
     }

◆ getVersion() [1/2]

const JVersion& JEEP::JVersion::getVersion ( ) const

inlineinherited

Get version.

Returns: version

Definition at line 57 of file JVersion.hh.

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

◆ getVersion() [2/2]

JVersion& JEEP::JVersion::getVersion ( )

inlineinherited

Get version.

Returns: version

Definition at line 68 of file JVersion.hh.

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

◆ getVariant()

const std::string& JEEP::JVersion::getVariant ( ) const

inlineinherited

Get variant.

Returns: variant

Definition at line 90 of file JVersion.hh.

     { 
       return this->__variant;
     }

◆ setVariant()

void JEEP::JVersion::setVariant ( const std::string & variant )

inlineinherited

Set variant.

Parameters

variant variant

Definition at line 101 of file JVersion.hh.

     { 
       this->__variant = variant;
     }

◆ equals() [1/2]

bool JEEP::JVersion::equals ( const JVersion & version ) const

inlineinherited

Equal method.

Parameters

version version

Returns: true if this version equal to given version; else false

Definition at line 113 of file JVersion.hh.

     {
       return this->getVariant() == version.getVariant();
     }

◆ getEquationParameters()

static JEquationParameters& JDETECTOR::JDetectorHeader::getEquationParameters ( )

inlinestaticinherited

Get equation parameters.

Returns: equation parameters

Definition at line 144 of file JDetectorHeader.hh.

     {
       static JEquationParameters equation;
  
       return equation;
     }

◆ setEquationParameters()

static void JDETECTOR::JDetectorHeader::setEquationParameters ( const JEquationParameters & equation )

inlinestaticinherited

Set equation parameters.

Parameters

equation equation parameters

Definition at line 158 of file JDetectorHeader.hh.

     {
       getEquationParameters() = equation;
     }

◆ getProperties() [1/2]

JProperties JDETECTOR::JDetectorHeader::getProperties ( const JEquationParameters & equation = JDetectorHeader::getEquationParameters() )

inlineinherited

Get properties of this class.

Parameters

equation equation parameters

Definition at line 169 of file JDetectorHeader.hh.

     {
       return JDetectorHeaderHelper(*this, equation);
     }

◆ getProperties() [2/2]

JProperties JDETECTOR::JDetectorHeader::getProperties ( const JEquationParameters & equation = JDetectorHeader::getEquationParameters() ) const

inlineinherited

Get properties of this class.

Parameters

equation equation parameters

Definition at line 180 of file JDetectorHeader.hh.

     {
       return JDetectorHeaderHelper(*this, equation);
     }

◆ getRange()

template<class T, class JComparator_t = std::less<T>>

const range_type& JTOOLS::JRange< T, JComparator_t >::getRange ( ) const

inlineinherited

Get range.

Returns: range

Definition at line 128 of file JRange.hh.

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

◆ setRange() [1/7]

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setRange ( const range_type & range )

inlineinherited

Set range.

Parameters

range range

Definition at line 139 of file JRange.hh.

     {
       static_cast<range_type&>(*this) = range;
     }

◆ setRange() [2/7]

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setRange	(	argument_type	x,
		argument_type	y
	)

inlineinherited

Set lower and upper limit.

Parameters

x	lower limit
y	upper limit

Definition at line 151 of file JRange.hh.

     {
       this->first  = x;
       this->second = y;
     }

◆ setRange() [3/7]

template<class T, class JComparator_t = std::less<T>>

template<class R >

void JTOOLS::JRange< T, JComparator_t >::setRange	(	R	first,
		R	second
	)

inlineinherited

Set range.

The arguments could be values or iterators.

Parameters

first	first
second	second

Definition at line 166 of file JRange.hh.

     {
       using namespace JLANG;
       
       setRange(first, second, JBool<is_iterator<R>::value>());
     }

◆ setRange() [4/7]

template<class T, class JComparator_t = std::less<T>>

template<class iterator_type , class value_type , class result_type >

void JTOOLS::JRange< T, JComparator_t >::setRange	(	iterator_type	__begin,
		iterator_type	__end,
		result_type value_type::*	member
	)

inlineinherited

Set lower and upper limit according to minimal and maximal value in input data, respectively.

Parameters

__begin	begin of data
__end	end of data
member	pointer to data member

Definition at line 182 of file JRange.hh.

     {
       setRange(getMaximum(), getMinimum());
  
       for (iterator_type i = __begin; i != __end; ++i) {
         include((*i).*member);
       }
     }

◆ setRange() [5/7]

template<class T, class JComparator_t = std::less<T>>

template<class iterator_type , class value_type , class result_type >

void JTOOLS::JRange< T, JComparator_t >::setRange	(	iterator_type	__begin,
		iterator_type	__end,
		result_type(value_type::*)() const	function
	)

inlineinherited

Set lower and upper limit according to minimal and maximal value in input data, respectively.

Parameters

__begin	begin of data
__end	end of data
function	pointer to member method

Definition at line 200 of file JRange.hh.

     {
       setRange(getMaximum(), getMinimum());
  
       for (iterator_type i = __begin; i != __end; ++i) {
         include(((*i).*function)());
       }
     }

◆ setRange() [6/7]

template<class T, class JComparator_t = std::less<T>>

template<class R >

void JTOOLS::JRange< T, JComparator_t >::setRange	(	R	first,
		R	second,
		const JLANG::JBool< false > &	option
	)

inlineprotectedinherited

Set range.

Parameters

first	first
second	second
option	false

Definition at line 579 of file JRange.hh.

     {
       setRange((argument_type) first, (argument_type) second);
     }

◆ setRange() [7/7]

template<class T, class JComparator_t = std::less<T>>

template<class R >

void JTOOLS::JRange< T, JComparator_t >::setRange	(	R	first,
		R	second,
		const JLANG::JBool< true > &	option
	)

inlineprotectedinherited

Set range.

Parameters

first	first
second	second
option	true

Definition at line 593 of file JRange.hh.

     {
       setRange(getMaximum(), getMinimum());
  
       for (R i = first; i != second; ++i) {
         include(*i);
       }
     }

◆ getLowerLimit()

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::getLowerLimit ( ) const

inlineinherited

Get lower limit.

Returns: lower limit

Definition at line 215 of file JRange.hh.

     {
       return this->first;
     }

◆ getUpperLimit()

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::getUpperLimit ( ) const

inlineinherited

Get upper limit.

Returns: upper limit

Definition at line 226 of file JRange.hh.

     {
       return this->second;
     }

◆ setLowerLimit()

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setLowerLimit ( argument_type x )

inlineinherited

Set lower limit.

Parameters

x	lower limit

Definition at line 237 of file JRange.hh.

     {
       this->first  = x;
     }

◆ setUpperLimit()

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setUpperLimit ( argument_type y )

inlineinherited

Set upper limit.

Parameters

y	upper limit

Definition at line 248 of file JRange.hh.

     {
       this->second = y;
     }

◆ fixLowerLimit()

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::fixLowerLimit ( argument_type x )

inlineinherited

Fix lower limit.

The range is shifted to the given lower limit.

Parameters

x	lower limit

Definition at line 261 of file JRange.hh.

     {
       this->second += x - this->first;
       this->first   = x;
     }

◆ fixUpperLimit()

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::fixUpperLimit ( argument_type y )

inlineinherited

Fix upper limit.

The range is shifted to the given upper limit.

Parameters

y	upper limit

Definition at line 275 of file JRange.hh.

     {
       this->first  += y - this->second;
       this->second  = y;
     }

◆ equals() [2/2]

template<class T, class JComparator_t = std::less<T>>

bool JTOOLS::JRange< T, JComparator_t >::equals ( const range_type & range ) const

inlineinherited

Equal method.

Parameters

range range

Returns: true if this module range equal to given module range; else false

Definition at line 288 of file JRange.hh.

     {
       return (!this->compare(this->getLowerLimit(), range.getLowerLimit()) &&
               !this->compare(range.getLowerLimit(), this->getLowerLimit()) &&
               !this->compare(this->getUpperLimit(), range.getUpperLimit()) &&
               !this->compare(range.getUpperLimit(), this->getUpperLimit()));
     }

◆ getLength()

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::getLength ( ) const

inlineinherited

Get length (difference between upper and lower limit).

Returns: length

Definition at line 302 of file JRange.hh.

     {
       return getUpperLimit() - getLowerLimit();
     }

◆ is_valid()

template<class T, class JComparator_t = std::less<T>>

bool JTOOLS::JRange< T, JComparator_t >::is_valid ( ) const

inlineinherited

Check validity of range.

Returns: true if lower limit less than or equal to upper limit; else false

Definition at line 313 of file JRange.hh.

     {
       return !compare(getUpperLimit(), getLowerLimit());
     }

◆ operator()()

template<class T, class JComparator_t = std::less<T>>

bool JTOOLS::JRange< T, JComparator_t >::operator() ( argument_type x ) const

inlineinherited

Test whether value is inside range.

Parameters

x value

Returns: true if lower limit <= value <= upper limit; else false

Definition at line 325 of file JRange.hh.

     {
       return (!compare(x, getLowerLimit()) && 
               !compare(getUpperLimit(), x));
     }

◆ constrain()

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::constrain ( argument_type x ) const

inlineinherited

Constrain value to range.

This method returns the original value if it is in this range, else lower limit if value < lower limit or upper limit if value > upper limit.

Parameters

x value

Returns: lower limit <= x <= upper limit

Definition at line 340 of file JRange.hh.

     {
       if (compare(x, getLowerLimit())) { return getLowerLimit(); }
       if (compare(getUpperLimit(), x)) { return getUpperLimit(); }
  
       return x;
     }

◆ mod()

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::mod ( argument_type x ) const

inlineinherited

Modulo value with respect to range.

Parameters

x value

Returns: lower limit <= x <= upper limit

Definition at line 355 of file JRange.hh.

     {
       if      (compare(x, getLowerLimit()))
         return x + getLength() * floor((getUpperLimit() - x) / getLength());
       else if (compare(getUpperLimit(), x))
         return x - getLength() * floor((x - getLowerLimit()) / getLength());
       else
         return x;
     }

◆ overlap()

template<class T, class JComparator_t = std::less<T>>

bool JTOOLS::JRange< T, JComparator_t >::overlap ( const range_type & range ) const

inlineinherited

Test overlap with given range.

The result is equivalent to join(range).is_valid().

Parameters

range range

Returns: true if there is a non-zero overlap; else false

Definition at line 373 of file JRange.hh.

     {  
       return (compare(getLowerLimit(), range.getUpperLimit()) &&
               compare(range.getLowerLimit(), getUpperLimit()));
     }

◆ include()

template<class T, class JComparator_t = std::less<T>>

range_type JTOOLS::JRange< T, JComparator_t >::include ( argument_type x )

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;

Parameters

x value

Returns: range

Definition at line 388 of file JRange.hh.

     {
       if (compare(x, getLowerLimit())) { setLowerLimit(x); }
       if (compare(getUpperLimit(), x)) { setUpperLimit(x); }
  
       return *this;
     }

◆ join()

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::join ( const range_type & range )

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).

Parameters

range range

Definition at line 406 of file JRange.hh.

     {  
       if (compare(getLowerLimit(), range.getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
       if (compare(range.getUpperLimit(), getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }
  
       return *this;      
     }

◆ combine()

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::combine ( const range_type & range )

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.

Parameters

range range

Definition at line 423 of file JRange.hh.

     {  
       if (compare(range.getLowerLimit(), getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
       if (compare(getUpperLimit(), range.getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }
  
       return *this;
     }

◆ add() [1/3]

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::add ( argument_type x )

inlineinherited

Add offset.

Parameters

x offset

Definition at line 437 of file JRange.hh.

     { 
       this->first  += x;
       this->second += x;
  
       return *this;
     }

◆ add() [2/3]

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::add ( const range_type & range )

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.

Parameters

range offset

Definition at line 467 of file JRange.hh.

     { 
       this->first  += range.getLowerLimit();
       this->second += range.getUpperLimit();
  
       return *this;
     }

◆ add() [3/3]

JUTMPosition& JUTM::JUTMPosition::add ( const JUTMPosition & pos )

inlineinherited

Add UTM position.

Parameters

pos	UTM position

Returns: this UTM position

Definition at line 153 of file JUTMPosition.hh.

     {
       east  += pos.getUTMEast();
       north += pos.getUTMNorth();
       z     += pos.getUTMZ();
  
       return *this;
     }

◆ sub() [1/3]

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::sub ( argument_type x )

inlineinherited

Subtract offset.

Parameters

x offset

Definition at line 451 of file JRange.hh.

     { 
       this->first  -= x;
       this->second -= x;
  
       return *this;
     }

◆ sub() [2/3]

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::sub ( const range_type & range )

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.

Parameters

range offset

Definition at line 483 of file JRange.hh.

     { 
       this->first  -= range.getLowerLimit();
       this->second -= range.getUpperLimit();
  
       return *this;
     }

◆ sub() [3/3]

JUTMPosition& JUTM::JUTMPosition::sub ( const JUTMPosition & pos )

inlineinherited

Subtract UTM position.

Parameters

pos	UTM position

Returns: this UTM position

Definition at line 169 of file JUTMPosition.hh.

     {
       east  -= pos.getUTMEast();
       north -= pos.getUTMNorth();
       z     -= pos.getUTMZ();
  
       return *this;
     }

◆ mul() [1/4]

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::mul ( const double factor )

inlineinherited

Multiply range.

Parameters

factor factor

Definition at line 497 of file JRange.hh.

     { 
       this->first  *= factor;
       this->second *= factor;
  
       return *this;
     }

◆ mul() [2/4]

template<class JFirst_t, class JSecond_t>

JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
     }

◆ mul() [3/4]

JUTMPosition& JUTM::JUTMPosition::mul ( const double factor )

inlineinherited

Scale UTM position.

Parameters

factor multiplication factor

Returns: this UTM position

Definition at line 185 of file JUTMPosition.hh.

     {
       east  *= factor;
       north *= factor;
       z     *= factor;
  
       return *this;
     }

◆ mul() [4/4]

JUTMPosition & JMATH::JMath< JUTMPosition , JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
     }

◆ div() [1/2]

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::div ( const double factor )

inlineinherited

Divide range.

Parameters

factor factor

Definition at line 511 of file JRange.hh.

     { 
       this->first  /= factor;
       this->second /= factor;
  
       return *this;
     }

◆ div() [2/2]

JUTMPosition& JUTM::JUTMPosition::div ( const double factor )

inlineinherited

Scale UTM position.

Parameters

factor division factor

Returns: this UTM position

Definition at line 201 of file JUTMPosition.hh.

     {
       east  /= factor;
       north /= factor;
       z     /= factor;
  
       return *this;
     }

◆ getN()

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::getN ( const double R ) const

inlineinherited

Get expected number of occurances of given rate within this interval.

Parameters

R rate

Returns: expectation value

Definition at line 526 of file JRange.hh.

     {
       return R * (getUpperLimit() - getLowerLimit());
     }

◆ getMinimum()

template<class T, class JComparator_t = std::less<T>>

static T JTOOLS::JRange< T, JComparator_t >::getMinimum ( )

inlinestaticinherited

Get minimum possible value.

Returns: minimum possible value

Definition at line 537 of file JRange.hh.

     { 
       return JMATH::JLimits<T>::min();
     }

◆ getMaximum()

template<class T, class JComparator_t = std::less<T>>

static T JTOOLS::JRange< T, JComparator_t >::getMaximum ( )

inlinestaticinherited

Get maximum possible value.

Returns: maximum possible value

Definition at line 548 of file JRange.hh.

     { 
       return JMATH::JLimits<T>::max();
     }

◆ getKey() [1/2]

const key_type& JTOOLS::JPair< T , T >::getKey ( ) const

inlineinherited

Definition at line 123 of file JPair.hh.

123 { return this->first; }

◆ getKey() [2/2]

const std::string& JUTM::JUTMGrid::getKey ( ) const

inlineinherited

Get key.

Returns: key

Definition at line 68 of file JUTMGrid.hh.

     {
       return key;
     }

◆ getValue() [1/2]

const mapped_type& JTOOLS::JPair< T , T >::getValue ( ) const

inlineinherited

Definition at line 124 of file JPair.hh.

124 { return this->second; }

◆ getValue() [2/2]

mapped_type& JTOOLS::JPair< T , T >::getValue ( )

inlineinherited

Definition at line 126 of file JPair.hh.

126 { return this->second; }

◆ getWGS()

const std::string& JUTM::JUTMGrid::getWGS ( ) const

inlineinherited

Get WGS.

Returns: WGS

Definition at line 79 of file JUTMGrid.hh.

     {
       return wgs;
     }

◆ getUTMZone()

const std::string& JUTM::JUTMGrid::getUTMZone ( ) const

inlineinherited

Get UTM zone.

Returns: UTM zone

Definition at line 90 of file JUTMGrid.hh.

     {
       return zone;
     }

◆ toString()

std::string JUTM::JUTMGrid::toString ( ) const

inlineinherited

Convert UTM grid.

Returns: UTM grid

Definition at line 101 of file JUTMGrid.hh.

     {
       return (key + " " + wgs + " " + zone);
     }

◆ valueOf()

static JUTMGrid JUTM::JUTMGrid::valueOf ( const std::string & buffer )

inlinestaticinherited

Extract UTM grid.

Parameters

buffer WGS and UTM zone

Returns: UTM grid

Definition at line 113 of file JUTMGrid.hh.

     {
       JUTMGrid grid;
  
       std::istringstream is(buffer);
  
       if (is >> grid)
         return grid;
       else
         throw JParseError("JUTMGrid::valueOf()");
     }

◆ getUTMPosition()

const JUTMPosition& JUTM::JUTMPosition::getUTMPosition ( ) const

inlineinherited

Get UTM position.

Returns: position

Definition at line 82 of file JUTMPosition.hh.

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

◆ getPosition()

JPosition3D JUTM::JUTMPosition::getPosition ( ) const

inlineinherited

Get position.

Returns: position

Definition at line 93 of file JUTMPosition.hh.

     {
       return JPosition3D(east, north, z);
     }

◆ getUTMEast()

double JUTM::JUTMPosition::getUTMEast ( ) const

inlineinherited

Get UTM east.

Returns: UTM East

Definition at line 104 of file JUTMPosition.hh.

     {
       return this->east;
     }

◆ getUTMNorth()

double JUTM::JUTMPosition::getUTMNorth ( ) const

inlineinherited

Get UTM north.

Returns: UTM North

Definition at line 115 of file JUTMPosition.hh.

     {
       return this->north;
     }

◆ getUTMZ()

double JUTM::JUTMPosition::getUTMZ ( ) const

inlineinherited

Get UTM Z.

Returns: UTM Z

Definition at line 126 of file JUTMPosition.hh.

     {
       return this->z;
     }

◆ negate()

JUTMPosition& JUTM::JUTMPosition::negate ( )

inlineinherited

Negate UTM position.

Returns: this UTM position

Definition at line 137 of file JUTMPosition.hh.

     {
       east  = -east;
       north = -north;
       z     = -z;
  
       return *this;
     }

◆ eq() [1/2]

template<class JClass_t, class JTypelist_t>

template<class JHead_t , class JTail_t >

static bool JLANG::JMultiEquals< JClass_t, JTypelist_t >::eq	(	const JClass_t &	first,
		const JClass_t &	second,
		const JType< JTypeList< JHead_t, JTail_t > > &	type
	)

inlinestaticprotectedinherited

Equals method for composite data types.

Parameters

first	first object
second	second object
type	type

Returns: true if two objects are equal; else false

Definition at line 42 of file JMultiEquals.hh.

     {
       return (static_cast<const JHead_t&>(first)  ==
               static_cast<const JHead_t&>(second) &&
               eq(first, second, JType<JTail_t>()));
     }

◆ eq() [2/2]

template<class JClass_t, class JTypelist_t>

template<class JHead_t >

static bool JLANG::JMultiEquals< JClass_t, JTypelist_t >::eq	(	const JClass_t &	first,
		const JClass_t &	second,
		const JType< JTypeList< JHead_t, JNullType > > &	type
	)

inlinestaticprotectedinherited

Equals method for composite data types.

Parameters

first	first object
second	second object
type	type

Returns: true if two objects are equal; else false

Definition at line 61 of file JMultiEquals.hh.

     {
       return (static_cast<const JHead_t&>(first) ==
               static_cast<const JHead_t&>(second));
     }

Friends And Related Function Documentation

◆ operator>>

std::istream& operator>>	(	std::istream &	in,
		JDetector &	detector
	)

friend

Read detector from input.

Parameters

in	input stream
detector	detector

Returns: input stream

Definition at line 268 of file JDetector.hh.

     {
       using namespace std;
  
       detector.clear();
  
       string buffer;
  
       if (in
           >> detector.comment
           >> static_cast<JObjectID&>(detector)
           >> buffer) {
  
         int n;
         int version = -1;
  
         try {
           version = getDetectorVersion(buffer);
         }
         catch(std::exception&) {}
  
         switch (version) {
  
         case V3:
         case V2:
           in >> static_cast<JDetectorHeader&>(detector);
  
         case V1:
           in >> n;
           detector.setVersion(buffer);
           break;
  
         default:
           detector.setVersion(putDetectorVersion(V1));
           istringstream(buffer) >> n;
           break;
         }
  
         for (JModule module; n != 0 && in >> module; --n) {
           detector.push_back(module);
         }
       }
  
       return in;
     }

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		const JDetector &	detector
	)

friend

Write detector to output.

Parameters

out	output stream
detector	detector

Returns: output stream

Definition at line 322 of file JDetector.hh.

     {
       using namespace std;
  
       const ios::fmtflags format    = out.flags();
       const streamsize    precision = out.precision();
  
       out.setf(ios::fixed);
       out.precision(1);
  
       out << detector.comment;
       out << static_cast<const JObjectID&>(detector);
  
       switch (getDetectorVersion(detector.getVariant())) {
  
       case V3:
       case V2:
         out << " ";
         out << static_cast<const JDetectorVersion&>(detector) << endl;
         out << static_cast<const JDetectorHeader&> (detector) << endl;
         break;
  
       default:
         out << " ";
         break;
       }
  
       out << detector.size() << endl;
  
       out.precision(3);
  
       for (const_iterator i = detector.begin(); i != detector.end(); ++i) {
         out << *i << endl;
       }
  
       out.flags(format);
       out.precision(precision);
  
       return out;
     }

Member Data Documentation

◆ comment

JComment JDETECTOR::JDetector::comment

Definition at line 418 of file JDetector.hh.

◆ __id

int JLANG::JObjectID::__id

protectedinherited

Definition at line 160 of file JObjectID.hh.

◆ __variant

std::string JEEP::JVersion::__variant

protectedinherited

Definition at line 171 of file JVersion.hh.

◆ DEFAULT_RANGE

template<class T, class JComparator_t = std::less<T>>

const JRange< T, JComparator_t > JTOOLS::JRange< T, JComparator_t >::DEFAULT_RANGE

staticinherited

Default range.

This range corresponds to an unphysical range.

Definition at line 558 of file JRange.hh.

◆ compare

template<class T, class JComparator_t = std::less<T>>

JComparator_t JTOOLS::JRange< T, JComparator_t >::compare

inherited

Function object.

Parameters

first	first argument
second	second argument

Returns: true if first < second; else false

Definition at line 568 of file JRange.hh.

◆ first

T JTOOLS::JPair< T , T >::first

inherited

Definition at line 128 of file JPair.hh.

◆ second

T JTOOLS::JPair< T , T >::second

inherited

Definition at line 129 of file JPair.hh.

◆ key

std::string JUTM::JUTMGrid::key

protectedinherited

Definition at line 183 of file JUTMGrid.hh.

◆ wgs

std::string JUTM::JUTMGrid::wgs

protectedinherited

Definition at line 184 of file JUTMGrid.hh.

◆ zone

std::string JUTM::JUTMGrid::zone

protectedinherited

Definition at line 185 of file JUTMGrid.hh.

◆ east

double JUTM::JUTMPosition::east

protectedinherited

Definition at line 265 of file JUTMPosition.hh.

◆ north

double JUTM::JUTMPosition::north

protectedinherited

Definition at line 266 of file JUTMPosition.hh.

◆ z

double JUTM::JUTMPosition::z

protectedinherited

Definition at line 267 of file JUTMPosition.hh.

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

JDetector.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ range_type

◆ argument_type

◆ key_type

◆ mapped_type

Member Enumeration Documentation

◆ JVersion_t

Constructor & Destructor Documentation

◆ JDetector() [1/2]

◆ JDetector() [2/2]

Member Function Documentation

◆ setVersion() [1/2]

◆ setVersion() [2/2]

◆ operator+=()

◆ operator-=()

◆ getModule() [1/4]

◆ getModule() [2/4]

◆ getModule() [3/4]

◆ getModule() [4/4]

◆ getPMT() [1/2]

◆ getPMT() [2/2]

◆ read()

◆ write()

◆ getID()

◆ setID()

◆ less() [1/2]

◆ less() [2/2]

◆ more()

◆ getVersion() [1/2]

◆ getVersion() [2/2]

◆ getVariant()

◆ setVariant()

◆ equals() [1/2]

◆ getEquationParameters()

◆ setEquationParameters()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ getRange()

◆ setRange() [1/7]

◆ setRange() [2/7]

◆ setRange() [3/7]

◆ setRange() [4/7]

◆ setRange() [5/7]

◆ setRange() [6/7]

◆ setRange() [7/7]

◆ getLowerLimit()

◆ getUpperLimit()

◆ setLowerLimit()

◆ setUpperLimit()

◆ fixLowerLimit()

◆ fixUpperLimit()

◆ equals() [2/2]

◆ getLength()

◆ is_valid()

◆ operator()()

◆ constrain()

◆ mod()

◆ overlap()

◆ include()

◆ join()

◆ combine()

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ sub() [1/3]

◆ sub() [2/3]

◆ sub() [3/3]

◆ mul() [1/4]

◆ mul() [2/4]

◆ mul() [3/4]