LAL  7.1.7.1-2d066e5

Detailed Description

Modules

 Module CelestialCoordinates.c
 Converts among Galactic, ecliptic, and equatorial coordinates.
 
 Module TerrestrialCoordinates.c
 Converts among equatorial, geographic, and horizon coordinates.
 
 Module SkyCoordinates.c
 Automatically converts among sky coordinate systems.
 

Data Structures

struct  SkyPosition
 This structure stores the two spherical coordinates of a sky position; ie a generic latitude and longitude; the structure is not defined specific to a particular coordinate system, but maintains a tag indicating which coordinate system it is expressed in. More...
 
struct  EarthPosition
 This structure stores the location of a point on (or near) the surface of the Earth in both geodetic and geocentric coordinates, as described in TerrestrialCoordinates.c . More...
 
struct  ConvertSkyParams
 This structure stores parameters for the function LALConvertSkyPosition(). More...
 

Enumerations

enum  CoordinateSystem {
  COORDINATESYSTEM_HORIZON, COORDINATESYSTEM_GEOGRAPHIC, COORDINATESYSTEM_EQUATORIAL, COORDINATESYSTEM_ECLIPTIC,
  COORDINATESYSTEM_GALACTIC
}
 This enumerated type is used to identify data as being in one of the coordinate systems discussed in Header SkyCoordinates.h. More...
 

Files

file  GeocentricGeodeticTest.c
 Tests geocentric to geodetic conversion.
 
file  SkyCoordinatesTest.c
 Transforms coordinates among various systems.
 

Error codes

#define SKYCOORDINATESH_ENUL   1
 Unexpected null pointer in arguments. More...
 
#define SKYCOORDINATESH_ESYS   2
 Wrong coordinate system in input. More...
 
#define SKYCOORDINATESH_EZERO   3
 Angular coordinates undefined at origin. More...
 
#define SKYCOORDINATESH_ESING   4
 Point is inside singular ellipsoid. More...
 

Enumeration Type Documentation

◆ CoordinateSystem

This enumerated type is used to identify data as being in one of the coordinate systems discussed in Header SkyCoordinates.h.

Enumerator
COORDINATESYSTEM_HORIZON 

A horizon coordinate system.

COORDINATESYSTEM_GEOGRAPHIC 

The Earth-fixed geographic coordinate system.

COORDINATESYSTEM_EQUATORIAL 

The sky-fixed equatorial coordinate system.

COORDINATESYSTEM_ECLIPTIC 

The ecliptic coordinate system.

COORDINATESYSTEM_GALACTIC 

The galactic coordinate system.

Definition at line 56 of file SkyCoordinates.h.

Macro Definition Documentation

◆ SKYCOORDINATESH_ENUL

#define SKYCOORDINATESH_ENUL   1

Unexpected null pointer in arguments.

Definition at line 36 of file SkyCoordinates.h.

◆ SKYCOORDINATESH_ESYS

#define SKYCOORDINATESH_ESYS   2

Wrong coordinate system in input.

Definition at line 37 of file SkyCoordinates.h.

◆ SKYCOORDINATESH_EZERO

#define SKYCOORDINATESH_EZERO   3

Angular coordinates undefined at origin.

Definition at line 38 of file SkyCoordinates.h.

◆ SKYCOORDINATESH_ESING

#define SKYCOORDINATESH_ESING   4

Point is inside singular ellipsoid.

Definition at line 39 of file SkyCoordinates.h.