summaryrefslogtreecommitdiffstats
path: root/ast/slamap.h
blob: e7280b8756bfd4ef4d189caaea2b344bfcefeb9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
#if !defined( SLAMAP_INCLUDED )  /* Include this file only once */
#define SLAMAP_INCLUDED
/*
*+
*  Name:
*     slamap.h

*  Type:
*     C include file.

*  Purpose:
*     Define the interface to the SlaMap class.

*  Invocation:
*     #include "slamap.h"

*  Description:
*     This include file defines the interface to the SlaMap class and
*     provides the type definitions, function prototypes and macros,
*     etc.  needed to use this class.
*
*     The SlaMap class encapsulates the conversions provided by the
*     SLALIB library (SUN/67) for converting between different sky
*     coordinate systems.  Since, typically, a sequence of these
*     SLALIB conversions is required, an SlaMap can be used to
*     accumulate a series of conversions which it then applies in
*     sequence.

*  Inheritance:
*     The SlaMap class inherits from the Mapping class.

*  Attributes Over-Ridden:
*     None.

*  New Attributes Defined:
*     None.

*  Methods Over-Ridden:
*     Public:
*        astTransform
*           Use an SlaMap to transform a set of points.

*     Protected:
*        astMapMerge
*           Simplify a sequence of Mappings containing an SlaMap.

*  New Methods Defined:
*     Public:
*        astSlaAdd
*           Add a coordinate conversion step to an SlaMap.

*     Private:
*        None.

*  Other Class Functions:
*     Public:
*        astIsASlaMap
*           Test class membership.
*        astSlaMap
*           Create an SlaMap.

*     Protected:
*        astCheckSlaMap
*           Validate class membership.
*        astInitSlaMap
*           Initialise an SlaMap.
*        astLoadSlaMap
*           Load an SlaMap.

*  Macros:
*     None.

*  Type Definitions:
*     Public:
*        AstSlaMap
*           SlaMap object type.

*     Protected:
*        AstSlaMapVtab
*           SlaMap virtual function table type.

*  Feature Test Macros:
*     astCLASS
*        If the astCLASS macro is undefined, only public symbols are
*        made available, otherwise protected symbols (for use in other
*        class implementations) are defined. This macro also affects
*        the reporting of error context information, which is only
*        provided for external calls to the AST library.

*  Copyright:
*     Copyright (C) 1997-2006 Council for the Central Laboratory of the
*     Research Councils

*  Licence:
*     This program is free software: you can redistribute it and/or
*     modify it under the terms of the GNU Lesser General Public
*     License as published by the Free Software Foundation, either
*     version 3 of the License, or (at your option) any later
*     version.
*
*     This program is distributed in the hope that it will be useful,
*     but WITHOUT ANY WARRANTY; without even the implied warranty of
*     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*     GNU Lesser General Public License for more details.
*
*     You should have received a copy of the GNU Lesser General
*     License along with this program.  If not, see
*     <http://www.gnu.org/licenses/>.

*  Authors:
*     RFWS: R.F. Warren-Smith (Starlink)
*     DSB: David S. Berry (Starlink)

*  History:
*     26-APR-1996 (RFWS):
*        Original version.
*     26-SEP-1996 (RFWS):
*        Added external interface and I/O facilities.
*     23-MAY-1997 (RFWS):
*        Over-ride the astMapMerge method.
*     15-OCT-2002 (DSB):
*        Added astSTPConv, astSTPConv1, and STP coordinate system macros.
*     8-JAN-2003 (DSB):
*        Added protected astInitSlaMapVtab method.
*     22-FEB-2006 (DSB):
*        Added cvtextra to the AstSlaMap structure.
*-
*/

/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */
#include "mapping.h"             /* Coordinate mappings (parent class) */

#if defined(astCLASS)            /* Protected */
#include "pointset.h"            /* Sets of points/coordinates */
#include "channel.h"             /* I/O channels */
#endif

/* C header files. */
/* --------------- */
#if defined(astCLASS)            /* Protected */
#include <stddef.h>
#endif


/* Macros */
/* ====== */
#if defined(astCLASS)            /* Protected */
#define AST__NOSTP -1 /* An invalid value for an STP coordinate system */
#define AST__HAE  0   /* Heliocentric-aries-ecliptic spherical coordinates */
#define AST__HAEC 1   /* Heliocentric-aries-ecliptic cartesian coordinates */
#define AST__HAQ  2   /* Heliocentric-aries-equatorial spherical coordinates */
#define AST__HAQC 3   /* Heliocentric-aries-equatorial cartesian coordinates */
#define AST__HG	  4   /* Heliographic spherical coordinates */
#define AST__HGC  5   /* Heliographic cartesian coordinates */
#define AST__HPC  6   /* Helioprojective-cartesian spherical coordinates */
#define AST__HPCC 7   /* Helioprojective-cartesian cartesian coordinates */
#define AST__HPR  8   /* Helioprojective-radial spherical coordinates */
#define AST__HPRC 9   /* Helioprojective-radial cartesian coordinates */
#define AST__GSE  10  /* Geocentric-solar-ecliptic spherical coordinates */
#define AST__GSEC 11  /* Geocentric-solar-ecliptic cartesian coordinates */
#endif

/* One IAU astronomical unit, in metres. */
#define AST__AU 1.49597870E11

/* One solar radius (top of photosphere?), in metres (from "The Explanatory
   Supplement to the Astronomical Almanac"). */
#define AST__SOLRAD 6.96E8

/* Define a dummy __attribute__ macro for use on non-GNU compilers. */
#ifndef __GNUC__
#  define  __attribute__(x)  /*NOTHING*/
#endif

/* SlaMap structure. */
/* ----------------- */
/* This structure contains all information that is unique to each
   object in the class (e.g. its instance variables). */
typedef struct AstSlaMap {

/* Attributes inherited from the parent class. */
   AstMapping mapping;           /* Parent class structure */

/* Attributes specific to objects in this class. */
   int *cvttype;                 /* Pointer to array of conversion types */
   double **cvtargs;             /* Pointer to argument list pointer array */
   double **cvtextra;            /* Pointer to intermediate values pointer array */
   int ncvt;                     /* Number of conversions to perform */
} AstSlaMap;

/* Virtual function table. */
/* ----------------------- */
/* This table contains all information that is the same for all
   objects in the class (e.g. pointers to its virtual functions). */
#if defined(astCLASS)            /* Protected */
typedef struct AstSlaMapVtab {

/* Properties (e.g. methods) inherited from the parent class. */
   AstMappingVtab mapping_vtab;  /* Parent class virtual function table */

/* A Unique identifier to determine class membership. */
   AstClassIdentifier id;

/* Properties (e.g. methods) specific to this class. */
   void (* SlaAdd)( AstSlaMap *, const char *, int, const double[], int * );
   int (* SlaIsEmpty)( AstSlaMap *, int * );
} AstSlaMapVtab;

#if defined(THREAD_SAFE)

/* Define a structure holding all data items that are global within this
   class. */
typedef struct AstSlaMapGlobals {
   AstSlaMapVtab Class_Vtab;
   int Class_Init;
   double Eq_Cache;
   double Ep_Cache;
   double Amprms_Cache[ 21 ];
} AstSlaMapGlobals;

#endif

#endif

/* Function prototypes. */
/* ==================== */
/* Prototypes for standard class functions. */
/* ---------------------------------------- */
astPROTO_CHECK(SlaMap)           /* Check class membership */
astPROTO_ISA(SlaMap)             /* Test class membership */

/* Constructor. */
#if defined(astCLASS)            /* Protected. */
AstSlaMap *astSlaMap_( int, const char *, int *, ...);
#else
AstSlaMap *astSlaMapId_( int, const char *, ... )__attribute__((format(printf,2,3)));
#endif

#if defined(astCLASS)            /* Protected */

/* Initialiser. */
AstSlaMap *astInitSlaMap_( void *, size_t, int, AstSlaMapVtab *,
                           const char *, int, int * );

/* Vtab initialiser. */
void astInitSlaMapVtab_( AstSlaMapVtab *, const char *, int * );

/* Loader. */
AstSlaMap *astLoadSlaMap_( void *, size_t, AstSlaMapVtab *,
                           const char *, AstChannel *, int * );

/* Thread-safe initialiser for all global data used by this module. */
#if defined(THREAD_SAFE)
void astInitSlaMapGlobals_( AstSlaMapGlobals * );
#endif

/* Other functions. */
void astSTPConv1_( double, int, double[3], double[3], int, double[3], double[3], int * );
void astSTPConv_( double, int, int, double[3], double *[3], int, double[3], double *[3], int * );

#endif

/* Prototypes for member functions. */
/* -------------------------------- */
void astSlaAdd_( AstSlaMap *, const char *, int, const double[], int * );
int astSlaIsEmpty_( AstSlaMap *, int * );

/* Function interfaces. */
/* ==================== */
/* These macros are wrap-ups for the functions defined by this class
   to make them easier to invoke (e.g. to avoid type mis-matches when
   passing pointers to objects from derived classes). */

/* Interfaces to standard class functions. */
/* --------------------------------------- */
/* Some of these functions provide validation, so we cannot use them
   to validate their own arguments. We must use a cast when passing
   object pointers (so that they can accept objects from derived
   classes). */

/* Check class membership. */
#define astCheckSlaMap(this) astINVOKE_CHECK(SlaMap,this,0)
#define astVerifySlaMap(this) astINVOKE_CHECK(SlaMap,this,1)

/* Test class membership. */
#define astIsASlaMap(this) astINVOKE_ISA(SlaMap,this)

/* Constructor. */
#if defined(astCLASS)            /* Protected. */
#define astSlaMap astINVOKE(F,astSlaMap_)
#else
#define astSlaMap astINVOKE(F,astSlaMapId_)
#endif

#if defined(astCLASS)            /* Protected */

/* Initialiser. */
#define astInitSlaMap(mem,size,init,vtab,name,flags) \
astINVOKE(O,astInitSlaMap_(mem,size,init,vtab,name,flags,STATUS_PTR))

/* Vtab Initialiser. */
#define astInitSlaMapVtab(vtab,name) astINVOKE(V,astInitSlaMapVtab_(vtab,name,STATUS_PTR))
/* Loader. */
#define astLoadSlaMap(mem,size,vtab,name,channel) \
astINVOKE(O,astLoadSlaMap_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
#endif

/* Interfaces to public member functions. */
/* -------------------------------------- */
/* Here we make use of astCheckSlaMap to validate SlaMap pointers
   before use.  This provides a contextual error report if a pointer
   to the wrong sort of Object is supplied. */
#define astSlaAdd(this,cvt,narg,args) \
astINVOKE(V,astSlaAdd_(astCheckSlaMap(this),cvt,narg,args,STATUS_PTR))

#if defined(astCLASS)            /* Protected */
#define astSTPConv astSTPConv_
#define astSTPConv1 astSTPConv1_
#define astSlaIsEmpty(this) astINVOKE(V,astSlaIsEmpty_(astCheckSlaMap(this),STATUS_PTR))
#endif

#endif