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

#include <Coord.h>

Inheritance diagram for lsst::afw::coord::IcrsCoord:

Public Types
typedef boost::shared_ptr < IcrsCoord >	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
	IcrsCoord (lsst::afw::geom::Point2D const &p2d, lsst::afw::geom::AngleUnit unit=lsst::afw::geom::degrees)

	IcrsCoord (lsst::afw::geom::Point3D const &p3d, bool normalize=true, lsst::afw::geom::Angle const defaultLongitude=lsst::afw::geom::Angle(0.))

	IcrsCoord (lsst::afw::geom::Angle const ra, lsst::afw::geom::Angle const dec)

	IcrsCoord (std::string const ra, std::string const dec)

	IcrsCoord ()

virtual Coord::Ptr	clone () const

virtual std::string	getClassName () const

virtual void	reset (lsst::afw::geom::Angle const longitude, lsst::afw::geom::Angle const latitude)
	special reset() overload to make sure no epoch can be set More...

lsst::afw::geom::Angle	getRa () const

lsst::afw::geom::Angle	getDec () const

std::string	getRaStr (lsst::afw::geom::AngleUnit unit) const

std::string	getDecStr () const

virtual Fk5Coord	toFk5 (double const epoch) const
	Fk5 converter for IcrsCoord. (specify epoch) More...

virtual Fk5Coord	toFk5 () const
	Fk5 converter for IcrsCoord. (no epoch specified) More...

virtual IcrsCoord	toIcrs () const
	Icrs converter for IcrsCoord. (ie. a no-op) 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, 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...

virtual std::pair< std::string, std::string >	getCoordNames () const

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 GalacticCoord	toGalactic () const
	Convert ourself to Galactic: l, b. More...

virtual EclipticCoord	toEcliptic (double const epoch) const
	Convert ourself to Ecliptic: lambda, beta (precess to new epoch) More...

virtual EclipticCoord	toEcliptic () const
	Convert ourself to Ecliptic: lambda, beta (use existing epoch) 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 Icrs coordinates (inherits from Coord)

Definition at line 157 of file Coord.h.

Member Typedef Documentation

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

Definition at line 159 of file Coord.h.

Constructor & Destructor Documentation

lsst::afw::coord::IcrsCoord::IcrsCoord	(	lsst::afw::geom::Point2D const &	p2d,
		lsst::afw::geom::AngleUnit	unit = `lsst::afw::geom::degrees`
	)

inline

Definition at line 161 of file Coord.h.

161 : Coord(p2d, unit, 2000.0) {}

lsst::afw::coord::Coord::Coord

Coord()

Default constructor for the Coord base class.

Definition: Coord.cc:441

lsst::afw::coord::IcrsCoord::IcrsCoord	(	lsst::afw::geom::Point3D const &	p3d,
		bool	normalize = `true`,
		lsst::afw::geom::Angle const	defaultLongitude = `lsst::afw::geom::Angle(0.)`
	)

inline

Definition at line 162 of file Coord.h.

162 :

163 Coord(p3d, 2000.0, normalize, defaultLongitude) {}

lsst.geom.geometry.normalize

def normalize

Definition: geometry.py:90

lsst::afw::coord::Coord::Coord

Coord()

Default constructor for the Coord base class.

Definition: Coord.cc:441

lsst::afw::coord::IcrsCoord::IcrsCoord	(	lsst::afw::geom::Angle const	ra,
		lsst::afw::geom::Angle const	dec
	)

inline

Definition at line 164 of file Coord.h.

164 : Coord(ra, dec, 2000.0) {}

lsst::afw::coord::Coord::Coord

Coord()

Default constructor for the Coord base class.

Definition: Coord.cc:441

lsst::afw::coord::IcrsCoord::IcrsCoord	(	std::string const	ra,
		std::string const	dec
	)

inline

Definition at line 165 of file Coord.h.

165 : Coord(ra, dec, 2000.0) {}

lsst::afw::coord::Coord::Coord

Coord()

Default constructor for the Coord base class.

Definition: Coord.cc:441

lsst::afw::coord::IcrsCoord::IcrsCoord ( )

inline

Definition at line 166 of file Coord.h.

166 : Coord() {}

lsst::afw::coord::Coord::Coord

Coord()

Default constructor for the Coord base class.

Definition: Coord.cc:441

Member Function Documentation

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

inlinevirtual

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

Definition at line 168 of file Coord.h.

168 { return IcrsCoord::Ptr(new IcrsCoord(*this)); }

lsst::afw::coord::IcrsCoord::Ptr

boost::shared_ptr< IcrsCoord > Ptr

Definition: Coord.h:159

lsst::afw::coord::IcrsCoord::IcrsCoord

IcrsCoord()

Definition: Coord.h:166

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

inlinevirtual

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

Definition at line 170 of file Coord.h.

170 { return "IcrsCoord"; }

lsst::afw::geom::Angle lsst::afw::coord::IcrsCoord::getDec ( ) const

inline

Definition at line 175 of file Coord.h.

175 { return getLatitude(); }

lsst::afw::coord::Coord::getLatitude

lsst::afw::geom::Angle getLatitude() const

The main access method for the latitudinal coordinate.

Definition: Coord.h:120

std::string lsst::afw::coord::IcrsCoord::getDecStr ( ) const

inline

Definition at line 177 of file Coord.h.

177 { return getLatitudeStr(); }

lsst::afw::coord::Coord::getLatitudeStr

std::string getLatitudeStr() const

Allow quick access to the longitude coordinate as a string.

Definition: Coord.h:460

lsst::afw::geom::Angle lsst::afw::coord::IcrsCoord::getRa ( ) const

inline

Definition at line 174 of file Coord.h.

174 { return getLongitude(); }

lsst::afw::coord::Coord::getLongitude

lsst::afw::geom::Angle getLongitude() const

The main access method for the longitudinal coordinate.

Definition: Coord.h:113

std::string lsst::afw::coord::IcrsCoord::getRaStr ( lsst::afw::geom::AngleUnit unit ) const

inline

Definition at line 176 of file Coord.h.

176 { return getLongitudeStr(unit); }

lsst::afw::coord::Coord::getLongitudeStr

std::string getLongitudeStr(lsst::afw::geom::AngleUnit unit) const

Allow quick access to the longitudinal coordinate as a string.

Definition: Coord.h:443

void lsst::afw::coord::IcrsCoord::reset	(	lsst::afw::geom::Angle const	longitude,
		lsst::afw::geom::Angle const	latitude
	)

virtual

special reset() overload to make sure no epoch can be set

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

Definition at line 997 of file Coord.cc.

                                                                                        {
     Coord::reset(longitude, latitude, 2000.0);
 }

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

virtual

Fk5 converter for IcrsCoord. (specify epoch)

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

Definition at line 1004 of file Coord.cc.

                                                                   {
     return Fk5Coord(getLongitude(), getLatitude(), 2000.0).precess(epoch);
 }

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

virtual

Fk5 converter for IcrsCoord. (no epoch specified)

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

Definition at line 1010 of file Coord.cc.

                                                 {
     return Fk5Coord(getLongitude(), getLatitude(), 2000.0);
 }

afwCoord::IcrsCoord lsst::afw::coord::IcrsCoord::toIcrs ( ) const

virtual

Icrs converter for IcrsCoord. (ie. a no-op)

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

Definition at line 1017 of file Coord.cc.

                                                   {
     return IcrsCoord(getLongitude(), getLatitude());
 }

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

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation