lsst.afw.coord Namespace Reference

Namespaces
	utils

Classes
class	Coord
class	IcrsCoord
	A class to handle Icrs coordinates (inherits from Coord) More...
class	Fk5Coord
	A class to handle Fk5 coordinates (inherits from Coord) More...
class	GalacticCoord
	A class to handle Galactic coordinates (inherits from Coord) More...
class	EclipticCoord
	A class to handle Ecliptic coordinates (inherits from Coord) More...
class	TopocentricCoord
	A class to handle topocentric (AltAz) coordinates (inherits from Coord) More...
class	Observatory
	Store information about an observatory ... lat/long, elevation. More...

Enumerations
enum	CoordSystem {   UNKNOWN =-1, FK5, ICRS, GALACTIC,   ECLIPTIC, TOPOCENTRIC }

Functions
CoordSystem	makeCoordEnum (std::string const system)
	A utility function to get the enum value of a coordinate system from a string name. More...
boost::shared_ptr< Coord >	makeCoord (CoordSystem const system, lsst::afw::geom::Angle const ra, lsst::afw::geom::Angle const dec, double const epoch)
	Factory function to create a Coord of arbitrary type with decimal RA,Dec. More...
boost::shared_ptr< Coord >	makeCoord (CoordSystem const system, std::string const ra, std::string const dec, double const epoch)
	Factory function to create a Coord of arbitrary type with string RA [in degrees, not hours!], Dec. More...
boost::shared_ptr< Coord >	makeCoord (CoordSystem const system, lsst::afw::geom::Point2D const &p2d, lsst::afw::geom::AngleUnit unit, double const epoch)
	Factory function to create a Coord of arbitrary type with Point2D. More...
boost::shared_ptr< Coord >	makeCoord (CoordSystem const system, lsst::afw::geom::Point3D const &p3d, double const epoch, bool normalize=true, lsst::afw::geom::Angle const defaultLongitude=lsst::afw::geom::Angle(0.))
	Factory function to create a Coord of arbitrary type with a Point3D. More...
boost::shared_ptr< Coord >	makeCoord (CoordSystem const system)
	Lightweight factory to make an empty coord. More...
boost::shared_ptr< Coord >	makeCoord (CoordSystem const system, lsst::afw::geom::Angle const ra, lsst::afw::geom::Angle const dec)
	Factory function to create a Coord of arbitrary type with decimal RA,Dec in degrees. More...
boost::shared_ptr< Coord >	makeCoord (CoordSystem const system, std::string const ra, std::string const dec)
	Factory function to create a Coord of arbitrary type with string RA [in degrees, not hours!], Dec. More...
boost::shared_ptr< Coord >	makeCoord (CoordSystem const system, lsst::afw::geom::Point2D const &p2d, lsst::afw::geom::AngleUnit unit)
	Factory function to create a Coord of arbitrary type with Point2D. More...
boost::shared_ptr< Coord >	makeCoord (CoordSystem const system, lsst::afw::geom::Point3D const &p3d, bool normalize=true, lsst::afw::geom::Angle const defaultLongitude=lsst::afw::geom::Angle(0.))
	Factory function to create a Coord of arbitrary type with a Point3D. More...
boost::shared_ptr< Coord >	averageCoord (std::vector< boost::shared_ptr< Coord const >> const coords, CoordSystem system=UNKNOWN)
lsst::afw::geom::Angle	eclipticPoleInclination (double const epoch)
	get the inclination of the ecliptic pole (obliquity) at epoch More...
lsst::afw::geom::Angle	dmsStringToAngle (std::string const dms)
	Convert a dd:mm:ss string to Angle. More...
lsst::afw::geom::Angle	hmsStringToAngle (std::string const hms)
	Convert a hh:mm:ss string to Angle. More...
std::string	angleToDmsString (lsst::afw::geom::Angle const deg)
	a Function to convert a coordinate in decimal degrees to a string with form dd:mm:ss More...
std::string	angleToHmsString (lsst::afw::geom::Angle const deg)
	a function to convert decimal degrees to a string with form hh:mm:ss.s More...
std::ostream &	operator<< (std::ostream &os, Coord const &coord)
std::ostream &	operator<< (std::ostream &os, Observatory const &obs)

Enumeration Type Documentation

enum lsst::afw::coord::CoordSystem

Enumerator
UNKNOWN
FK5
ICRS
GALACTIC
ECLIPTIC
TOPOCENTRIC

Definition at line 54 of file Coord.h.

{ UNKNOWN=-1, FK5, ICRS, GALACTIC, ECLIPTIC, TOPOCENTRIC };

Function Documentation

std::string lsst::afw::coord::angleToDmsString

(

lsst::afw::geom::Angle const

deg

)

a Function to convert a coordinate in decimal degrees to a string with form dd:mm:ss

Todo:

allow a user specified format

Definition at line 293 of file Coord.cc.

                                                         {
    return angleToXmsString(a, afwGeom::degrees);
}

std::string lsst::afw::coord::angleToHmsString

(

lsst::afw::geom::Angle const

deg

)

a function to convert decimal degrees to a string with form hh:mm:ss.s

Definition at line 300 of file Coord.cc.

                                                         {
    return angleToXmsString(a, afwGeom::hours);
}

boost::shared_ptr< Coord > lsst::afw::coord::averageCoord	(	std::vector< boost::shared_ptr< Coord const >> const	coords,
		CoordSystem	system = UNKNOWN
	)

Return average of a list of coordinates

Parameters

[in]	coords	list of coords to average
[in]	system	coordinate system of returned result; if UNKNOWN then all input coordinates must have the same coordinate system, which is used for the result

Exceptions

lsst::pex::exceptions::InvalidParameterError

if system is UNKNOWN and the coords do not all have the same coordinate system

afwGeom::Angle lsst::afw::coord::dmsStringToAngle

(

std::string const

dms

)

Convert a dd:mm:ss string to Angle.

Parameters

dms	Coord as a string in dd:mm:ss format

Definition at line 344 of file Coord.cc.

      {
    return xmsStringToAngle(dms, afwGeom::degrees);
}

afwGeom::Angle lsst::afw::coord::eclipticPoleInclination

(

double const

epoch

)

get the inclination of the ecliptic pole (obliquity) at epoch

Parameters

epoch

desired epoch for inclination

Definition at line 354 of file Coord.cc.

                                          {
    double const T = (epoch - 2000.0)/100.0;
    return (23.0 + 26.0/60.0 + (21.448 - 46.82*T - 0.0006*T*T - 0.0018*T*T*T)/3600.0) * afwGeom::degrees;
}

afwGeom::Angle lsst::afw::coord::hmsStringToAngle

(

std::string const

hms

)

Convert a hh:mm:ss string to Angle.

Definition at line 335 of file Coord.cc.

     {
    return xmsStringToAngle(hms, afwGeom::hours);
}

boost::shared_ptr< afwCoord::Coord > lsst::afw::coord::makeCoord	(	CoordSystem const	system,
		lsst::afw::geom::Angle const	ra,
		lsst::afw::geom::Angle const	dec,
		double const	epoch
	)

Factory function to create a Coord of arbitrary type with decimal RA,Dec.

Note

This factory allows the epoch to be specified but will throw if used with ICRS or Galactic

Most of the other factories (which accept epochs) just call this one indirectly.

Parameters

system	the system (equ, fk5, galactic ..)
ra	right ascension
dec	declination
epoch	epoch of coordinate

Definition at line 1220 of file Coord.cc.

  {

    switch (system) {
      case FK5:
        return std::shared_ptr<Fk5Coord>(new Fk5Coord(ra, dec, epoch));
        break;
      case ICRS:
        throw LSST_EXCEPT(ex::InvalidParameterError,
                          "ICRS has no epoch, use overloaded makeCoord with args (system, ra, dec).");
        break;
      case GALACTIC:
        throw LSST_EXCEPT(ex::InvalidParameterError,
                          "Galactic has no epoch, use overloaded makeCoord with (system, ra, dec).");
        break;
      case ECLIPTIC:
        return std::shared_ptr<EclipticCoord>(new EclipticCoord(ra, dec, epoch));
        break;
      case TOPOCENTRIC:
        throw LSST_EXCEPT(ex::InvalidParameterError,
                          "Cannot make Topocentric with makeCoord() (must also specify Observatory).\n"
                          "Instantiate TopocentricCoord() directly.");
        break;
      default:
        throw LSST_EXCEPT(ex::InvalidParameterError,
            "Undefined CoordSystem: only FK5, ICRS, GALACTIC, ECLIPTIC, and TOPOCENTRIC allowed.");
        break;

    }

}

boost::shared_ptr< afwCoord::Coord > lsst::afw::coord::makeCoord	(	CoordSystem const	system,
		std::string const	ra,
		std::string const	dec,
		double const	epoch
	)

Factory function to create a Coord of arbitrary type with string RA [in degrees, not hours!], Dec.

Note

This factory accepts epoch. There is an overloaded version which uses a default.

Parameters

system	the system (equ, fk5, galactic ..)
ra	right ascension
dec	declination
epoch	epoch of coordinate

Definition at line 1372 of file Coord.cc.

                                    {
    return makeCoord(system, dmsStringToAngle(ra), dmsStringToAngle(dec), epoch);
}

boost::shared_ptr< afwCoord::Coord > lsst::afw::coord::makeCoord	(	CoordSystem const	system,
		lsst::afw::geom::Point2D const &	p2d,
		lsst::afw::geom::AngleUnit	unit,
		double const	epoch
	)

Factory function to create a Coord of arbitrary type with Point2D.

Note

This factory accepts epoch. There is an overloaded version which uses a default.

Parameters

system	the system (equ, fk5, galactic ..)
p2d	the (eg) ra,dec in a Point2D
unit	the units (eg. degrees, radians)
epoch	epoch of coordinate

Definition at line 1336 of file Coord.cc.

  {
    if (unit == afwGeom::hours) {
        return makeCoord(system, afwGeom::Angle(p2d.getX(), afwGeom::hours), afwGeom::Angle(p2d.getY(), afwGeom::degrees), epoch);
    } else {
        return makeCoord(system, afwGeom::Angle(p2d.getX(), unit), afwGeom::Angle(p2d.getY(), unit), epoch);
    }
}

boost::shared_ptr< afwCoord::Coord > lsst::afw::coord::makeCoord	(	CoordSystem const	system,
		lsst::afw::geom::Point3D const &	p3d,
		double const	epoch,
		bool	normalize = true,
		lsst::afw::geom::Angle const	defaultLongitude = lsst::afw::geom::Angle(0.)
	)

Factory function to create a Coord of arbitrary type with a Point3D.

Note

This factory accepts epoch. There is an overloaded version which uses a default.

Parameters

system	the system (equ, fk5, galactic ..)
p3d	the coord in Point3D format
epoch	epoch of coordinate
normalize	normalize the p3d provided
defaultLongitude	longitude to use if x=y=0

Definition at line 1305 of file Coord.cc.

  {
    Coord c(p3d, 2000.0, normalize, defaultLongitude);
    return makeCoord(system, c.getLongitude(), c.getLatitude(), epoch);
}

boost::shared_ptr< afwCoord::Coord > lsst::afw::coord::makeCoord

(

CoordSystem const

system

)

Lightweight factory to make an empty coord.

Parameters

system

the system (FK5, ICRS, etc)

Definition at line 1398 of file Coord.cc.

                                    {
    switch (system) {
      case FK5:
        return std::shared_ptr<Fk5Coord>(new Fk5Coord());
        break;
      case ICRS:
        return std::shared_ptr<IcrsCoord>(new IcrsCoord());
        break;
      case GALACTIC:
        return std::shared_ptr<GalacticCoord>(new GalacticCoord());
        break;
      case ECLIPTIC:
        return std::shared_ptr<EclipticCoord>(new EclipticCoord());
        break;
      case TOPOCENTRIC:
        throw LSST_EXCEPT(ex::InvalidParameterError,
                          "Cannot make Topocentric with makeCoord() (must also specify Observatory).\n"
                          "Instantiate TopocentricCoord() directly.");
        break;
      default:
        throw LSST_EXCEPT(ex::InvalidParameterError,
                          "Undefined CoordSystem: only FK5, ICRS, GALACTIC, ECLIPTIC, allowed.");
        break;

    }
}

boost::shared_ptr< afwCoord::Coord > lsst::afw::coord::makeCoord	(	CoordSystem const	system,
		lsst::afw::geom::Angle const	ra,
		lsst::afw::geom::Angle const	dec
	)

Factory function to create a Coord of arbitrary type with decimal RA,Dec in degrees.

Note

This factory assumes a default epoch

Most of the other factories (which don't accept epoch) call this one.

Parameters

system	the system (equ, fk5, galactic ..)
ra	right ascension
dec	declination

Definition at line 1264 of file Coord.cc.

  {

    switch (system) {
      case FK5:
        return std::shared_ptr<Fk5Coord>(new Fk5Coord(ra, dec, 2000.0));
        break;
      case ICRS:
        return std::shared_ptr<IcrsCoord>(new IcrsCoord(ra, dec));
        break;
      case GALACTIC:
        return std::shared_ptr<GalacticCoord>(new GalacticCoord(ra, dec));
        break;
      case ECLIPTIC:
        return std::shared_ptr<EclipticCoord>(new EclipticCoord(ra, dec, 2000.0));
        break;
      case TOPOCENTRIC:
        throw LSST_EXCEPT(ex::InvalidParameterError,
                          "Cannot make Topocentric with makeCoord() (must also specify Observatory).\n"
                          "Instantiate TopocentricCoord() directly.");
        break;
      default:
        throw LSST_EXCEPT(ex::InvalidParameterError,
            "Undefined CoordSystem: only FK5, ICRS, GALACTIC, ECLIPTIC, and TOPOCENTRIC allowed.");
        break;

    }

}

boost::shared_ptr< afwCoord::Coord > lsst::afw::coord::makeCoord	(	CoordSystem const	system,
		std::string const	ra,
		std::string const	dec
	)

Factory function to create a Coord of arbitrary type with string RA [in degrees, not hours!], Dec.

Note

This factory uses a default epoch. There is an overloaded version which accepts an epoch.

Parameters

system	the system (equ, fk5, galactic ..)
ra	right ascension
dec	declination

Definition at line 1385 of file Coord.cc.

                                    {
    return makeCoord(system, dmsStringToAngle(ra), dmsStringToAngle(dec));
}

boost::shared_ptr< afwCoord::Coord > lsst::afw::coord::makeCoord	(	CoordSystem const	system,
		lsst::afw::geom::Point2D const &	p2d,
		lsst::afw::geom::AngleUnit	unit
	)

Factory function to create a Coord of arbitrary type with Point2D.

Note

This factory uses a default epoch. There is an overloaded version which accepts an epoch.

Parameters

system	the system (equ, fk5, galactic ..)
p2d	the (eg) ra,dec in a Point2D
unit	the units (eg. degrees, radians)

Definition at line 1355 of file Coord.cc.

  {
    if (unit == afwGeom::hours) {
        return makeCoord(system, afwGeom::Angle(p2d.getX(), afwGeom::hours), afwGeom::Angle(p2d.getY(), afwGeom::degrees));
    } else {
        return makeCoord(system, afwGeom::Angle(p2d.getX(), unit), afwGeom::Angle(p2d.getY(), unit));
    }
}

boost::shared_ptr< afwCoord::Coord > lsst::afw::coord::makeCoord	(	CoordSystem const	system,
		lsst::afw::geom::Point3D const &	p3d,
		bool	normalize = true,
		lsst::afw::geom::Angle const	defaultLongitude = lsst::afw::geom::Angle(0.)
	)

Factory function to create a Coord of arbitrary type with a Point3D.

Note

This factory uses a default epoch. There is an overloaded version which accepts an epoch.

Parameters

system	the system (equ, fk5, galactic ..)
p3d	the coord in Point3D format
normalize	normalize the p3d provided
defaultLongitude	longitude to use if x=y=0

Definition at line 1321 of file Coord.cc.

  {
    Coord c(p3d, 2000.0, normalize, defaultLongitude);
    return makeCoord(system, c.getLongitude(), c.getLatitude());
}

afwCoord::CoordSystem lsst::afw::coord::makeCoordEnum

(

std::string const

system

)

A utility function to get the enum value of a coordinate system from a string name.

Definition at line 117 of file Coord.cc.

                                                                  {
    static CoordSystemMap idmap = getCoordSystemMap();
    if (idmap.find(system) != idmap.end()) {
        return idmap[system];
    } else {
        throw LSST_EXCEPT(ex::InvalidParameterError, "System " + system + " not defined.");
    }
}

std::ostream & lsst::afw::coord::operator<<	(	std::ostream &	os,
		coord::Observatory const &	obs
	)

Print an Observatory to the stream

Parameters

os	Stream to print to
obs	the Observatory to print

Definition at line 158 of file Observatory.cc.

{
    return os << (boost::format("%gW, %gN  %g")
                  % obs.getLatitude().asDegrees()
                  % obs.getLongitude().asDegrees()
                  % obs.getElevation()).str();
}

std::ostream & lsst::afw::coord::operator<<	(	std::ostream &	os,
		afwCoord::Coord const &	coord
	)

Definition at line 1427 of file Coord.cc.

                                                                              {
    auto const className = coord.getClassName();
    auto const coordSystem = coord.getCoordSystem();
    os << (boost::format("%s(%.7f, %.7f")
            % className
            % coord[0].asDegrees()
            % coord[1].asDegrees()).str();
    if (coordSystem == TOPOCENTRIC) {
        os << (boost::format(", %.12f, (%s)")
                % coord.getEpoch()
                % dynamic_cast<afwCoord::TopocentricCoord const &>(coord).getObservatory()).str();
    } else if (coordSystem != ICRS && coordSystem != GALACTIC) {
        os << (boost::format(", %.2f") % coord.getEpoch()).str();
    }
    os << ")";
    return os;
}