#include <ReferencePosition.h>

Inheritance diagram for lsst::ap::match::ReferencePosition:

Public Types
enum	Flags { MOVING = 0x1, PARALLAX = 0x2, PARALLAX_COR = 0x4 }

Public Member Functions
	ReferencePosition (int64_t id, lsst::afw::geom::Angle const ra, lsst::afw::geom::Angle const dec, double epoch=J2000_MJD)

virtual	~ReferencePosition ()

void	clearMotion ()

void	setMotion (double muRa, double muDecl, lsst::afw::geom::Angle parallax, double vRadial, bool trueAngle, bool parallaxCor)

void	setTimeRange (double epoch1, double epoch2)

int64_t	getId () const

double	getEpoch () const

int	getFlags () const

lsst::afw::coord::IcrsCoord const &	getSphericalCoords () const

Eigen::Vector3d const &	getPosition () const

Eigen::Vector3d const &	getVelocity () const

Eigen::Vector3d const	getPosition (double epoch) const

Eigen::Vector3d const	getPosition (double epoch, Eigen::Vector3d const &origin) const

virtual double	getMinCoord0 () const

virtual double	getMaxCoord0 () const

virtual double	getMinCoord1 () const

virtual double	getMaxCoord1 () const

Public Member Functions inherited from lsst::ap::match::BBox
virtual	~BBox ()

Static Public Attributes
static double const	MIN_PARALLAX = 1e-11

Private Attributes
lsst::afw::coord::IcrsCoord	_sc
	(ra, decl) at _epoch, ICRS rad More...

int64_t	_id

double	_epoch
	epoch of reference position, MJD More...

Eigen::Vector3d	_p
	(x, y, z) at _epoch More...

Eigen::Vector3d	_v
	(dx/dt, dy/dt, dz/dt) More...

lsst::afw::geom::Angle	_parallax
	parallax, rad More...

lsst::afw::geom::Angle	_minDecl

lsst::afw::geom::Angle	_maxDecl

lsst::afw::geom::Angle	_minRa

lsst::afw::geom::Angle	_maxRa

int	_flags
	Bit-wise OR of Flags. More...

Detailed Description

Position related parameters of a simulated reference catalog source. There are no errors - these are inputs to the image simulator.

Definition at line 48 of file ReferencePosition.h.

Member Enumeration Documentation

enum lsst::ap::match::ReferencePosition::Flags

Enumerator
MOVING	Set if the reference position has proper motion.
PARALLAX	Set if the reference position has parallax > MIN_PARALLAX
PARALLAX_COR	Set if parallax corrections are applied by getPosition().

Definition at line 50 of file ReferencePosition.h.

                {
         MOVING       = 0x1, 
         PARALLAX     = 0x2, 
         PARALLAX_COR = 0x4  
     };

Constructor & Destructor Documentation

lsst::ap::match::ReferencePosition::ReferencePosition	(	int64_t	id,
		lsst::afw::geom::Angle const	ra,
		lsst::afw::geom::Angle const	decl,
		double	epoch = `J2000_MJD`
	)

inline

Constructs a stationary, infinitely distant reference position.

Parameters

id	Reference position id
ra	Reference position right ascension, ICRS (radians)
decl	Reference position declination, ICRS (radians)
epoch	Reference position epoch, MJD

Definition at line 38 of file ReferencePosition.cc.

      :
     _sc(ra, decl),
     _id(id),
     _epoch(epoch),
     _p(_sc.getVector().asEigen()),
     _v(Eigen::Vector3d::Zero()),
     _parallax(0.0),
     _minDecl(decl),
     _maxDecl(decl),
     _minRa(ra),
     _maxRa(ra),
     _flags(0)
 { }

virtual lsst::ap::match::ReferencePosition::~ReferencePosition ( )

inlinevirtual

Definition at line 65 of file ReferencePosition.h.

65 { }

Member Function Documentation

void lsst::ap::match::ReferencePosition::clearMotion ( )

Clears the motion parameters of this reference position.

Definition at line 54 of file ReferencePosition.cc.

                                     {
     _p = _sc.getVector().asEigen();
     _v = Eigen::Vector3d::Zero();
     _parallax = 0.0 * radians;
     _minDecl = _sc.getLatitude();
     _maxDecl = _sc.getLatitude();
     _minRa = _sc.getLongitude();
     _maxRa = _sc.getLongitude();
     _flags = 0;
 }

double lsst::ap::match::ReferencePosition::getEpoch ( ) const

inline

Returns the epoch (MJD) of this reference position.

Definition at line 65 of file ReferencePosition.cc.

                                                 {
     return _epoch;
 }

int lsst::ap::match::ReferencePosition::getFlags ( ) const

inline

Returns a bit-wise ORed combination of ReferencePosition::Flags describing this reference position.

Definition at line 72 of file ReferencePosition.cc.

                                              {
    return _flags;
 }

int64_t lsst::ap::match::ReferencePosition::getId ( ) const

inline

Returns the unique integer id of this reference position.

Definition at line 59 of file ReferencePosition.cc.

                                               {
     return _id;
 }

double lsst::ap::match::ReferencePosition::getMaxCoord0 ( ) const

virtual

Implements lsst::ap::match::BBox.

Definition at line 146 of file ReferencePosition.cc.

                                              {
     return static_cast<double>(_maxRa);
 }

double lsst::ap::match::ReferencePosition::getMaxCoord1 ( ) const

virtual

Implements lsst::ap::match::BBox.

Definition at line 154 of file ReferencePosition.cc.

                                              {
     return static_cast<double>(_maxDecl);
 }

double lsst::ap::match::ReferencePosition::getMinCoord0 ( ) const

virtual

Implements lsst::ap::match::BBox.

Definition at line 142 of file ReferencePosition.cc.

                                              {
     return static_cast<double>(_minRa);
 }

double lsst::ap::match::ReferencePosition::getMinCoord1 ( ) const

virtual

Implements lsst::ap::match::BBox.

Definition at line 150 of file ReferencePosition.cc.

                                              {
     return static_cast<double>(_minDecl);
 }

Eigen::Vector3d const & lsst::ap::match::ReferencePosition::getPosition ( ) const

inline

Returns the reference position at epoch getEpoch(). If the reference position flags contain the PARALLAX bit, then this vector is in units of AU and is in the ICRS system (with an origin at the solar-system barycenter). Otherwise, this is a unit-vector - the reference position is treated as infinitely distant from an observer.

Coordinates are in the ICRS system for a barycentric observer.

Definition at line 92 of file ReferencePosition.cc.

                                                                   {
     return _p; 
 }

Eigen::Vector3d const lsst::ap::match::ReferencePosition::getPosition ( double epoch ) const

inline

Returns the reference position at epoch epoch, accounting for motion and optionally adjusting the coordinates to be geocentric rather than barycentric. The return value is normalized to be a unit 3-vector.

Note that the change to a geocentric origin is only performed if the the reference position flags contain the PARALLAX bit and ssbToGeo is true. Otherwise, the reference position is treated as infinitely distant (i.e. the change of origin has no effect),

Definition at line 114 of file ReferencePosition.cc.

                                                                             {
     if ((_flags & MOVING) == 0) {
         return _p;
     }
     Eigen::Vector3d p = _p + _v*(epoch - _epoch);
     if ((_flags & PARALLAX_COR) != 0) {
         p -= lsst::ap::utils::earthPosition(epoch);
     }
     return p.normalized();
 }

Eigen::Vector3d const lsst::ap::match::ReferencePosition::getPosition	(	double	epoch,
		Eigen::Vector3d const &	origin
	)		const

inline

Returns the reference position at epoch epoch, with a change of origin.

See Also: getPosition(double) const

Definition at line 130 of file ReferencePosition.cc.

         {
     if ((_flags & MOVING) == 0) {
         return _p;
     }
     Eigen::Vector3d p = _p + _v*(epoch - _epoch);
     if ((_flags & PARALLAX_COR) != 0) {
         p -= origin;
     }
     return p.normalized();
 }

lsst::afw::coord::IcrsCoord const & lsst::ap::match::ReferencePosition::getSphericalCoords ( ) const

inline

Returns the ICRS spherical coordinates (rad) of the reference position at epoch getEpoch().

Definition at line 79 of file ReferencePosition.cc.

                                                                                  {
     return _sc;
 }

Eigen::Vector3d const & lsst::ap::match::ReferencePosition::getVelocity ( ) const

inline

Returns the velocity of the reference position. If the reference position flags contain the PARALLAX bit, then this vector is in units of AU/day. Otherwise, units are radians/day (and will not have a radial component).

Definition at line 101 of file ReferencePosition.cc.

                                                                   {
     return _v;
 }

void lsst::ap::match::ReferencePosition::setMotion	(	double	muRa,
		double	muDecl,
		lsst::afw::geom::Angle	parallax,
		double	vRadial,
		bool	trueAngle,
		bool	parallaxCor
	)

Sets the motion parameters of this reference position.

Parameters

muRa	Rate of change of RA (true or coordinate angle), rad/day
muDecl	Declination rate of change, rad/day
parallax	Parallax, rad
vRadial	Radial velocity, AU/day
trueAngle	Is muRa dRA/dt*cos(decl) (`true`) or dRA/dt (`false`)?
parallaxCor	Apply parallax corrections in getPosition()?

Definition at line 67 of file ReferencePosition.cc.

   {
     double sr = std::sin(_sc.getLongitude().asRadians());
     double cr = std::cos(_sc.getLongitude().asRadians()); 
     double sd = std::sin(_sc.getLatitude().asRadians());
     double cd = std::cos(_sc.getLatitude().asRadians());
     if (trueAngle) {
         muRa = (cd == 0.0) ? 0.0 : muRa/cd;
     }
     // if parallax is tiny, treat this as a position on the celestial sphere
     if (parallax < MIN_PARALLAX) {
         _p.x() = cd*cr;
         _p.y() = cd*sr;
         _p.z() = sd;
         double t = sd*muDecl;
         _v.x() = -_p.y()*muRa - cr*t;
         _v.y() =  _p.x()*muRa - sr*t;
         _v.z() = cd*muDecl;
         _flags = MOVING;
         return;
     }
     double r = 1.0 / parallax.asRadians();
     double s = r*cd;
     double t = r*sd*muDecl;
     double u = cd*vRadial;
     _p.x() = s*cr;
     _p.y() = s*sr;
     _p.z() = r*sd;
     _v.x() = cr*u - _p.y()*muRa - cr*t;
     _v.y() = sr*u + _p.x()*muRa - sr*t;
     _v.z() = sd*vRadial + s*muDecl;
     if (_v.squaredNorm() > 0.25*C_AU_PER_DAY*C_AU_PER_DAY) {
         throw LSST_EXCEPT(pexExcept::RuntimeError,
                           "star velocity vector magnitude exceeds half "
                           "the speed of light");
     }
     _parallax = parallax;
     _flags = MOVING | PARALLAX | (parallaxCor ? PARALLAX_COR : 0);
 }

void lsst::ap::match::ReferencePosition::setTimeRange	(	double	epoch1,
		double	epoch2
	)

Sets the bounding box (in spherical coordinates) of the reference position to the bounding box of its path over the given time range. If SSB to geocentric corrections are enabled, the box is additionally padded by twice the parallax.

The input epochs need not be ordered.

Definition at line 122 of file ReferencePosition.cc.

                                                                  {
     if ((_flags & MOVING) != 0) {
         Eigen::Vector3d p1 = _p + _v*(epoch1 - _epoch);
         Eigen::Vector3d p2 = _p + _v*(epoch2 - _epoch);
         Eigen::Vector3d m = p1 + p2;
         Angle r = std::max(angularSeparation(m, p1),
                            angularSeparation(m, p2));
         if ((_flags & PARALLAX_COR) != 0) {
             r += 2.0*_parallax;
         }
         IcrsCoord sc = cartesianToIcrs(m);
         Angle alpha = maxAlpha(r, sc.getLatitude());
         _minDecl = clampPhi(sc.getLatitude() - r);
         _maxDecl = clampPhi(sc.getLatitude() + r);
         _minRa = sc.getLongitude() - alpha;
         _maxRa = sc.getLongitude() + alpha;
     }
 }

Member Data Documentation

double lsst::ap::match::ReferencePosition::_epoch

private

epoch of reference position, MJD

Definition at line 99 of file ReferencePosition.h.

int lsst::ap::match::ReferencePosition::_flags

private

Bit-wise OR of Flags.

Definition at line 108 of file ReferencePosition.h.

int64_t lsst::ap::match::ReferencePosition::_id

private

Definition at line 98 of file ReferencePosition.h.

lsst::afw::geom::Angle lsst::ap::match::ReferencePosition::_maxDecl

private

Definition at line 105 of file ReferencePosition.h.

lsst::afw::geom::Angle lsst::ap::match::ReferencePosition::_maxRa

private

Definition at line 107 of file ReferencePosition.h.

lsst::afw::geom::Angle lsst::ap::match::ReferencePosition::_minDecl

private

Definition at line 104 of file ReferencePosition.h.

lsst::afw::geom::Angle lsst::ap::match::ReferencePosition::_minRa

private

Definition at line 106 of file ReferencePosition.h.

Eigen::Vector3d lsst::ap::match::ReferencePosition::_p

private

(x, y, z) at _epoch

Definition at line 100 of file ReferencePosition.h.

lsst::afw::geom::Angle lsst::ap::match::ReferencePosition::_parallax

private

parallax, rad

Definition at line 102 of file ReferencePosition.h.

lsst::afw::coord::IcrsCoord lsst::ap::match::ReferencePosition::_sc

private

(ra, decl) at _epoch, ICRS rad

Definition at line 97 of file ReferencePosition.h.

Eigen::Vector3d lsst::ap::match::ReferencePosition::_v

private

(dx/dt, dy/dt, dz/dt)

Definition at line 101 of file ReferencePosition.h.

double const lsst::ap::match::ReferencePosition::MIN_PARALLAX = 1e-11

static

Definition at line 58 of file ReferencePosition.h.

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

/lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/match/ReferencePosition.h
/lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/src/match/ReferencePosition.cc
/lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/match/ReferencePosition.cc

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation