Jpp 21.0.0-rc.3
the software that should make you happy
Loading...
Searching...
No Matches
JASTRONOMY::JSourceLocationJ2000 Struct Reference

Location of astrophysical source. More...

#include <JAstronomy.hh>

Inheritance diagram for JASTRONOMY::JSourceLocationJ2000:
JASTRONOMY::angle_type_rad JASTRONOMY::angle_type JLANG::JEquals< JFirst_t, JSecond_t >

Public Member Functions

 JSourceLocationJ2000 ()
 Default constructor.
 
 JSourceLocationJ2000 (const double dec, const double ra)
 Constructor.
 
 JSourceLocationJ2000 (const double t1_s, const JSourceLocation &location)
 Conversion constructor.
 
 JSourceLocationJ2000 (const JGalacticCoordinates &location)
 Conversion constructor.
 
 JSourceLocationJ2000 (const JAngle3D &angle)
 Constructor.
 
const JSourceLocationJ2000 & 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 JSourceLocationJ2000 &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 524 of file JAstronomy.hh.

Constructor & Destructor Documentation

◆ JSourceLocationJ2000() [1/5]

JASTRONOMY::JSourceLocationJ2000::JSourceLocationJ2000 ( )
inline

Default constructor.

Definition at line 530 of file JAstronomy.hh.

531 {}

◆ JSourceLocationJ2000() [2/5]

JASTRONOMY::JSourceLocationJ2000::JSourceLocationJ2000 ( const double dec,
const double ra )
inline

Constructor.

Parameters
decdeclination [rad]
raright ascension [rad]

Definition at line 540 of file JAstronomy.hh.

541 :
542 angle_type_rad(dec, ra)
543 {}
angle_type_rad()
Default constructor.

◆ JSourceLocationJ2000() [3/5]

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

Conversion constructor.

Parameters
t1_stime since MJD [s]
locationsource location

Definition at line 631 of file JAstronomy.hh.

631 :
632 angle_type_rad(J2000::convert(t1_s, location, J2000::TO))
633 {}
static angle_type_rad convert(const double t1_s, const angle_type_rad &location, const J2000::CONVERSION option)
Convert source location according J2000 at given time.

◆ JSourceLocationJ2000() [4/5]

JASTRONOMY::JSourceLocationJ2000::JSourceLocationJ2000 ( const JGalacticCoordinates & location)
inline

Conversion constructor.

Parameters
locationsource location

Definition at line 725 of file JAstronomy.hh.

726 {
727 double lat = location.getLatitude();
728 double lon = location.getLongitude();
729
730 slaGaleq(lon, lat, &this->_phi_, &this->_theta_);
731 }

◆ JSourceLocationJ2000() [5/5]

JASTRONOMY::JSourceLocationJ2000::JSourceLocationJ2000 ( const JAngle3D & angle)
inline

Constructor.

Parameters
anglepolar angles [rad]

Definition at line 568 of file JAstronomy.hh.

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

Member Function Documentation

◆ getSourceLocation()

const JSourceLocationJ2000 & JASTRONOMY::JSourceLocationJ2000::getSourceLocation ( ) const
inline

Get source location.

Returns
source location

Definition at line 578 of file JAstronomy.hh.

579 {
580 return static_cast<const JSourceLocationJ2000&>(*this);
581 }
JSourceLocationJ2000()
Default constructor.

◆ operator JAngle3D()

JASTRONOMY::JSourceLocationJ2000::operator JAngle3D ( ) const
inline

Type conversion operator.

Returns
polar angles [rad]

Definition at line 589 of file JAstronomy.hh.

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

◆ getDeclination()

double JASTRONOMY::JSourceLocationJ2000::getDeclination ( ) const
inline

Get declination.

Definition at line 595 of file JAstronomy.hh.

◆ getRightAscension()

double JASTRONOMY::JSourceLocationJ2000::getRightAscension ( ) const
inline

Get right ascension.

Definition at line 596 of file JAstronomy.hh.

◆ getDot()

double JASTRONOMY::JSourceLocationJ2000::getDot ( const JSourceLocationJ2000 & location) const
inline

Dot product.

Parameters
locationsource location
Returns
dot product

Definition at line 605 of file JAstronomy.hh.

606 {
607 return
608 cos(this->_theta_) * cos(location._theta_) * cos(this->_phi_ - location._phi_) +
609 sin(this->_theta_) * sin(location._theta_);
610 }

◆ set()

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

Convert angle.

Parameters
angleangle [rad]

Definition at line 293 of file JAstronomy.hh.

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

◆ equals()

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

Check equality.

Parameters
anglepair of angles
precisionprecision
Returns
true if angles are equal; else false

Definition at line 194 of file JAstronomy.hh.

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

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: