JASTRONOMY::JSourceLocation Struct Reference

Location of astrophysical source. More...

#include <JAstronomy.hh>

Inheritance diagram for JASTRONOMY::JSourceLocation:

Public Member Functions
	JSourceLocation ()
	Default constructor.
	JSourceLocation (const double dec, const double ra)
	Constructor.
	JSourceLocation (const double t1_s, const JSourceLocationJ2000 &location)
	Conversion constructor.
	JSourceLocation (const JAngle3D &angle)
	Constructor.
const JSourceLocation &	getSourceLocation () const
	Get source location.
	operator JAngle3D () const
	Type conversion operator.
double	getDeclination () const
	Get declination.
double	getRightAscension () const
	Get right ascension.
double	getDot (const JSourceLocation &location) const
	Dot product.
void	set (const angle_type_deg &angle)
	Convert angle.
bool	equals (const angle_type &angle, const double precision=std::numeric_limits< double >::min()) const
	Check equality.

Protected Attributes
double	_theta_
double	_phi_

Detailed Description

Location of astrophysical source.

Definition at line 439 of file JAstronomy.hh.

Constructor & Destructor Documentation

JSourceLocation() [1/4]

JASTRONOMY::JSourceLocation::JSourceLocation ( )

inline

Default constructor.

Definition at line 445 of file JAstronomy.hh.

    {}

JSourceLocation() [2/4]

JASTRONOMY::JSourceLocation::JSourceLocation ( const double dec, const double ra )

inline

Constructor.

Parameters

dec	declination [rad]
ra	right ascension [rad]

Definition at line 455 of file JAstronomy.hh.

                                             :
      angle_type_rad(dec, ra)
    {}

JSourceLocation() [3/4]

JASTRONOMY::JSourceLocation::JSourceLocation ( const double t1_s, const JSourceLocationJ2000 & location )

inline

Conversion constructor.

Parameters

t1_s	time since MJD [s]
location	source location

Definition at line 620 of file JAstronomy.hh.

                                                                                          :
    angle_type_rad(J2000::convert(t1_s, location, J2000::FROM))
  {}

JSourceLocation() [4/4]

JASTRONOMY::JSourceLocation::JSourceLocation ( const JAngle3D & angle )

inline

Constructor.

Parameters

angle

polar angles [rad]

Definition at line 475 of file JAstronomy.hh.

                                                  :
      angle_type_rad(PI/2 - angle.getTheta(), angle.getPhi())
    {}

Member Function Documentation

getSourceLocation()

const JSourceLocation & JASTRONOMY::JSourceLocation::getSourceLocation ( ) const

inline

Get source location.

Returns

source location

Definition at line 485 of file JAstronomy.hh.

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

operator JAngle3D()

JASTRONOMY::JSourceLocation::operator JAngle3D ( ) const

inline

Type conversion operator.

Returns

polar angles [rad]

Definition at line 496 of file JAstronomy.hh.

    {
      return JAngle3D(PI/2 - _theta_, _phi_);
    }

getDeclination()

double JASTRONOMY::JSourceLocation::getDeclination ( ) const

inline

Get declination.

Definition at line 502 of file JAstronomy.hh.

getRightAscension()

double JASTRONOMY::JSourceLocation::getRightAscension ( ) const

inline

Get right ascension.

Definition at line 503 of file JAstronomy.hh.

getDot()

double JASTRONOMY::JSourceLocation::getDot ( const JSourceLocation & location ) const

inline

Dot product.

Parameters

location

source location

Returns

dot product

Definition at line 512 of file JAstronomy.hh.

    {
      return 
        cos(this->_theta_) * cos(location._theta_) * cos(this->_phi_ - location._phi_) +
        sin(this->_theta_) * sin(location._theta_);
    }

set()

void JASTRONOMY::angle_type_rad::set ( const angle_type_deg & angle )

inlineinherited

Convert angle.

Parameters

angle

angle [rad]

Definition at line 293 of file JAstronomy.hh.

    {
      static_cast<angle_type_rad&>(*this) = angle_type_rad(angle);
    }

equals()

bool JASTRONOMY::angle_type::equals ( const angle_type & angle, const double precision = std::numeric_limits<double>::min() ) const

inlineinherited

Check equality.

Parameters

angle	pair of angles
precision	precision

Returns

true if angles are equal; else false

Definition at line 194 of file JAstronomy.hh.

    {
      return (fabs(this->_theta_ - angle._theta_) <= precision &&
              fabs(this->_phi_   - angle._phi_)   <= precision);
    }

Member Data Documentation

_theta_

double JASTRONOMY::angle_type::_theta_

protectedinherited

Definition at line 250 of file JAstronomy.hh.

_phi_

double JASTRONOMY::angle_type::_phi_

protectedinherited

Definition at line 251 of file JAstronomy.hh.

---

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

• JAstronomy.hh