#include <pvtCoord.h>

Public Member Functions
	PVTCoord (Coord const &coord, Eigen::Vector3d const &vel, double tai)

	PVTCoord (Coord const &coord0, Coord const &coord1, double tai, double deltaT)

	PVTCoord (PVT const &equatPVT, PVT const &polarPVT, PVT const &distPVT=PVT())

	PVTCoord (PVT const &equatPVT, PVT const &polarPVT, PVT const &distPVT, double equatPM, double polarPM, double radVel)

	PVTCoord ()

PVTCoord	copy (double tai) const

Eigen::Vector3d	getVel () const

double	getTAI () const

Coord	getCoord () const

Coord	getCoord (double tai) const

bool	isfinite () const

bool	getSphPVT (PVT &equatPVT, PVT &polarPVT) const

PVT	getDistance () const

PVT	angularSeparation (PVTCoord const &pvtCoord) const

PVT	orientationTo (PVTCoord const &pvtCoord) const

PVTCoord	offset (PVT &toOrient, PVT const &fromOrient, PVT const &dist) const

bool	operator== (PVTCoord const &rhs)

bool	operator!= (PVTCoord const &rhs)

std::string	__repr__ () const

Detailed Description

A coordinate moving at a constant cartesian velocity

Primarily intended for computing instantaneous velocity by comparing two Coord at nearby time.

Definition at line 13 of file pvtCoord.h.

Constructor & Destructor Documentation

coordConv::PVTCoord::PVTCoord	(	Coord const &	coord,
		Eigen::Vector3d const &	vel,
		double	tai
	)

explicit

Construct a PVTCoord from a coord, vector velocity and time

Parameters

[in]	coord	coordinate at time tai
[in]	vel	cartesian velocity (deg/sec)
[in]	tai	TAI date of coord (MJD seconds)

Exceptions

std::runtime_error if coord is at pole at time tai and vel nonzero.

Definition at line 15 of file pvtCoord.cc.

coordConv::PVTCoord::PVTCoord	(	Coord const &	coord0,
		Coord const &	coord1,
		double	tai,
		double	deltaT
	)

explicit

Construct a PVTCoord from a pair of coords

Parameters

[in]	coord0	coordinate at time tai
[in]	coord1	coordinate at time tai + deltaT; proper motion and radial velocity are ignored
[in]	tai	initial TAI date of PVTCoord (MJD seconds)
[in]	deltaT	TAI of coord1 - TAI of coord0; must be nonzero

Exceptions

std::runtime_error if deltaT = 0

Definition at line 21 of file pvtCoord.cc.

coordConv::PVTCoord::PVTCoord	(	PVT const &	equatPVT,
		PVT const &	polarPVT,
		PVT const &	distPVT = `PVT()`
	)

explicit

Construct a PVTCoord from spherical PVTs and distance at TAI date equatPVT.t

Parameters

[in]	equatPVT	equatorial angle (e.g. RA, Long, Az) (degrees)
[in]	polarPVT	polar angle (e.g. Dec, Latitude, Alt) (degrees)
[in]	distPVT	distance (AU); if invalid (!distPVT.isfinite()) then infinity is assumed

Exceptions

std::runtime_error if equatPVT.t != polarPVT.t

Definition at line 25 of file pvtCoord.cc.

coordConv::PVTCoord::PVTCoord	(	PVT const &	equatPVT,
		PVT const &	polarPVT,
		PVT const &	distPVT,
		double	equatPM,
		double	polarPM,
		double	radVel
	)

explicit

Construct a PVTCoord from spherical PVTs, parallax, proper motion and radial velocity at TAI date equatPVT.t

Parameters

[in]	equatPVT	equatorial angle (e.g. RA, Long, Az) (degrees)
[in]	polarPVT	polar angle (e.g. Dec, Latitude, Alt) (degrees)
[in]	distPVT	distance (AU)
[in]	equatPM	equatorial proper motion (arcsec/century); this is dEquatAng/dt, so it gets large near the pole
[in]	polarPM	polar proper motion (arcsec/century)
[in]	radVel	radial velocity (km/sec, positive receding)

Exceptions

std::runtime_error if equatPVT.t != polarPVT.t

Definition at line 49 of file pvtCoord.cc.

coordConv::PVTCoord::PVTCoord ( )

explicit

Construct a PVTCoord with all NaN data

Definition at line 73 of file pvtCoord.cc.

Member Function Documentation

std::string coordConv::PVTCoord::__repr__ ( ) const

Return a string representation

Definition at line 176 of file pvtCoord.cc.

PVT coordConv::PVTCoord::angularSeparation ( PVTCoord const & pvtCoord ) const

Compute the angular separation from another PVTCoord

The separation is computed at the date of this pvtCoord

Parameters

[in] pvtCoord PVT coord to which to measure angular separation

Returns: angular separation (deg)

Definition at line 121 of file pvtCoord.cc.

PVTCoord coordConv::PVTCoord::copy ( double tai ) const

Copy PVTCoord at the specified date

Parameters

[in] tai TAI date at which to retrieve position (MJD, sec)

Definition at line 79 of file pvtCoord.cc.

Coord coordConv::PVTCoord::getCoord ( ) const

inline

Return Coord at initial TAI date

Definition at line 95 of file pvtCoord.h.

Coord coordConv::PVTCoord::getCoord ( double tai ) const

Compute the coord at a specified TAI date

Parameters

[in] tai TAI date at which to compute coord (MJD, sec)

Definition at line 83 of file pvtCoord.cc.

PVT coordConv::PVTCoord::getDistance ( ) const

Get distance in AU

Returns: distance, in AU; if getCoord().atInfinity() then the value is not inf, but will often be approximately AUPerParsec/MinParallax.

Definition at line 104 of file pvtCoord.cc.

bool coordConv::PVTCoord::getSphPVT	(	PVT &	equatPVT,
		PVT &	polarPVT
	)		const

Get spherical position

The returned velocities are the dEquat/dt and dPolar/dt at the pvtCoord's TAI date

Parameters

[out]	equatPVT	equatorial PVT (deg, deg/sec, TAI date)
[out]	polarPVT	polar PVT (deg, deg/sec, TAI date)

Returns: atPole: true if so near the pole that equatorial angle could not be computed.

Definition at line 91 of file pvtCoord.cc.

double coordConv::PVTCoord::getTAI ( ) const

inline

Get initial TAI date

Definition at line 90 of file pvtCoord.h.

Eigen::Vector3d coordConv::PVTCoord::getVel ( ) const

inline

Get orientation at initial TAI date Get velocity

Definition at line 85 of file pvtCoord.h.

bool coordConv::PVTCoord::isfinite ( ) const

Return True if all values are finite

Definition at line 115 of file pvtCoord.cc.

PVTCoord coordConv::PVTCoord::offset	(	PVT &	toOrient,
		PVT const &	fromOrient,
		PVT const &	dist
	)		const

Offset a PVTCoord by a specified distance in a specified direction; see Coord::offset for a full explanation.

Parameters

[out]	toOrient	orientation of offset arc at offset position (deg)
[in]	fromOrient	orientation of offset arc at this position (deg)
[in]	dist	offset distance as the length of the arc of a great circle (deg)

Returns: offset PVT coord

Exceptions

std::runtime_error if this PVTCoord is too near a pole to be offset

Definition at line 164 of file pvtCoord.cc.

bool coordConv::PVTCoord::operator!= ( PVTCoord const & rhs )

inline

Definition at line 172 of file pvtCoord.h.

bool coordConv::PVTCoord::operator== ( PVTCoord const & rhs )

inline

Definition at line 166 of file pvtCoord.h.

PVT coordConv::PVTCoord::orientationTo ( PVTCoord const & pvtCoord ) const

Compute the orientation of a great circle offset to another PVTCoord

The orientation is computed at the date of this pvtCoord

Parameters

[in] pvtCoord PVT coord to which to measure orientation

In detail: computes the orientation at this point of a great circle connecting this PVT coord to another PVT coord. The orientation is 0 if the great circle lies along the direction of increasing equatorial angle, 90 if it lies along the direction increasing polar angle.

Returns: orientation (deg), or NaN if the angular separation is too near 0 or 180 at tai

Definition at line 134 of file pvtCoord.cc.

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

include/coordConv/pvtCoord.h
src/pvtCoord.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation