Data structure for detector header. More...

#include <JDetectorHeader.hh>

Inheritance diagram for JDETECTOR::JDetectorHeader:

Classes
class	JDetectorHeaderHelper
	Auxiliary class for I/O of detector header. More...

Public Types
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
	JDetectorHeader ()
	Default constructor.

	JDetectorHeader (const JUTCTimeRange &range, const JUTMGrid &grid, const JUTMPosition &pos)
	Constructor.

const JDetectorHeader &	getDetectorHeader () const
	Get detector header.

bool	equals (const JDetectorHeader &header, const double precision=std::numeric_limits< double >::min()) const
	Check equality.

JProperties	getProperties (const JEquationParameters &equation=JDetectorHeader::getEquationParameters())
	Get properties of this class.

JProperties	getProperties (const JEquationParameters &equation=JDetectorHeader::getEquationParameters()) const
	Get properties of this class.

const JUTCTimeRange &	getUTCTimeRange () const
	Get UTC time range.

JUTCTimeRange &	getUTCTimeRange ()
	Get UTC time range.

void	setUTCTimeRange (const JRange< double > &timerange)
	Set UTC time range.

	operator pair_type () const
	Type conversion operator.

const range_type &	getRange () const
	Get range.

void	setRange (const range_type &range)
	Set range.

void	setRange (argument_type x, argument_type y)
	Set lower and upper limit.

template<class R >
void	setRange (R first, R second)
	Set range.

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.

T	getLowerLimit () const
	Get lower limit.

T	getUpperLimit () const
	Get upper limit.

void	setLowerLimit (argument_type x)
	Set lower limit.

void	setUpperLimit (argument_type y)
	Set upper limit.

void	fixLowerLimit (argument_type x)
	Fix lower limit.

void	fixUpperLimit (argument_type y)
	Fix upper limit.

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

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

void	setLength (argument_type length)
	Set length (difference between upper and lower limit).

bool	is_valid () const
	Check validity of range.

bool	in_range (argument_type x) const
	Test whether value is inside range.

bool	operator() (argument_type x) const
	Test whether value is inside range.

T	constrain (argument_type x) const
	Constrain value to range.

T	mod (argument_type x) const
	Modulo value with respect to range.

bool	overlap (const range_type &range) const
	Test overlap with given range.

range_type &	include (argument_type x)
	Include given value to range.

range_type &	join (const range_type &range)
	Join ranges.

range_type &	combine (const range_type &range)
	Combine ranges.

range_type &	add (argument_type x)
	Add offset.

range_type &	add (const range_type &range)
	Add offsets.

range_type &	sub (argument_type x)
	Subtract offset.

range_type &	sub (const range_type &range)
	Subtract offsets.

range_type &	mul (const double factor)
	Multiply range.

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

range_type &	div (const double factor)
	Divide range.

const key_type &	getKey () const

const mapped_type &	getValue () const

mapped_type &	getValue ()

const JUTMGrid &	getUTMGrid () const
	Get UTM grid.

void	setUTMGrid (const JUTMGrid &grid)
	Set UTM grid.

const std::string &	getKey () const
	Get key.

const std::string &	getWGS () const
	Get WGS.

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

int	getUTMValue () const
	Get UTM zone by numerical value.

bool	equals (const JUTMGrid &grid) const
	Check equality.

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

const JUTMPosition &	getUTMPosition () const
	Get UTM position.

void	setUTMPosition (const JUTMPosition &position)
	Set UTM position.

JPosition3D	getPosition () const
	Get position.

	operator JPosition3D () const
	Type conversion operator.

double	getUTMEast () const
	Get UTM east.

double	getUTMNorth () const
	Get UTM north.

double	getUTMZ () const
	Get UTM Z.

double	getX () const
	Get x.

double	getY () const
	Get y.

double	getZ () const
	Get z.

JUTMPosition &	negate ()
	Negate UTM position.

JUTMPosition &	add (const JUTMPosition &pos)
	Add UTM position.

JUTMPosition &	sub (const JUTMPosition &pos)
	Subtract UTM position.

JUTMPosition &	mul (const double factor)
	Scale UTM position.

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

JUTMPosition &	div (const double factor)
	Scale UTM position.

double	getDisplacement (const JUTMPosition &position) const
	Get displacement to position.

Static Public Member Functions
static JEquationParameters &	getEquationParameters ()
	Get equation parameters.

static void	setEquationParameters (const JEquationParameters &equation)
	Set equation parameters.

static T	getMinimum ()
	Get minimum possible value.

static T	getMaximum ()
	Get maximum possible value.

static JRange< T, JComparator_t >	DEFAULT_RANGE ()
	Default range.

static JUTMGrid	valueOf (const std::string &buffer)
	Extract UTM grid.

Public Attributes
JComparator_t	compare
	Function object for comparisons.

T	first

T	second

Protected Member Functions
template<class R >
void	setRange (R first, R second, const JLANG::JBool< false > &option)
	Set range.

template<class R >
void	setRange (R first, R second, const JLANG::JBool< true > &option)
	Set range.

Protected Attributes
std::string	key

std::string	wgs

std::string	zone

double	east

double	north

double	z

Friends
std::istream &	operator>> (std::istream &in, JDetectorHeader &header)
	Read detector header from input.

std::ostream &	operator<< (std::ostream &out, const JDetectorHeader &header)
	Write detector header to output.

JReader &	operator>> (JReader &in, JDetectorHeader &header)
	Read detector header from input.

JWriter &	operator<< (JWriter &out, const JDetectorHeader &header)
	Write detector header to output.

Detailed Description

Data structure for detector header.

Definition at line 38 of file JDetectorHeader.hh.

Member Typedef Documentation

◆ pair_type

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

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

inherited

Definition at line 45 of file JRange.hh.

◆ range_type

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

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

inherited

Definition at line 46 of file JRange.hh.

◆ argument_type

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

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

inherited

Definition at line 47 of file JRange.hh.

◆ key_type

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

inherited

Definition at line 32 of file JPair.hh.

◆ mapped_type

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

inherited

Definition at line 33 of file JPair.hh.

Constructor & Destructor Documentation

◆ JDetectorHeader() [1/2]

JDETECTOR::JDetectorHeader::JDetectorHeader ( )

inline

Default constructor.

Definition at line 48 of file JDetectorHeader.hh.

                      :
      JUTCTimeRange(),
      JUTMGrid     (),
      JUTMPosition ()
    {}

◆ JDetectorHeader() [2/2]

JDETECTOR::JDetectorHeader::JDetectorHeader	(	const JUTCTimeRange &	range,
		const JUTMGrid &	grid,
		const JUTMPosition &	pos )

inline

Constructor.

Parameters

range	UTC time range
grid	UTM grid
pos	UTM position

Definition at line 62 of file JDetectorHeader.hh.

                                              :
      JUTCTimeRange(range),
      JUTMGrid     (grid),
      JUTMPosition (pos)
    {}

Member Function Documentation

◆ getDetectorHeader()

const JDetectorHeader & JDETECTOR::JDetectorHeader::getDetectorHeader ( ) const

inline

Get detector header.

Returns: header

Definition at line 76 of file JDetectorHeader.hh.

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

◆ equals() [1/3]

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

inline

Check equality.

Parameters

header	header
precision	precision

Returns: true if headers are equal; else false

Definition at line 89 of file JDetectorHeader.hh.

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

◆ getEquationParameters()

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

inlinestatic

Get equation parameters.

Returns: equation parameters

Definition at line 173 of file JDetectorHeader.hh.

    {
      static JEquationParameters equation;
 
      return equation;
    }

◆ setEquationParameters()

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

inlinestatic

Set equation parameters.

Parameters

equation equation parameters

Definition at line 187 of file JDetectorHeader.hh.

    {
      getEquationParameters() = equation;
    }

◆ getProperties() [1/2]

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

inline

Get properties of this class.

Parameters

equation equation parameters

Definition at line 198 of file JDetectorHeader.hh.

    {
      return JDetectorHeaderHelper(*this, equation);
    }

◆ getProperties() [2/2]

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

inline

Get properties of this class.

Parameters

equation equation parameters

Definition at line 209 of file JDetectorHeader.hh.

    {
      return JDetectorHeaderHelper(*this, equation);
    }

◆ getUTCTimeRange() [1/2]

const JUTCTimeRange & JUTC::JUTCTimeRange::getUTCTimeRange ( ) const

inlineinherited

Get UTC time range.

Returns: UTC time range

Definition at line 63 of file JUTCTimeRange.hh.

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

◆ getUTCTimeRange() [2/2]

JUTCTimeRange & JUTC::JUTCTimeRange::getUTCTimeRange ( )

inlineinherited

Get UTC time range.

Returns: UTC time range

Definition at line 74 of file JUTCTimeRange.hh.

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

◆ setUTCTimeRange()

void JUTC::JUTCTimeRange::setUTCTimeRange ( const JRange< double > & timerange )

inlineinherited

Set UTC time range.

Parameters

timerange UTC time range

Definition at line 85 of file JUTCTimeRange.hh.

    {
      static_cast<JUTCTimeRange&>(*this) = timerange;
    }

◆ operator pair_type()

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

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

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

◆ setRange() [1/6]

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

◆ setRange() [2/6]

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

◆ setRange() [3/6]

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

◆ setRange() [4/6]

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

◆ setRange() [5/6]

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

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

◆ setRange() [6/6]

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 590 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 202 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 213 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 224 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 235 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 248 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 262 of file JRange.hh.

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

◆ equals() [2/3]

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 range is equal to given 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()));
    }

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

    {
      return getUpperLimit() - getLowerLimit();
    }

◆ setLength()

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

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

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

◆ in_range()

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

bool JTOOLS::JRange< T, JComparator_t >::in_range ( 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));
    }

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

    {
      return in_range(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 350 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 365 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.

Parameters

range range

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

Definition at line 382 of file JRange.hh.

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

◆ 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 397 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 415 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 432 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 446 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 476 of file JRange.hh.

    { 
      this->first  += range.getLowerLimit();
      this->second += range.getUpperLimit();
 
      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 460 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 492 of file JRange.hh.

    { 
      this->first  -= range.getLowerLimit();
      this->second -= range.getUpperLimit();
 
      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 506 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 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().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 520 of file JRange.hh.

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

◆ 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 534 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 545 of file JRange.hh.

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

◆ DEFAULT_RANGE()

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

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

inlinestaticinherited

Default range.

This range corresponds to an unphysical range.

Definition at line 555 of file JRange.hh.

    {
      return JRange<T, JComparator_t>(JRange<T, JComparator_t>::getMaximum(), 
                                      JRange<T, JComparator_t>::getMinimum());
    }

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

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

◆ getUTMGrid()

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

inlineinherited

Get UTM grid.

Returns: UTM grid

Definition at line 73 of file JUTMGrid.hh.

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

◆ setUTMGrid()

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

inlineinherited

Set UTM grid.

Parameters

grid UTM grid

Definition at line 84 of file JUTMGrid.hh.

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

◆ getKey() [2/2]

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

inlineinherited

Get key.

Returns: key

Definition at line 95 of file JUTMGrid.hh.

    {
      return key;
    }

◆ getWGS()

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

inlineinherited

Get WGS.

Returns: WGS

Definition at line 106 of file JUTMGrid.hh.

    {
      return wgs;
    }

◆ getUTMZone()

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

inlineinherited

Get UTM zone.

Returns: UTM zone

Definition at line 117 of file JUTMGrid.hh.

    {
      return zone;
    }

◆ getUTMValue()

int JUTM::JUTMGrid::getUTMValue ( ) const

inlineinherited

Get UTM zone by numerical value.

Returns: UTM zone

Definition at line 128 of file JUTMGrid.hh.

    {
      using namespace std;
 
      int value = 0;
 
      for (string::const_iterator i = zone.begin(); i != zone.end(); ++i) {
        if (isdigit(*i))
          value = 10 * value  +  (*i - '0');
        else
          break;
      }
      
      return value;
    }

◆ equals() [3/3]

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

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

◆ toString()

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

inlineinherited

Convert UTM grid.

Returns: UTM grid

Definition at line 164 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 176 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 84 of file JUTMPosition.hh.

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

◆ setUTMPosition()

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

◆ getPosition()

JPosition3D JUTM::JUTMPosition::getPosition ( ) const

inlineinherited

Get position.

Returns: position

Definition at line 106 of file JUTMPosition.hh.

    {
      return JPosition3D(this->getX(), this->getY(), this->getZ());
    }

◆ operator JPosition3D()

JUTM::JUTMPosition::operator JPosition3D ( ) const

inlineinherited

Type conversion operator.

Returns: position

Definition at line 117 of file JUTMPosition.hh.

    {
      return getPosition();
    }

◆ getUTMEast()

double JUTM::JUTMPosition::getUTMEast ( ) const

inlineinherited

Get UTM east.

Returns: UTM East

Definition at line 128 of file JUTMPosition.hh.

    {
      return this->east;
    }

◆ getUTMNorth()

double JUTM::JUTMPosition::getUTMNorth ( ) const

inlineinherited

Get UTM north.

Returns: UTM North

Definition at line 139 of file JUTMPosition.hh.

    {
      return this->north;
    }

◆ getUTMZ()

double JUTM::JUTMPosition::getUTMZ ( ) const

inlineinherited

Get UTM Z.

Returns: UTM Z

Definition at line 150 of file JUTMPosition.hh.

    {
      return this->z;
    }

◆ getX()

double JUTM::JUTMPosition::getX ( ) const

inlineinherited

Get x.

Returns: UTM East

Definition at line 161 of file JUTMPosition.hh.

    {
      return this->east;
    }

◆ getY()

double JUTM::JUTMPosition::getY ( ) const

inlineinherited

Get y.

Returns: UTM North

Definition at line 172 of file JUTMPosition.hh.

    {
      return this->north;
    }

◆ getZ()

double JUTM::JUTMPosition::getZ ( ) const

inlineinherited

Get z.

Returns: UTM Z

Definition at line 183 of file JUTMPosition.hh.

    {
      return this->z;
    }

◆ negate()

JUTMPosition & JUTM::JUTMPosition::negate ( )

inlineinherited

Negate UTM position.

Returns: this UTM position

Definition at line 194 of file JUTMPosition.hh.

    {
      east  = -east;
      north = -north;
      z     = -z;
 
      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 210 of file JUTMPosition.hh.

    {
      east  += pos.getUTMEast();
      north += pos.getUTMNorth();
      z     += pos.getUTMZ();
 
      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 226 of file JUTMPosition.hh.

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

◆ 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 242 of file JUTMPosition.hh.

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

◆ mul() [4/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 354 of file JMath.hh.

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

◆ 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 258 of file JUTMPosition.hh.

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

◆ getDisplacement()

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 276 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 Symbol Documentation

◆ operator>> [1/2]

std::istream & operator>>	(	std::istream &	in,
		JDetectorHeader &	header )

friend

Read detector header from input.

Parameters

in	input stream
header	header

Returns: input stream

Definition at line 103 of file JDetectorHeader.hh.

    {
      in >> static_cast<JUTCTimeRange&>(header);
      in >> static_cast<JUTMGrid&>     (header);
      in >> static_cast<JUTMPosition&> (header);
 
      return in;
    }

◆ operator<< [1/2]

std::ostream & operator<<	(	std::ostream &	out,
		const JDetectorHeader &	header )

friend

Write detector header to output.

Parameters

out	output stream
header	header

Returns: output stream

Definition at line 120 of file JDetectorHeader.hh.

    {
      using namespace std;
      
      out << static_cast<const JUTCTimeRange&>(header);
      out << endl;
      out << static_cast<const JUTMGrid&>     (header);
      out << ' ';
      out << static_cast<const JUTMPosition&> (header);
 
      return out;
    }

◆ operator>> [2/2]

JReader & operator>>	(	JReader &	in,
		JDetectorHeader &	header )

friend

Read detector header from input.

Parameters

in	input stream
header	header

Returns: input stream

Definition at line 141 of file JDetectorHeader.hh.

    {
      in >> static_cast<JUTCTimeRange&>(header);
      in >> static_cast<JUTMGrid&>     (header);
      in >> static_cast<JUTMPosition&> (header);
 
      return in;
    }

◆ operator<< [2/2]

JWriter & operator<<	(	JWriter &	out,
		const JDetectorHeader &	header )

friend

Write detector header to output.

Parameters

out	output stream
header	header

Returns: output stream

Definition at line 158 of file JDetectorHeader.hh.

    {
      out << static_cast<const JUTCTimeRange&>(header);
      out << static_cast<const JUTMGrid&>     (header);
      out << static_cast<const JUTMPosition&> (header);
 
      return out;
    }

Member Data Documentation

◆ compare

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

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

inherited

Function object for comparisons.

Definition at line 565 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 246 of file JUTMGrid.hh.

◆ wgs

std::string JUTM::JUTMGrid::wgs

protectedinherited

Definition at line 247 of file JUTMGrid.hh.

◆ zone

std::string JUTM::JUTMGrid::zone

protectedinherited

Definition at line 248 of file JUTMGrid.hh.

◆ east

double JUTM::JUTMPosition::east

protectedinherited

Definition at line 344 of file JUTMPosition.hh.

◆ north

double JUTM::JUTMPosition::north

protectedinherited

Definition at line 345 of file JUTMPosition.hh.

◆ z

double JUTM::JUTMPosition::z

protectedinherited

Definition at line 346 of file JUTMPosition.hh.

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

JDetectorHeader.hh

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ pair_type

◆ range_type

◆ argument_type

◆ key_type

◆ mapped_type

Constructor & Destructor Documentation

◆ JDetectorHeader() [1/2]

◆ JDetectorHeader() [2/2]

Member Function Documentation

◆ getDetectorHeader()

◆ equals() [1/3]

◆ getEquationParameters()

◆ setEquationParameters()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ getUTCTimeRange() [1/2]

◆ getUTCTimeRange() [2/2]

◆ setUTCTimeRange()

◆ operator pair_type()

◆ getRange()

◆ setRange() [1/6]

◆ setRange() [2/6]

◆ setRange() [3/6]

◆ setRange() [4/6]

◆ setRange() [5/6]

◆ setRange() [6/6]

◆ getLowerLimit()

◆ getUpperLimit()

◆ setLowerLimit()

◆ setUpperLimit()

◆ fixLowerLimit()

◆ fixUpperLimit()

◆ equals() [2/3]

◆ getLength()

◆ setLength()

◆ is_valid()

◆ in_range()

◆ operator()()

◆ constrain()

◆ mod()

◆ overlap()

◆ include()

◆ join()

◆ combine()

◆ add() [1/3]

◆ add() [2/3]

◆ sub() [1/3]

◆ sub() [2/3]

◆ mul() [1/4]

◆ mul() [2/4]

◆ div() [1/2]

◆ getMinimum()

◆ getMaximum()

◆ DEFAULT_RANGE()

◆ getKey() [1/2]

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getUTMGrid()

◆ setUTMGrid()

◆ getKey() [2/2]

◆ getWGS()

◆ getUTMZone()

◆ getUTMValue()

◆ equals() [3/3]

◆ toString()

◆ valueOf()

◆ getUTMPosition()

◆ setUTMPosition()

◆ getPosition()

◆ operator JPosition3D()