LAL  7.5.0.1-b72065a
TranslateAngles.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2004, 2015 Reinhard Prix
3 //
4 // This program is free software; you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation; either version 2 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with with program; see the file COPYING. If not, write to the
16 // Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17 // MA 02110-1301 USA
18 //
19 
20 #ifndef _TRANSLATEANGLES_H /* Double-include protection. */
21 #define _TRANSLATEANGLES_H
22 
23 #include <lal/LALDatatypes.h>
24 
25 /* C++ protection. */
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 /**
31  * \defgroup TranslateAngles_h Header TranslateAngles.h
32  * \ingroup lal_support
33  * \author Reinhard Prix
34  * \brief Module for translating between 'hms' (RA) and 'dms' (DEC) angle strings and radians
35  *
36  */
37 
38 /** @{ */
39 
40 // ---------- Function prototypes ----------
41 int XLALTranslateHMStoRAD ( REAL8 *radians, const CHAR *hms );
42 int XLALTranslateDMStoRAD ( REAL8 *radians, const CHAR *dms );
43 CHAR *XLALTranslateRADtoHMS ( REAL8 radians );
44 CHAR *XLALTranslateRADtoDMS ( REAL8 radians );
45 /** @} */
46 
47 
48 /* C++ protection. */
49 #ifdef __cplusplus
50 }
51 #endif
52 
53 #endif /* Double-include protection. */
double REAL8
Double precision real floating-point number (8 bytes).
char CHAR
One-byte signed integer, see Headers LAL(Atomic)Datatypes.h for more details.
int XLALTranslateHMStoRAD(REAL8 *radians, const CHAR *hms)
Translate a string representing an angle in the form "hours:minutes:seconds" into radians.
CHAR * XLALTranslateRADtoHMS(REAL8 radians)
Translate (longitude, right-ascencsion, RA) radians into hours:minutes:seconds (HMS) format,...
int XLALTranslateDMStoRAD(REAL8 *radians, const CHAR *dms)
Translate a string representing an angle in the form "degrees:minutes:seconds" into radians.
CHAR * XLALTranslateRADtoDMS(REAL8 radians)
Translate (latitude, declination, DEC) radians into "sign*degrees:minutes:seconds" (DMS) format,...