lsst::afw::coord::EclipticCoord Class Reference

A class to handle Ecliptic coordinates (inherits from Coord) More...

#include <Coord.h>

Inheritance diagram for lsst::afw::coord::EclipticCoord:

Public Types
typedef boost::shared_ptr < EclipticCoord >	Ptr
Public Types inherited from lsst::afw::coord::Coord
typedef boost::shared_ptr< Coord >	Ptr
typedef boost::shared_ptr < Coord const >	ConstPtr

Public Member Functions
	EclipticCoord (lsst::afw::geom::Point2D const &p2d, lsst::afw::geom::AngleUnit unit=lsst::afw::geom::degrees, double const epoch=2000.0)
	EclipticCoord (lsst::afw::geom::Point3D const &p3d, double const epoch=2000.0, bool normalize=true, lsst::afw::geom::Angle const defaultLongitude=lsst::afw::geom::Angle(0.))
	EclipticCoord (lsst::afw::geom::Angle const lamb, lsst::afw::geom::Angle const beta, double const epoch=2000.0)
	EclipticCoord (std::string const lamb, std::string const beta, double const epoch=2000.0)
	EclipticCoord ()
virtual Coord::Ptr	clone () const
virtual std::string	getClassName () const
virtual std::pair< std::string, std::string >	getCoordNames () const
lsst::afw::geom::Angle	getLambda () const
lsst::afw::geom::Angle	getBeta () const
std::string	getLambdaStr (lsst::afw::geom::AngleUnit unit) const
std::string	getBetaStr () const
virtual Fk5Coord	toFk5 (double const epoch) const
	Convert ourself from Ecliptic to Fk5 (precess to new epoch) More...
virtual Fk5Coord	toFk5 () const
	Convert ourself from Ecliptic to Fk5 (use current epoch) More...
virtual EclipticCoord	toEcliptic (double const epoch) const
	Convert ourself from Ecliptic to Ecliptic ... a no-op (but precess to new epoch) More...
virtual EclipticCoord	toEcliptic () const
	Convert ourself from Ecliptic to Ecliptic ... a no-op (use the current epoch) More...
EclipticCoord	precess (double const epochTo) const
	precess to new epoch More...
Public Member Functions inherited from lsst::afw::coord::Coord
	Coord (lsst::afw::geom::Point2D const &p2d, lsst::afw::geom::AngleUnit unit=lsst::afw::geom::degrees, double const epoch=2000.0)
	Constructor for the Coord base class. More...
	Coord (lsst::afw::geom::Point3D const &p3d, double const epoch=2000.0, bool normalize=true, lsst::afw::geom::Angle const defaultLongitude=lsst::afw::geom::Angle(0.))
	Constructor for the Coord base class. More...
	Coord (lsst::afw::geom::Angle const ra, lsst::afw::geom::Angle const dec, double const epoch=2000.0)
	Constructor for the Coord base class. More...
	Coord (std::string const ra, std::string const dec, double const epoch=2000.0)
	Constructor for the Coord base class. More...
	Coord ()
	Default constructor for the Coord base class. More...
virtual	~Coord ()
virtual void	reset (lsst::afw::geom::Angle const longitude, lsst::afw::geom::Angle const latitude)
virtual void	reset (lsst::afw::geom::Angle const longitude, lsst::afw::geom::Angle const latitude, double const epoch)
	Reset our coordinates wholesale. More...
double	getEpoch () const
lsst::afw::geom::Point2D	getPosition (lsst::afw::geom::AngleUnit unit=lsst::afw::geom::degrees) const
	Return our contents in a Point2D object. More...
lsst::afw::geom::Point3D	getVector () const
	Return our contents in a position vector. More...
lsst::afw::geom::Angle	operator[] (int const index) const
	Provide access to our contents via an index. More...
bool	operator== (Coord const &rhs) const
	Equality operator, compares each element directly. More...
lsst::afw::geom::Angle	getLongitude () const
	The main access method for the longitudinal coordinate. More...
lsst::afw::geom::Angle	getLatitude () const
	The main access method for the latitudinal coordinate. More...
std::string	getLongitudeStr (lsst::afw::geom::AngleUnit unit) const
	Allow quick access to the longitudinal coordinate as a string. More...
std::string	getLatitudeStr () const
	Allow quick access to the longitude coordinate as a string. More...
Coord	transform (Coord const &poleFrom, Coord const &poleTo) const
	Tranform our current coords to another spherical polar system. More...
lsst::afw::geom::Angle	angularSeparation (Coord const &c) const
	compute the angular separation between two Coords More...
std::pair < lsst::afw::geom::Angle, lsst::afw::geom::Angle >	getOffsetFrom (Coord const &c) const
	Compute the offset from a coordinate. More...
std::pair < lsst::afw::geom::Angle, lsst::afw::geom::Angle >	getTangentPlaneOffset (Coord const &c) const
	Get the offset on the tangent plane. More...
void	rotate (Coord const &axis, lsst::afw::geom::Angle const theta)
	Rotate our current coords about a pole. More...
lsst::afw::geom::Angle	offset (lsst::afw::geom::Angle const phi, lsst::afw::geom::Angle const arcLen)
	offset our current coords along a great circle defined by an angle wrt a declination parallel More...
Coord::Ptr	convert (CoordSystem system) const
	Convert to a specified Coord type. More...
virtual IcrsCoord	toIcrs () const
	Convert ourself to ICRS: RA, Dec (basically J2000) More...
virtual GalacticCoord	toGalactic () const
	Convert ourself to Galactic: l, b. More...
virtual TopocentricCoord	toTopocentric (Observatory const &obs, lsst::daf::base::DateTime const &obsDate) const
	Convert ourself to Altitude/Azimuth: alt, az. More...

Detailed Description

A class to handle Ecliptic coordinates (inherits from Coord)

Definition at line 278 of file Coord.h.

Member Typedef Documentation

typedef boost::shared_ptr<EclipticCoord> lsst::afw::coord::EclipticCoord::Ptr

Definition at line 281 of file Coord.h.

Constructor & Destructor Documentation

lsst::afw::coord::EclipticCoord::EclipticCoord ( lsst::afw::geom::Point2D const &  p2d, lsst::afw::geom::AngleUnit  unit = lsst::afw::geom::degrees, double const  epoch = 2000.0  )

inline

Definition at line 283 of file Coord.h.

                                               :
        Coord(p2d, unit, epoch) {}

lsst::afw::coord::EclipticCoord::EclipticCoord ( lsst::afw::geom::Point3D const &  p3d, double const  epoch = 2000.0, bool  normalize = true, lsst::afw::geom::Angle const  defaultLongitude = lsst::afw::geom::Angle(0.)  )

inline

Definition at line 287 of file Coord.h.

                                                                                 :
        Coord(p3d, epoch, normalize, defaultLongitude) {}

lsst::afw::coord::EclipticCoord::EclipticCoord ( lsst::afw::geom::Angle const  lamb, lsst::afw::geom::Angle const  beta, double const  epoch = 2000.0  )

inline

Definition at line 293 of file Coord.h.

                                               : 
        Coord(lamb, beta, epoch) {}

lsst::afw::coord::EclipticCoord::EclipticCoord ( std::string const  lamb, std::string const  beta, double const  epoch = 2000.0  )

inline

Definition at line 296 of file Coord.h.

                                                                                           : 
        Coord(lamb, beta, epoch) {}

lsst::afw::coord::EclipticCoord::EclipticCoord ( )

inline

Definition at line 299 of file Coord.h.

: Coord() {}

Member Function Documentation

virtual Coord::Ptr lsst::afw::coord::EclipticCoord::clone ( ) const

inlinevirtual

Reimplemented from lsst::afw::coord::Coord.

Definition at line 301 of file Coord.h.

{ return EclipticCoord::Ptr(new EclipticCoord(*this)); }

lsst::afw::geom::Angle lsst::afw::coord::EclipticCoord::getBeta ( ) const

inline

Definition at line 309 of file Coord.h.

{ return getLatitude(); }    

std::string lsst::afw::coord::EclipticCoord::getBetaStr ( ) const

inline

Definition at line 311 of file Coord.h.

{ return getLatitudeStr(); }     

virtual std::string lsst::afw::coord::EclipticCoord::getClassName ( ) const

inlinevirtual

Reimplemented from lsst::afw::coord::Coord.

Definition at line 303 of file Coord.h.

{ return "EclipticCoord"; }

virtual std::pair<std::string, std::string> lsst::afw::coord::EclipticCoord::getCoordNames ( ) const

inlinevirtual

Reimplemented from lsst::afw::coord::Coord.

Definition at line 305 of file Coord.h.

                                                                {
        return std::pair<std::string, std::string>("Lambda", "Beta");
    }

lsst::afw::geom::Angle lsst::afw::coord::EclipticCoord::getLambda ( ) const

inline

Definition at line 308 of file Coord.h.

{ return getLongitude(); }   

std::string lsst::afw::coord::EclipticCoord::getLambdaStr ( lsst::afw::geom::AngleUnit  unit ) const

inline

Definition at line 310 of file Coord.h.

{ return getLongitudeStr(unit); }

afwCoord::EclipticCoord lsst::afw::coord::EclipticCoord::precess

(

double const

epochTo

)

const

precess to new epoch

Do this by going through fk5

Parameters

epochTo

epoch to precess to.

Definition at line 1107 of file Coord.cc.

                                                                {
    return this->toFk5().precess(epochTo).toEcliptic();
}

afwCoord::EclipticCoord lsst::afw::coord::EclipticCoord::toEcliptic ( double const  epoch ) const

virtual

Convert ourself from Ecliptic to Ecliptic ... a no-op (but precess to new epoch)

Reimplemented from lsst::afw::coord::Coord.

Definition at line 1072 of file Coord.cc.

                                                                                {
    return EclipticCoord(getLongitude(), getLatitude(), getEpoch()).precess(epoch);
}

afwCoord::EclipticCoord lsst::afw::coord::EclipticCoord::toEcliptic ( ) const

virtual

Convert ourself from Ecliptic to Ecliptic ... a no-op (use the current epoch)

Reimplemented from lsst::afw::coord::Coord.

Definition at line 1078 of file Coord.cc.

                                                              {
    return EclipticCoord(getLongitude(), getLatitude(), getEpoch());
}

afwCoord::Fk5Coord lsst::afw::coord::EclipticCoord::toFk5 ( double const  epoch ) const

virtual

Convert ourself from Ecliptic to Fk5 (precess to new epoch)

Reimplemented from lsst::afw::coord::Coord.

Definition at line 1086 of file Coord.cc.

                                                                      {
    afwGeom::Angle const eclPoleIncl = eclipticPoleInclination(epoch);
    afwGeom::Angle ninety = 90. * afwGeom::degrees;
    Coord const eclipticPoleInFk5(270.0 * afwGeom::degrees, ninety - eclPoleIncl, epoch);
    Coord const fk5PoleInEcliptic(ninety, ninety - eclPoleIncl, epoch);
    Coord c = transform(eclipticPoleInFk5, fk5PoleInEcliptic);
    return Fk5Coord(c.getLongitude(), c.getLatitude(), epoch);
}

afwCoord::Fk5Coord lsst::afw::coord::EclipticCoord::toFk5 ( ) const

virtual

Convert ourself from Ecliptic to Fk5 (use current epoch)

Reimplemented from lsst::afw::coord::Coord.

Definition at line 1097 of file Coord.cc.

                                                    {
    return this->toFk5(getEpoch());
}

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/coord/Coord.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/coord/Coord.cc