Detector data structure. More...

#include <JDetector.hh>

Inheritance diagram for JDETECTOR::JDetector:

Public Types
enum	JVersion_t { V1 = 1, V2 = 2, V3 = 3, V4 = 4 }
	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 JObjectID &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 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...

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

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

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

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 accessible for anyone with a KM3NeT account at the google drive.

Definition at line 80 of file JDetector.hh.

Member Typedef Documentation

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

typedef std::pair<T,T> JTOOLS::JRange< T, JComparator_t >::pair_type

inherited

Definition at line 45 of file JRange.hh.

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 46 of file JRange.hh.

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 47 of file JRange.hh.

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

inherited

Definition at line 32 of file JPair.hh.

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

inherited

Definition at line 33 of file JPair.hh.

Member Enumeration Documentation

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.
V4	Version with quaternion and time offset per module.

Definition at line 41 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
       V4 = 4         //!< Version with quaternion and time offset per module
     };

Constructor & Destructor Documentation

JDETECTOR::JDetector::JDetector ( )

inline

Default constructor.

Definition at line 92 of file JDetector.hh.

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

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()
     {
       setVersion();
     }

Member Function Documentation

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);
 
       setVersion();
     }

bool JDETECTOR::JDetector::setVersion	(	const JDetectorVersion::JVersion_t &	version,
		const bool	force = `false`
	)

inline

Set version.

Note that the version is only set to a higher version or when forced to set it.

Parameters

version	version
force	force setting of version

Returns: true if set; else false

Definition at line 143 of file JDetector.hh.

     {
       if (this->getVersion() == JDetectorVersion()  ||  version > getDetectorVersion(this->getVersion())  ||  force) {
 
         setVersion(putDetectorVersion(version));
 
         return true;
       }
 
       return false;
     }

bool JDETECTOR::JDetector::setToLatestVersion ( )

inline

Set to latest version.

Returns: true if set; else false

Definition at line 161 of file JDetector.hh.

     {
       return setVersion(getLatestDetectorVersion<JDetectorVersion::JVersion_t>());
     }

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

inline

Move detector elements.

Parameters

pos	offset position

Returns: this JDetector

Definition at line 173 of file JDetector.hh.

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

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

inline

Move detector elements.

Parameters

pos	offset position

Returns: this JDetector

Definition at line 189 of file JDetector.hh.

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

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

inline

Get module parameters.

Parameters

address module address

Returns: module parameters

Definition at line 205 of file JDetector.hh.

     {
       return at(address.first);
     }

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

inline

Get module parameters.

Parameters

address module address

Returns: module parameters

Definition at line 217 of file JDetector.hh.

     {
       return at(address.first);
     }

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

inline

Get module parameters.

Parameters

location module location

Returns: module parameters

Definition at line 229 of file JDetector.hh.

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

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

inline

Get module parameters.

Parameters

location module location

Returns: module parameters

Definition at line 247 of file JDetector.hh.

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

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

inline

Get PMT parameters.

Parameters

address JPMTAddress

Returns: JPMT

Definition at line 265 of file JDetector.hh.

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

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

inline

Get PMT parameters.

Parameters

address JPMTAddress

Returns: JPMT

Definition at line 277 of file JDetector.hh.

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

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

inlineoverridevirtual

Read from input.

Parameters

in reader

Returns: reader

Implements JIO::JSerialisable.

Definition at line 385 of file JDetector.hh.

     {
       using namespace std;
       using namespace JPP;
 
       clear();
 
       char c;
       int  n;
 
       for (string buffer; in >> c && c == JComment::START_COMMENT; ) {
 
         in >> buffer;
 
         this->comment.add(buffer);
       }
 
       const int N = sizeof(JObjectID);
 
       char buffer[N];
 
       buffer[0] = c;
 
       in.read(&buffer[1], N - 1);
 
       JByteArrayReader is(buffer, N);
 
       is >> static_cast<JObjectID&>       (*this);
       in >> static_cast<JDetectorVersion&>(*this);
       in >> static_cast<JDetectorHeader&> (*this);
       in >> n;
 
       setVersion();
 
       for (JModule module; n != 0; --n) {
 
         in >> module;
 
         push_back(module);
       }
 
       return in;
     }

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

inlineoverridevirtual

Write to output.

Parameters

out writer

Returns: writer

Implements JIO::JSerialisable.

Definition at line 436 of file JDetector.hh.

     {
       using namespace std;
       using namespace JPP;
 
       int  n = size();
       char c = JComment::START_COMMENT;
 
       for (JComment::const_iterator i = this->comment.begin(); i != this->comment.end(); ++i) {
         out <<  c;
         out << *i;
       }
 
       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;
     }

void JDETECTOR::JDetector::setVersion ( ) const

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 470 of file JDetector.hh.

     {
       JModule::setVersion(this->getVersion());
       JPMT   ::setVersion(this->getVersion());
     }

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns: identifier

Definition at line 50 of file JObjectID.hh.

     { 
       return __id;
     }

int& JLANG::JObjectID::getID ( )

inlineinherited

Get identifier.

Returns: identifier

Definition at line 61 of file JObjectID.hh.

     { 
       return __id;
     }

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

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 72 of file JObjectID.hh.

     { 
       this->__id = id;
     }

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 84 of file JObjectID.hh.

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

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 96 of file JObjectID.hh.

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

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 108 of file JObjectID.hh.

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

const JVersion& JDETECTOR::JVersion::getVersion ( ) const

inlineinherited

Get version.

Returns: version

Definition at line 56 of file JVersion.hh.

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

JVersion& JDETECTOR::JVersion::getVersion ( )

inlineinherited

Get version.

Returns: version

Definition at line 67 of file JVersion.hh.

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

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

inlineinherited

Get variant.

Returns: variant

Definition at line 89 of file JVersion.hh.

     { 
       return this->__variant;
     }

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

inlineinherited

Set variant.

Parameters

variant variant

Definition at line 100 of file JVersion.hh.

     { 
       this->__variant = variant;
     }

bool JDETECTOR::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 112 of file JVersion.hh.

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

bool JDETECTOR::JDetectorHeader::equals	(	const JDetectorHeader &	header,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inlineinherited

Check equality.

Parameters

header	header
precision	precision

Returns: true if headers are equal; else false

Definition at line 78 of file JDetectorHeader.hh.

     {
       return (this->getUTMGrid() == header.getUTMGrid() && this->getDisplacement(header.getUTMPosition()) < precision);
     }

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 275 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()));
     }

bool JUTM::JUTMGrid::equals ( const JUTMGrid & grid ) const

inlineinherited

Check equality.

Parameters

grid UTM grid

Returns: true if grids are equal; else false

Definition at line 128 of file JUTMGrid.hh.

     {
       return (this->getKey()     == grid.getKey()  &&
               this->getWGS()     == grid.getWGS()  &&
               this->getUTMZone() == grid.getUTMZone());
     }

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

inlinestaticinherited

Get equation parameters.

Returns: equation parameters

Definition at line 162 of file JDetectorHeader.hh.

     {
       static JEquationParameters equation;
 
       return equation;
     }

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

inlinestaticinherited

Set equation parameters.

Parameters

equation equation parameters

Definition at line 176 of file JDetectorHeader.hh.

     {
       getEquationParameters() = equation;
     }

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

inlineinherited

Get properties of this class.

Parameters

equation equation parameters

Definition at line 187 of file JDetectorHeader.hh.

     {
       return JDetectorHeaderHelper(*this, equation);
     }

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

inlineinherited

Get properties of this class.

Parameters

equation equation parameters

Definition at line 198 of file JDetectorHeader.hh.

     {
       return JDetectorHeaderHelper(*this, equation);
     }

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

JTOOLS::JRange< T, JComparator_t >::operator pair_type ( ) const

inlineinherited

Type conversion operator.

Returns: piar

Definition at line 124 of file JRange.hh.

     {
       return pair_type(getLowerLimit(), getUpperLimit());
     }

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 135 of file JRange.hh.

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

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 146 of file JRange.hh.

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

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 158 of file JRange.hh.

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

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 173 of file JRange.hh.

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

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

template<class JElement_t , class JAllocator_t >

void JTOOLS::JRange< T, JComparator_t >::setRange ( const array_type< JElement_t, JAllocator_t > & buffer )

inlineinherited

Set lower and upper limit according to input data.

Parameters

buffer input data

Definition at line 187 of file JRange.hh.

     {
       setRange(getMaximum(), getMinimum());
 
       for (typename array_type<JElement_t, JAllocator_t>::const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
         include(*i);
       }
     }

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 577 of file JRange.hh.

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

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 591 of file JRange.hh.

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

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 202 of file JRange.hh.

     {
       return this->first;
     }

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 213 of file JRange.hh.

     {
       return this->second;
     }

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 224 of file JRange.hh.

     {
       this->first  = x;
     }

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 235 of file JRange.hh.

     {
       this->second = y;
     }

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 248 of file JRange.hh.

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

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 262 of file JRange.hh.

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

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 289 of file JRange.hh.

     {
       return getUpperLimit() - getLowerLimit();
     }

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

void JTOOLS::JRange< T, JComparator_t >::setLength ( argument_type length )

inlineinherited

Set length (difference between upper and lower limit).

Parameters

length length

Definition at line 300 of file JRange.hh.

     {
       setUpperLimit(getLowerLimit() + length);
     }

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 311 of file JRange.hh.

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

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 323 of file JRange.hh.

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

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 338 of file JRange.hh.

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

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 353 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;
     }

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 371 of file JRange.hh.

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

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 386 of file JRange.hh.

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

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 404 of file JRange.hh.

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

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 421 of file JRange.hh.

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

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 435 of file JRange.hh.

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

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 465 of file JRange.hh.

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

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

inlineinherited

Add UTM position.

Parameters

pos	UTM position

Returns: this UTM position

Definition at line 177 of file JUTMPosition.hh.

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

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 449 of file JRange.hh.

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

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 481 of file JRange.hh.

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

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

inlineinherited

Subtract UTM position.

Parameters

pos	UTM position

Returns: this UTM position

Definition at line 193 of file JUTMPosition.hh.

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

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 495 of file JRange.hh.

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

template<class JFirst_t, class JSecond_t = JNullType>

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 357 of file JMath.hh.

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

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

inlineinherited

Scale UTM position.

Parameters

factor multiplication factor

Returns: this UTM position

Definition at line 209 of file JUTMPosition.hh.

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

template<class JFirst_t, class JSecond_t = JNullType>

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 357 of file JMath.hh.

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

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 509 of file JRange.hh.

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

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

inlineinherited

Scale UTM position.

Parameters

factor division factor

Returns: this UTM position

Definition at line 225 of file JUTMPosition.hh.

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

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 524 of file JRange.hh.

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

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 535 of file JRange.hh.

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

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 546 of file JRange.hh.

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

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

inlineinherited

Definition at line 123 of file JPair.hh.

123 { return this->first; }

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

T first

Definition: JPair.hh:128

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

inlineinherited

Get key.

Returns: key

Definition at line 94 of file JUTMGrid.hh.

     {
       return key;
     }

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

inlineinherited

Definition at line 124 of file JPair.hh.

124 { return this->second; }

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

T second

Definition: JPair.hh:129

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

inlineinherited

Definition at line 126 of file JPair.hh.

126 { return this->second; }

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

T second

Definition: JPair.hh:129

const JUTMGrid& JUTM::JUTMGrid::getUTMGrid ( ) const

inlineinherited

Get UTM grid.

Returns: UTM grid

Definition at line 72 of file JUTMGrid.hh.

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

void JUTM::JUTMGrid::setUTMGrid ( const JUTMGrid & grid )

inlineinherited

Set UTM grid.

Parameters

grid UTM grid

Definition at line 83 of file JUTMGrid.hh.

     {
       static_cast<JUTMGrid&>(*this) = grid;
     }

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

inlineinherited

Get WGS.

Returns: WGS

Definition at line 105 of file JUTMGrid.hh.

     {
       return wgs;
     }

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

inlineinherited

Get UTM zone.

Returns: UTM zone

Definition at line 116 of file JUTMGrid.hh.

     {
       return zone;
     }

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

inlineinherited

Convert UTM grid.

Returns: UTM grid

Definition at line 141 of file JUTMGrid.hh.

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

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 153 of file JUTMGrid.hh.

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

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

inlineinherited

Get UTM position.

Returns: position

Definition at line 84 of file JUTMPosition.hh.

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

void JUTM::JUTMPosition::setUTMPosition ( const JUTMPosition & position )

inlineinherited

Set UTM position.

Parameters

position position

Definition at line 95 of file JUTMPosition.hh.

     {
       static_cast<JUTMPosition&>(*this) = position;
     }

JPosition3D JUTM::JUTMPosition::getPosition ( ) const

inlineinherited

Get position.

Returns: position

Definition at line 106 of file JUTMPosition.hh.

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

JUTM::JUTMPosition::operator JPosition3D ( ) const

inlineinherited

Type conversion operator.

Returns: position

Definition at line 117 of file JUTMPosition.hh.

     {
       return getPosition();
     }

double JUTM::JUTMPosition::getUTMEast ( ) const

inlineinherited

Get UTM east.

Returns: UTM East

Definition at line 128 of file JUTMPosition.hh.

     {
       return this->east;
     }

double JUTM::JUTMPosition::getUTMNorth ( ) const

inlineinherited

Get UTM north.

Returns: UTM North

Definition at line 139 of file JUTMPosition.hh.

     {
       return this->north;
     }

double JUTM::JUTMPosition::getUTMZ ( ) const

inlineinherited

Get UTM Z.

Returns: UTM Z

Definition at line 150 of file JUTMPosition.hh.

     {
       return this->z;
     }

JUTMPosition& JUTM::JUTMPosition::negate ( )

inlineinherited

Negate UTM position.

Returns: this UTM position

Definition at line 161 of file JUTMPosition.hh.

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

double JUTM::JUTMPosition::getDisplacement ( const JUTMPosition & position ) const

inlineinherited

Get displacement to position.

The displacement corresponds to the 2D distance in the (East,North) plane.

Parameters

position position

Returns: displacement

Definition at line 243 of file JUTMPosition.hh.

     {
       const double x = this->getUTMEast()  - position.getUTMEast();
       const double y = this->getUTMNorth() - position.getUTMNorth();
 
       return sqrt(x*x + y*y);
     }

Friends And Related Function Documentation

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 290 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) {
 
         default:
           in >> static_cast<JDetectorHeader&>(detector);
 
         case V1:
           in >> n;
           detector.setVersion(buffer);
           break;
 
         case -1:
           detector.setVersion(putDetectorVersion(V1));
           istringstream(buffer) >> n;
           break;
         }
 
         for (JModule module; n != 0 && in >> module; --n) {
           detector.push_back(module);
         }
       }
 
       return in;
     }

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 343 of file JDetector.hh.

     {
       using namespace std;
       using namespace JPP;
 
       setFormat<JPosition3D>  (JFormat_t(9, 3, std::ios::fixed | std::ios::showpos));
       setFormat<JDirection3D> (JFormat_t(9, 6, std::ios::fixed | std::ios::showpos));
       setFormat<JQuaternion3D>(JFormat_t(9, 6, std::ios::fixed | std::ios::showpos));
       setFormat<JCalibration> (JFormat_t(9, 3, std::ios::fixed | std::ios::showpos));
                            
       out << detector.comment;
       out << static_cast<const JObjectID&>(detector);
 
       switch (getDetectorVersion(detector.getVariant())) {
 
       default:
         out << " ";
         out << static_cast<const JDetectorVersion&>(detector) << endl;
         out << static_cast<const JDetectorHeader&> (detector) << endl;
         break;
 
       case V1:
         out << " ";
         break;
       }
 
       out << detector.size() << endl;
 
       for (const_iterator i = detector.begin(); i != detector.end(); ++i) {
         out << *i << endl;
       }
 
       return out;
     }

Member Data Documentation

JComment JDETECTOR::JDetector::comment

Definition at line 462 of file JDetector.hh.

int JLANG::JObjectID::__id

protectedinherited

Definition at line 140 of file JObjectID.hh.

std::string JDETECTOR::JVersion::__variant

protectedinherited

Definition at line 170 of file JVersion.hh.

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 556 of file JRange.hh.

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 566 of file JRange.hh.

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

inherited

Definition at line 128 of file JPair.hh.

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

inherited

Definition at line 129 of file JPair.hh.

std::string JUTM::JUTMGrid::key

protectedinherited

Definition at line 223 of file JUTMGrid.hh.

std::string JUTM::JUTMGrid::wgs

protectedinherited

Definition at line 224 of file JUTMGrid.hh.

std::string JUTM::JUTMGrid::zone

protectedinherited

Definition at line 225 of file JUTMGrid.hh.

double JUTM::JUTMPosition::east

protectedinherited

Definition at line 311 of file JUTMPosition.hh.

double JUTM::JUTMPosition::north

protectedinherited

Definition at line 312 of file JUTMPosition.hh.

double JUTM::JUTMPosition::z

protectedinherited

Definition at line 313 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

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation