CESkyCoord class is responsible for doing all of the celestial coordinate conversions. Command line tools are also available for "on the fly" conversions.

The different coordinate systems used:

CIRS: Earth-centric coordinate systems
ICRS: Solar system barycentric coordinate system
Galactic: Galactic coordinates
Observed: Observer specific coordinate system
Ecliptic: Solarsystem barycentric ecliptic coordinates

Definition at line 49 of file CESkyCoord.h.

Public Member Functions
virtual CEAngle	AngularSeparation (const CESkyCoord &coords) const
	Get the angular separation between the coordinates represented by this object and another coordinate object. More...

	CESkyCoord ()
	Default constructor. More...

	CESkyCoord (const CEAngle &xcoord, const CEAngle &ycoord, const CESkyCoordType &coord_type=CESkyCoordType::ICRS)
	Primary constructor. More...

	CESkyCoord (const CECoordinates &other)
	Copy constructor. More...

	CESkyCoord (const CESkyCoord &other)
	Copy constructor. More...

CESkyCoord	ConvertTo (const CESkyCoordType &output_coord_type, const CEDate &date=CEDate(), const CEObserver &observer=CEObserver())
	Convert these coordinates to another coordinate system NOTE: If this object is not OBSERVED coordinates, only JD is needed. More...

CESkyCoord	ConvertToCIRS (const CEDate &date=CEDate(), const CEObserver &observer=CEObserver())
	Convert this coordinate to CIRS coordinates. More...

CESkyCoord	ConvertToEcliptic (const CEDate &date=CEDate(), const CEObserver &observer=CEObserver())
	Convert this coordinate to ECLIPTIC coordinates. More...

CESkyCoord	ConvertToGalactic (const CEDate &date=CEDate(), const CEObserver &observer=CEObserver())
	Convert this coordinate to GALACTIC coordinates. More...

CESkyCoord	ConvertToICRS (const CEDate &date=CEDate(), const CEObserver &observer=CEObserver())
	Convert this coordinate to ICRS coordinates. More...

CESkyCoord	ConvertToObserved (const CEDate &date=CEDate(), const CEObserver &observer=CEObserver())
	Convert this coordinate to OBSERVED coordinates. More...

CESkyCoordType	GetCoordSystem (void) const
	Return coordinate system. More...

CESkyCoord &	operator= (const CESkyCoord &other)
	Overloaded '=' (assignment) operator. More...

std::string	print (void) const
	Generate a message string that specifies the information about this coordinate. More...

virtual void	SetCoordinates (const CEAngle &xcoord, const CEAngle &ycoord, const CESkyCoordType &coord_type=CESkyCoordType::ICRS) const
	Set the coordinates of this object. More...

virtual void	SetCoordinates (const CESkyCoord &coords)
	Set the coordinates from another CESkyCoord object. More...

virtual CEAngle	XCoord (const CEDate &jd=CppEphem::julian_date_J2000()) const
	Return x coordinate at given Julian date. More...

virtual CEAngle	YCoord (const CEDate &jd=CppEphem::julian_date_J2000()) const
	Return y coordinate at given Julian date. More...

virtual	~CESkyCoord ()
	Destructor. More...

Static Public Member Functions
static CEAngle	AngularSeparation (const CEAngle &xcoord_first, const CEAngle &ycoord_first, const CEAngle &xcoord_second, const CEAngle &ycoord_second)
	Get the angular separation between two sets of coordinates. More...

static CEAngle	AngularSeparation (const CESkyCoord &coords1, const CESkyCoord &coords2)
	Get the angular separation between two coordinate objects. More...

static void	CIRS2Ecliptic (const CESkyCoord &in_cirs, CESkyCoord *out_ecliptic, const CEDate &date=CEDate())
	Convert CIRS to ECLIPTIC coordinates. More...

static void	CIRS2Galactic (const CESkyCoord &in_cirs, CESkyCoord *out_galactic, const CEDate &date=CEDate())
	Convert CIRS to Galactic coordinates. More...

static void	CIRS2ICRS (const CESkyCoord &in_cirs, CESkyCoord *out_icrs, const CEDate &date=CEDate())
	Convert CIRS to ICRS coordinates. More...

static void	CIRS2Observed (const CESkyCoord &in_cirs, CESkyCoord out_observed, const CEDate &date, const CEObserver &observer, CESkyCoord observed_cirs=nullptr, CEAngle *hour_angle=nullptr)
	CIRS -> Observed (or observer specific) coordinate conversion. More...

static void	Ecliptic2CIRS (const CESkyCoord &in_ecliptic, CESkyCoord *out_cirs, const CEDate &date=CEDate())
	ECLIPTIC -> CIRS coordinate conversion. More...

static void	Ecliptic2Galactic (const CESkyCoord &in_ecliptic, CESkyCoord *out_galactic, const CEDate &date=CEDate())
	ECLIPTIC -> GALACTIC coordinate conversion. More...

static void	Ecliptic2ICRS (const CESkyCoord &in_ecliptic, CESkyCoord *out_icrs, const CEDate &date=CEDate())
	ECLIPTIC -> ICRS coordinate conversion. More...

static void	Ecliptic2Observed (const CESkyCoord &in_ecliptic, CESkyCoord *out_observed, const CEDate &date, const CEObserver &observer)
	ECLIPTIC -> OBSERVED coordinate conversion. More...

static void	Galactic2CIRS (const CESkyCoord &in_galactic, CESkyCoord *out_cirs, const CEDate &date=CEDate())
	GALACTIC -> CIRS coordinate conversion. More...

static void	Galactic2Ecliptic (const CESkyCoord &in_galactic, CESkyCoord *out_ecliptic, const CEDate &date=CEDate())
	GALACTIC -> ECLIPTIC coordinate conversion. More...

static void	Galactic2ICRS (const CESkyCoord &in_galactic, CESkyCoord *out_icrs)
	GALACTIC -> ICRS coordinate conversion. More...

static void	Galactic2Observed (const CESkyCoord &in_galactic, CESkyCoord out_observed, const CEDate &date, const CEObserver &observer, CESkyCoord observed_galactic=nullptr, CEAngle *hour_angle=nullptr)
	GALACTIC -> OBSERVED coordinate conversion. More...

static void	ICRS2CIRS (const CESkyCoord &in_icrs, CESkyCoord *out_cirs, const CEDate &date=CEDate())
	ICRS -> CIRS coordinate conversion. More...

static void	ICRS2Ecliptic (const CESkyCoord &in_icrs, CESkyCoord *out_ecliptic, const CEDate &date=CEDate())
	ICRS -> ECLIPTIC coordinate conversion. More...

static void	ICRS2Galactic (const CESkyCoord &in_icrs, CESkyCoord *out_galactic)
	ICRS -> GALACTIC coordinate conversion. More...

static void	ICRS2Observed (const CESkyCoord &in_icrs, CESkyCoord out_observed, const CEDate &date, const CEObserver &observer, CESkyCoord observed_cirs=nullptr, CEAngle *hour_angle=nullptr)
	ICRS -> OBSERVED coordinate conversion. More...

static void	Observed2CIRS (const CESkyCoord &in_observed, CESkyCoord *out_cirs, const CEDate &date, const CEObserver &observer)
	OBSERVED -> CIRS coordinate conversion. More...

static void	Observed2Ecliptic (const CESkyCoord &in_observed, CESkyCoord *out_ecliptic, const CEDate &date, const CEObserver &observer)
	OBSERVED -> ECLIPTIC coordinate conversion. More...

static void	Observed2Galactic (const CESkyCoord &in_observed, CESkyCoord *out_galactic, const CEDate &date, const CEObserver &observer)
	OBSERVED -> GALACTIC coordinate conversion. More...

static void	Observed2ICRS (const CESkyCoord &in_observed, CESkyCoord *out_icrs, const CEDate &date, const CEObserver &observer)
	OBSERVED -> ICRS coordinate conversion. More...

Private Member Functions
void	copy_members (const CESkyCoord &other)
	Copy data members from another CESkyCoord object. More...

void	free_members (void)
	Cleanup data members that need to be freed or cleared. More...

void	init_members (void)
	Set initial values and allocate memory for data members. More...

Private Attributes
CESkyCoordType	coord_type_

CEAngle	xcoord_

CEAngle	ycoord_

Friends
bool	operator!= (const CESkyCoord &lhs, const CESkyCoord &rhs)
	Compare two coordinate objects. More...

bool	operator== (const CESkyCoord &lhs, const CESkyCoord &rhs)
	Compare two coordinate objects. More...

#include <CESkyCoord.h>

Inheritance diagram for CESkyCoord:

[legend]

Collaboration diagram for CESkyCoord:

[legend]

Constructor & Destructor Documentation

◆ CESkyCoord() [1/4]

CESkyCoord::CESkyCoord ( )

Default constructor.

Definition at line 38 of file CESkyCoord.cpp.

◆ CESkyCoord() [2/4]

CESkyCoord::CESkyCoord	(	const CEAngle &	xcoord,
		const CEAngle &	ycoord,
		const CESkyCoordType &	coord_type = `CESkyCoordType::ICRS`
	)

Primary constructor.

Parameters

[in]	xcoord	X-Coordinate
[in]	ycoord	Y-Coordinate
[in]	coord_type	Coordinate type (see CESkyCoordType)

Definition at line 51 of file CESkyCoord.cpp.

◆ CESkyCoord() [3/4]

CESkyCoord::CESkyCoord ( const CECoordinates & other )

explicit

Copy constructor.

Definition at line 67 of file CESkyCoord.cpp.

◆ CESkyCoord() [4/4]

CESkyCoord::CESkyCoord ( const CESkyCoord & other )

Copy constructor.

Definition at line 79 of file CESkyCoord.cpp.

◆ ~CESkyCoord()

CESkyCoord::~CESkyCoord ( )

virtual

Destructor.

Definition at line 90 of file CESkyCoord.cpp.

Member Function Documentation

◆ AngularSeparation() [1/3]

CEAngle CESkyCoord::AngularSeparation	(	const CEAngle &	xcoord_first,
		const CEAngle &	ycoord_first,
		const CEAngle &	xcoord_second,
		const CEAngle &	ycoord_second
	)

static

Get the angular separation between two sets of coordinates.

Method utilizes the SOFA 'iauSeps' algorithm. NOTE: The coordinates are both expected to be in the same coordinate system!

Parameters

[in]	xcoord_first	X-value for first set of coordinates
[in]	ycoord_first	Y-value for first set of coordinates
[in]	xcoord_second	X-value for second set of coordiantes
[in]	ycoord_second	Y-value for second set of coordinates

Returns: Angular separation between two coordinates

Note that the x-coordinates are expected in the range [0, 2pi] and the y-coordinates are expected in the range [-pi, pi]. Because of this, you need to pass:

ICRS: RA, Dec
CIRS: RA, Dec
GALACTIC: G.Lon, G.Lat
OBSERVED: Az, Alt (by default the y-coordinate is zenith)

Definition at line 183 of file CESkyCoord.cpp.

◆ AngularSeparation() [2/3]

CEAngle CESkyCoord::AngularSeparation ( const CESkyCoord & coords ) const

virtual

Get the angular separation between the coordinates represented by this object and another coordinate object.

NOTE: The coordinates are both expected to be in the same coordinate system! If they are in different coordinate systems, use "ConvertTo()" first.

Parameters

[in] coords Another set of coordinates

Returns: Angular separation between these coordinates and 'coords'

Definition at line 119 of file CESkyCoord.cpp.

◆ AngularSeparation() [3/3]

CEAngle CESkyCoord::AngularSeparation	(	const CESkyCoord &	coords1,
		const CESkyCoord &	coords2
	)

static

Get the angular separation between two coordinate objects.

NOTE: The coordinates are both expected to be in the same coordinate system! If they are in different coordinate systems, use "ConvertTo()" first.

Parameters

[in]	coords1	First set of coordinates
[in]	coords2	Second set of coordinates
[in]	return_angle_type	Specify whether to return angle as DEGREES or RADIANS

Returns: Angular separation between two coordiantes

Note that the x-coordinates are expected in the range [0, 2pi] and the y-coordinates are expected in the range [-pi, pi]. Because of this, OBSERVED coordinates first convert the zenith angle to altitude

Definition at line 140 of file CESkyCoord.cpp.

◆ CIRS2Ecliptic()

void CESkyCoord::CIRS2Ecliptic	(	const CESkyCoord &	in_cirs,
		CESkyCoord *	out_ecliptic,
		const CEDate &	date = `CEDate()`
	)

static

Convert CIRS to ECLIPTIC coordinates.

Parameters

[in]	in_cirs	Input CIRS coordinates
[out]	out_ecliptic	Output ECLIPTIC coordinates
[in]	date	Date for conversion

Definition at line 322 of file CESkyCoord.cpp.

◆ CIRS2Galactic()

void CESkyCoord::CIRS2Galactic	(	const CESkyCoord &	in_cirs,
		CESkyCoord *	out_galactic,
		const CEDate &	date = `CEDate()`
	)

static

Convert CIRS to Galactic coordinates.

Parameters

[in]	in_cirs	Input CIRS coordinates
[out]	out_galactic	Output Galactic coordinates
[in]	date	Date for conversion

Definition at line 235 of file CESkyCoord.cpp.

◆ CIRS2ICRS()

void CESkyCoord::CIRS2ICRS	(	const CESkyCoord &	in_cirs,
		CESkyCoord *	out_icrs,
		const CEDate &	date = `CEDate()`
	)

static

Convert CIRS to ICRS coordinates.

Parameters

[in]	in_cirs	Input CIRS coordinates
[out]	out_icrs	Output ICRS coordinates
[in]	date	Date for conversion

Definition at line 201 of file CESkyCoord.cpp.

◆ CIRS2Observed()

void CESkyCoord::CIRS2Observed	(	const CESkyCoord &	in_cirs,
		CESkyCoord *	out_observed,
		const CEDate &	date,
		const CEObserver &	observer,
		CESkyCoord *	observed_cirs = `nullptr`,
		CEAngle *	hour_angle = `nullptr`
	)

static

CIRS -> Observed (or observer specific) coordinate conversion.

Parameters

[in]	in_cirs	Input CIRS coordinates
[out]	out_observed	Output Observed coordinates
[in]	date	Date for conversion
[in]	observer	Observer information
[out]	observed_cirs	'Observed' CIRS coordinates
[out]	hour_angle	Hour angle of coordinates for observer

Definition at line 258 of file CESkyCoord.cpp.

◆ ConvertTo()

CESkyCoord CESkyCoord::ConvertTo	(	const CESkyCoordType &	output_coord_type,
		const CEDate &	date = `CEDate()`,
		const CEObserver &	observer = `CEObserver()`
	)

Convert these coordinates to another coordinate system NOTE: If this object is not OBSERVED coordinates, only JD is needed.

NOTE: If 'observer' is not nulltr then 'jd' will be ignored and the date will instead be derived from the observers date.

Parameters

[in]	output_coord_type	Output coordinate type (see CESkyCoordType)
[in]	observer	If these coordinates are OBSERVED, then observer represents the observer for these coordinates. Otherwise they represent the observer to convert the coordinates to.
[in]	date	Julian date for conversion

Returns: Coordinates object that represents coordinates we're converting to

Definition at line 786 of file CESkyCoord.cpp.

◆ ConvertToCIRS()

CESkyCoord CESkyCoord::ConvertToCIRS	(	const CEDate &	date = `CEDate()`,
		const CEObserver &	observer = `CEObserver()`
	)

Convert this coordinate to CIRS coordinates.

Parameters

[in]	date	Date for conversion
[in]	observer	Observer information

Note that the date and observer parameters are only necessary if they are need to convert this object

Definition at line 817 of file CESkyCoord.cpp.

◆ ConvertToEcliptic()

CESkyCoord CESkyCoord::ConvertToEcliptic	(	const CEDate &	date = `CEDate()`,
		const CEObserver &	observer = `CEObserver()`
	)

Convert this coordinate to ECLIPTIC coordinates.

Parameters

[in]	date	Date for conversion
[in]	observer	Observer information

Note that the date and observer parameters are only necessary if they are need to convert this object

Definition at line 965 of file CESkyCoord.cpp.

◆ ConvertToGalactic()

CESkyCoord CESkyCoord::ConvertToGalactic	(	const CEDate &	date = `CEDate()`,
		const CEObserver &	observer = `CEObserver()`
	)

Convert this coordinate to GALACTIC coordinates.

Parameters

[in]	date	Date for conversion
[in]	observer	Observer information

Note that the date and observer parameters are only necessary if they are need to convert this object

Definition at line 891 of file CESkyCoord.cpp.

◆ ConvertToICRS()

CESkyCoord CESkyCoord::ConvertToICRS	(	const CEDate &	date = `CEDate()`,
		const CEObserver &	observer = `CEObserver()`
	)

Convert this coordinate to ICRS coordinates.

Parameters

[in]	date	Date for conversion
[in]	observer	Observer information

Note that the date and observer parameters are only necessary if they are need to convert this object

Definition at line 854 of file CESkyCoord.cpp.

◆ ConvertToObserved()

CESkyCoord CESkyCoord::ConvertToObserved	(	const CEDate &	date = `CEDate()`,
		const CEObserver &	observer = `CEObserver()`
	)

Convert this coordinate to OBSERVED coordinates.

Parameters

[in]	date	Date for conversion
[in]	observer	Observer information

Note that the date and observer parameters are only necessary if they are need to convert this object

Definition at line 928 of file CESkyCoord.cpp.

◆ copy_members()

void CESkyCoord::copy_members ( const CESkyCoord & other )

private

Copy data members from another CESkyCoord object.

Parameters

[in] other Another coordinates objec to copy

Definition at line 1041 of file CESkyCoord.cpp.

◆ Ecliptic2CIRS()

void CESkyCoord::Ecliptic2CIRS	(	const CESkyCoord &	in_ecliptic,
		CESkyCoord *	out_cirs,
		const CEDate &	date = `CEDate()`
	)

static

ECLIPTIC -> CIRS coordinate conversion.

Parameters

[in]	in_ecliptic	Input ECLIPTIC coordinates
[out]	out_cirs	Output CIRS coordinates
[in]	date	Date for conversion

Definition at line 686 of file CESkyCoord.cpp.

◆ Ecliptic2Galactic()

void CESkyCoord::Ecliptic2Galactic	(	const CESkyCoord &	in_ecliptic,
		CESkyCoord *	out_galactic,
		const CEDate &	date = `CEDate()`
	)

static

ECLIPTIC -> GALACTIC coordinate conversion.

Parameters

[in]	in_ecliptic	Input ECLIPTIC coordinates
[out]	out_galactic	Output GALACTIC coordinates
[in]	date	Date for conversion

Definition at line 737 of file CESkyCoord.cpp.

◆ Ecliptic2ICRS()

void CESkyCoord::Ecliptic2ICRS	(	const CESkyCoord &	in_ecliptic,
		CESkyCoord *	out_icrs,
		const CEDate &	date = `CEDate()`
	)

static

ECLIPTIC -> ICRS coordinate conversion.

Parameters

[in]	in_ecliptic	Input ECLIPTIC coordinates
[out]	out_icrs	Output ICRS coordinates
[in]	date	Date for conversion

Definition at line 706 of file CESkyCoord.cpp.

◆ Ecliptic2Observed()

void CESkyCoord::Ecliptic2Observed	(	const CESkyCoord &	in_ecliptic,
		CESkyCoord *	out_observed,
		const CEDate &	date,
		const CEObserver &	observer
	)

static

ECLIPTIC -> OBSERVED coordinate conversion.

Parameters

[in]	in_ecliptic	Input ECLIPTIC coordinates
[out]	out_observed	Output OBSERVED coordinates
[in]	date	Date for conversion
[in]	observer	Observer information

Definition at line 758 of file CESkyCoord.cpp.

◆ free_members()

void CESkyCoord::free_members ( void )

private

Cleanup data members that need to be freed or cleared.

Definition at line 1052 of file CESkyCoord.cpp.

◆ Galactic2CIRS()

void CESkyCoord::Galactic2CIRS	(	const CESkyCoord &	in_galactic,
		CESkyCoord *	out_cirs,
		const CEDate &	date = `CEDate()`
	)

static

GALACTIC -> CIRS coordinate conversion.

Parameters

[in]	in_galactic	Input GALACTIC coordinates
[out]	out_cirs	Output CIRS coordinates
[in]	date	Date for conversion

Definition at line 471 of file CESkyCoord.cpp.

◆ Galactic2Ecliptic()

void CESkyCoord::Galactic2Ecliptic	(	const CESkyCoord &	in_galactic,
		CESkyCoord *	out_ecliptic,
		const CEDate &	date = `CEDate()`
	)

static

GALACTIC -> ECLIPTIC coordinate conversion.

Parameters

[in]	in_galactic	Input GALACTIC coordinates
[out]	out_ecliptic	Output ECLIPTIC coordinates
[in]	date	Date for conversion

Definition at line 552 of file CESkyCoord.cpp.

◆ Galactic2ICRS()

void CESkyCoord::Galactic2ICRS	(	const CESkyCoord &	in_galactic,
		CESkyCoord *	out_icrs
	)

static

GALACTIC -> ICRS coordinate conversion.

Parameters

[in]	in_galactic	Input GALACTIC coordinates
[out]	out_icrs	Output ICRS coordinates

Definition at line 492 of file CESkyCoord.cpp.

◆ Galactic2Observed()

void CESkyCoord::Galactic2Observed	(	const CESkyCoord &	in_galactic,
		CESkyCoord *	out_observed,
		const CEDate &	date,
		const CEObserver &	observer,
		CESkyCoord *	observed_galactic = `nullptr`,
		CEAngle *	hour_angle = `nullptr`
	)

static

GALACTIC -> OBSERVED coordinate conversion.

Parameters

[in]	in_galactic	Input GALACTIC coordinates
[out]	out_observed	Output OBSERVED coordinates
[in]	date	Date for conversion
[in]	observer	Observer information
[out]	observed_galactic	'Observed' GALACTIC coordinates
[out]	hour_angle	Hour angle of coordinates for observer

This method takes in an optional observed_galactic parameter that stores the GALACTIC coordinates of a given object as they would be observed

Definition at line 520 of file CESkyCoord.cpp.

◆ GetCoordSystem()

CESkyCoordType CESkyCoord::GetCoordSystem ( void ) const

inline

Return coordinate system.

Returns: Coordinate type of this object

Definition at line 251 of file CESkyCoord.h.

◆ ICRS2CIRS()

void CESkyCoord::ICRS2CIRS	(	const CESkyCoord &	in_icrs,
		CESkyCoord *	out_cirs,
		const CEDate &	date = `CEDate()`
	)

static

ICRS -> CIRS coordinate conversion.

Parameters

[in]	in_icrs	Input ICRS coordinates
[out]	out_cirs	Output CIRS coordinates
[in]	date	Date for conversion

Definition at line 342 of file CESkyCoord.cpp.

◆ ICRS2Ecliptic()

void CESkyCoord::ICRS2Ecliptic	(	const CESkyCoord &	in_icrs,
		CESkyCoord *	out_ecliptic,
		const CEDate &	date = `CEDate()`
	)

static

ICRS -> ECLIPTIC coordinate conversion.

Parameters

[in]	in_icrs	Input ICRS coordinates
[out]	out_ecliptic	Output ECLIPTIC coordinates
[in]	date	Date for conversion

Definition at line 440 of file CESkyCoord.cpp.

◆ ICRS2Galactic()

void CESkyCoord::ICRS2Galactic	(	const CESkyCoord &	in_icrs,
		CESkyCoord *	out_galactic
	)

static

ICRS -> GALACTIC coordinate conversion.

Parameters

[in]	in_icrs	Input ICRS coordinates
[out]	out_galactic	Output GALACTIC coordinates

Definition at line 379 of file CESkyCoord.cpp.

◆ ICRS2Observed()

void CESkyCoord::ICRS2Observed	(	const CESkyCoord &	in_icrs,
		CESkyCoord *	out_observed,
		const CEDate &	date,
		const CEObserver &	observer,
		CESkyCoord *	observed_icrs = `nullptr`,
		CEAngle *	hour_angle = `nullptr`
	)

static

ICRS -> OBSERVED coordinate conversion.

Parameters

[in]	in_icrs	Input ICRS coordinates
[out]	out_observed	Output OBSERVED coordinates
[in]	date	Date for conversion
[in]	observer	Observer information
[out]	observed_cirs	'Observed' CIRS coordinates
[out]	hour_angle	Hour angle of coordinates for observer

This method takes in an optional observed_cirs parameter that stores the CIRS coordinates of a given object as they would be observed

Definition at line 407 of file CESkyCoord.cpp.

◆ init_members()

void CESkyCoord::init_members ( void )

private

Set initial values and allocate memory for data members.

Definition at line 1061 of file CESkyCoord.cpp.

◆ Observed2CIRS()

void CESkyCoord::Observed2CIRS	(	const CESkyCoord &	in_observed,
		CESkyCoord *	out_cirs,
		const CEDate &	date,
		const CEObserver &	observer
	)

static

OBSERVED -> CIRS coordinate conversion.

Parameters

[in]	in_observed	Input OBSERVED coordinates
[out]	out_cirs	Output CIRS coordinates
[in]	date	Date for conversion
[in]	observer	Observer information

Definition at line 573 of file CESkyCoord.cpp.

◆ Observed2Ecliptic()

void CESkyCoord::Observed2Ecliptic	(	const CESkyCoord &	in_observed,
		CESkyCoord *	out_ecliptic,
		const CEDate &	date,
		const CEObserver &	observer
	)

static

OBSERVED -> ECLIPTIC coordinate conversion.

Parameters

[in]	in_observed	Input OBSERVED coordinates
[out]	out_ecliptic	Output ECLIPTIC coordinates
[in]	date	Date for conversion
[in]	observer	Observer information

Definition at line 665 of file CESkyCoord.cpp.

◆ Observed2Galactic()

void CESkyCoord::Observed2Galactic	(	const CESkyCoord &	in_observed,
		CESkyCoord *	out_galactic,
		const CEDate &	date,
		const CEObserver &	observer
	)

static

OBSERVED -> GALACTIC coordinate conversion.

Parameters

[in]	in_observed	Input OBSERVED coordinates
[out]	out_galactic	Output GALACTIC coordinates
[in]	date	Date for conversion
[in]	observer	Observer information

Definition at line 643 of file CESkyCoord.cpp.

◆ Observed2ICRS()

void CESkyCoord::Observed2ICRS	(	const CESkyCoord &	in_observed,
		CESkyCoord *	out_icrs,
		const CEDate &	date,
		const CEObserver &	observer
	)

static

OBSERVED -> ICRS coordinate conversion.

Parameters

[in]	in_observed	Input OBSERVED coordinates
[out]	out_icrs	Output ICRS coordinates
[in]	date	Date for conversion
[in]	observer	Observer information

Definition at line 621 of file CESkyCoord.cpp.

◆ operator=()

CESkyCoord & CESkyCoord::operator= ( const CESkyCoord & other )

Overloaded '=' (assignment) operator.

Definition at line 99 of file CESkyCoord.cpp.

◆ print()

std::string CESkyCoord::print ( void ) const

Generate a message string that specifies the information about this coordinate.

Returns: String describing this object

Definition at line 1026 of file CESkyCoord.cpp.

◆ SetCoordinates() [1/2]

void CESkyCoord::SetCoordinates	(	const CEAngle &	xcoord,
		const CEAngle &	ycoord,
		const CESkyCoordType &	coord_type = `CESkyCoordType::ICRS`
	)		const

virtual

Set the coordinates of this object.

Parameters

[in]	xcoord	X-coordinate
[in]	ycoord	Y-coordinate
[in]	coord_type	Coordinate type (see CESkyCoordType)

Definition at line 1000 of file CESkyCoord.cpp.

◆ SetCoordinates() [2/2]

void CESkyCoord::SetCoordinates ( const CESkyCoord & coords )

virtual

Set the coordinates from another CESkyCoord object.

Parameters

[in] coords Another coordinates object to copy

Definition at line 1015 of file CESkyCoord.cpp.

◆ XCoord()

CEAngle CESkyCoord::XCoord ( const CEDate & jd = CppEphem::julian_date_J2000() ) const

inlinevirtual

Return x coordinate at given Julian date.

Parameters

[in] jd Julian date (used only by derived classes)

Returns: X-coordinate as a CEAngle

Definition at line 227 of file CESkyCoord.h.

◆ YCoord()

CEAngle CESkyCoord::YCoord ( const CEDate & jd = CppEphem::julian_date_J2000() ) const

inlinevirtual

Return y coordinate at given Julian date.

Parameters

[in] jd Julian date (used only by derived classes)

Returns: X-coordinate as a CEAngle

Definition at line 240 of file CESkyCoord.h.

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	const CESkyCoord &	lhs,
		const CESkyCoord &	rhs
	)

friend

Compare two coordinate objects.

Returns: True if two coordinates are NOT equal to each other

Definition at line 1102 of file CESkyCoord.cpp.

◆ operator==

bool operator==	(	const CESkyCoord &	lhs,
		const CESkyCoord &	rhs
	)

friend

Compare two coordinate objects.

Returns: True if the two coordinates are equal to each other

Definition at line 1074 of file CESkyCoord.cpp.

Member Data Documentation

◆ coord_type_

CESkyCoordType CESkyCoord::coord_type_

mutableprivate

Definition at line 210 of file CESkyCoord.h.

◆ xcoord_

CEAngle CESkyCoord::xcoord_

mutableprivate

Definition at line 208 of file CESkyCoord.h.

◆ ycoord_

CEAngle CESkyCoord::ycoord_

mutableprivate

Definition at line 209 of file CESkyCoord.h.

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

cppephem/include/CESkyCoord.h
cppephem/src/CESkyCoord.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ CESkyCoord() [1/4]

◆ CESkyCoord() [2/4]

◆ CESkyCoord() [3/4]

◆ CESkyCoord() [4/4]

◆ ~CESkyCoord()

Member Function Documentation

◆ AngularSeparation() [1/3]

◆ AngularSeparation() [2/3]

◆ AngularSeparation() [3/3]

◆ CIRS2Ecliptic()

◆ CIRS2Galactic()

◆ CIRS2ICRS()

◆ CIRS2Observed()

◆ ConvertTo()

◆ ConvertToCIRS()

◆ ConvertToEcliptic()

◆ ConvertToGalactic()

◆ ConvertToICRS()

◆ ConvertToObserved()

◆ copy_members()

◆ Ecliptic2CIRS()

◆ Ecliptic2Galactic()

◆ Ecliptic2ICRS()

◆ Ecliptic2Observed()

◆ free_members()

◆ Galactic2CIRS()

◆ Galactic2Ecliptic()

◆ Galactic2ICRS()

◆ Galactic2Observed()

◆ GetCoordSystem()

◆ ICRS2CIRS()

◆ ICRS2Ecliptic()

◆ ICRS2Galactic()

◆ ICRS2Observed()

◆ init_members()

◆ Observed2CIRS()

◆ Observed2Ecliptic()

◆ Observed2Galactic()

◆ Observed2ICRS()

◆ operator=()

◆ print()

◆ SetCoordinates() [1/2]

◆ SetCoordinates() [2/2]

◆ XCoord()

◆ YCoord()

Friends And Related Function Documentation

◆ operator!=

◆ operator==

Member Data Documentation

◆ coord_type_

◆ xcoord_

◆ ycoord_