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 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
|
#if !defined( PCDMAP_INCLUDED ) /* Include this file only once */
#define PCDMAP_INCLUDED
/*
*+
* Name:
* pcdmap.h
* Type:
* C include file.
* Purpose:
* Define the interface to the PcdMap class.
* Invocation:
* #include "pcdmap.h"
* Description:
* This include file defines the interface to the PcdMap class and
* provides the type definitions, function prototypes and macros,
* etc. needed to use this class.
*
* The PcdMap class implements Mappings which perform pincushion
* distortion.
* Inheritance:
* The PcdMap class inherits from the Mapping class.
* Attributes Over-Ridden:
* None.
* New Attributes Defined:
* Disco (double)
* This attribute holds the PcdMap distortion coefficient used by
* the forward transformation. This coefficient is set when a
* PcdMap is created, but may later be modified. The default value
* is zero, which gives no distortion. For pincushion distortion,
* the supplied value should be positive. For barrel distortion, it
* should be negative.
*
* Note that the forward transformation of a PcdMap applies the
* distortion corresponding to this attribute, and the inverse
* transformation removes this distortion. If a PcdMap is inverted
* (e.g. by using astInvert), then the forward transformation will
* remove the distortion and the inverse transformation will apply
* it. The distortion itself will still be given by the same value of
* Disco.
* PcdCen(axis)
* This attribute specifies the centre of a pincushion distortion.
* It takes a separate value for each axis of the PcdMap so that, for
* instance, the settings "PcdCen(1)=345.0,PcdCen(2)=-104.4" specify
* that the pincushion distortion is centred at values of 345.0 and
* -104.4 on axes 1 and 2 of the PcdMap. The default for both axes is
* zero.
* Methods Over-Ridden:
* Public:
* None.
*
* Protected:
* astClearAttrib
* Clear an attribute value for a PcdMap.
* astGetAttrib
* Get an attribute value for a PcdMap.
* astSetAttrib
* Set an attribute value for a PcdMap.
* astTestAttrib
* Test if an attribute value has been set for a PcdMap.
* astTransform
* Apply a PcdMap to transform a set of points.
* New Methods Defined:
* Public:
* None.
*
* Protected:
* astClearDisco
* Clear the Disco attribute value for a PcdMap.
* astGetDisco
* Get the Disco attribute value for a PcdMap.
* astSetDisco
* Set the Disco attribute value for a PcdMap.
* astTestDisco
* Test if a Disco attribute value has been set for a PcdMap.
* astClearPcdCen
* Clear the PcdCen attribute value for a PcdMap.
* astGetPcdCen
* Get the PcdCen attribute value for a PcdMap.
* astSetPcdCen
* Set the PcdCen attribute value for a PcdMap.
* astTestPcdCen
* Test if a PcdCen attribute value has been set for a PcdMap.
* Other Class Functions:
* Public:
* astIsAPcdMap
* Test class membership.
* astPcdMap
* Create a PcdMap.
*
* Protected:
* astCheckPcdMap
* Validate class membership.
* astInitPcdMap
* Initialise a PcdMap.
* astInitPcdMapVtab
* Initialise the virtual function table for the PcdMap class.
* astLoadPcdMap
* Load a PcdMap.
* Macros:
* None.
* Type Definitions:
* Public:
* AstPcdMap
* PcdMap object type.
*
* Protected:
* AstPcdMapVtab
* PcdMap 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:
* DSB: David S. Berry (Starlink)
* History:
* 18-MAY-1999 (DSB):
* Original version.
* 8-JAN-2003 (DSB):
* Added protected astInitPcdMapVtab method.
*-
*/
/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */
#include "mapping.h" /* Coordinate mappings (parent class) */
#if defined(astCLASS) /* Protected */
#include "channel.h" /* I/O channels */
#endif
/* C header files. */
/* --------------- */
#if defined(astCLASS) /* Protected */
#include <stddef.h>
#endif
/* Macros */
/* ====== */
/* Define a dummy __attribute__ macro for use on non-GNU compilers. */
#ifndef __GNUC__
# define __attribute__(x) /*NOTHING*/
#endif
/* Type Definitions. */
/* ================= */
/* PcdMap structure. */
/* ------------------ */
/* This structure contains all information that is unique to each object in
the class (e.g. its instance variables). */
typedef struct AstPcdMap {
/* Attributes inherited from the parent class. */
AstMapping mapping; /* Parent class structure */
/* Attributes specific to objects in this class. */
double disco; /* Distortion coefficient */
double pcdcen[2]; /* Distortion centre */
} AstPcdMap;
/* 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 AstPcdMapVtab {
/* 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. */
double (*GetDisco)( AstPcdMap *, int * );
int (* TestDisco)( AstPcdMap *, int * );
void (* ClearDisco)( AstPcdMap *, int * );
void (* SetDisco)( AstPcdMap *, double, int * );
double (*GetPcdCen)( AstPcdMap *, int, int * );
int (* TestPcdCen)( AstPcdMap *, int, int * );
void (* ClearPcdCen)( AstPcdMap *, int, int * );
void (* SetPcdCen)( AstPcdMap *, int, double, int * );
} AstPcdMapVtab;
#if defined(THREAD_SAFE)
/* Define a structure holding all data items that are global within this
class. */
typedef struct AstPcdMapGlobals {
/* Define the thread-specific globals. */
char GetAttrib_Buff[ 101 ];
AstPcdMapVtab Class_Vtab;
int Class_Init;
} AstPcdMapGlobals;
#endif
#endif
/* Function prototypes. */
/* ==================== */
/* Prototypes for standard class functions. */
/* ---------------------------------------- */
astPROTO_CHECK(PcdMap) /* Check class membership */
astPROTO_ISA(PcdMap) /* Test class membership */
/* Constructor. */
#if defined(astCLASS) /* Protected. */
AstPcdMap *astPcdMap_( double, const double [2], const char *, int *, ...);
#else
AstPcdMap *astPcdMapId_( double, const double [2], const char *, ... )__attribute__((format(printf,3,4)));
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
AstPcdMap *astInitPcdMap_( void *, size_t, int, AstPcdMapVtab *,
const char *, double, const double [2], int * );
/* Vtab initialiser. */
void astInitPcdMapVtab_( AstPcdMapVtab *, const char *, int * );
/* Loader. */
AstPcdMap *astLoadPcdMap_( void *, size_t, AstPcdMapVtab *,
const char *, AstChannel *, int * );
/* Thread-safe initialiser for all global data used by this module. */
#if defined(THREAD_SAFE)
void astInitPcdMapGlobals_( AstPcdMapGlobals * );
#endif
#endif
/* Prototypes for member functions. */
/* -------------------------------- */
# if defined(astCLASS) /* Protected */
double astGetDisco_( AstPcdMap *, int * );
int astTestDisco_( AstPcdMap *, int * );
void astClearDisco_( AstPcdMap *, int * );
void astSetDisco_( AstPcdMap *, double, int * );
double astGetPcdCen_( AstPcdMap *, int, int * );
int astTestPcdCen_( AstPcdMap *, int, int * );
void astClearPcdCen_( AstPcdMap *, int, int * );
void astSetPcdCen_( AstPcdMap *, int, double, int * );
#endif
/* 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 astCheckPcdMap(this) astINVOKE_CHECK(PcdMap,this,0)
#define astVerifyPcdMap(this) astINVOKE_CHECK(PcdMap,this,1)
/* Test class membership. */
#define astIsAPcdMap(this) astINVOKE_ISA(PcdMap,this)
/* Constructor. */
#if defined(astCLASS) /* Protected. */
#define astPcdMap astINVOKE(F,astPcdMap_)
#else
#define astPcdMap astINVOKE(F,astPcdMapId_)
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
#define astInitPcdMap(mem,size,init,vtab,name,disco,pcdcen) \
astINVOKE(O,astInitPcdMap_(mem,size,init,vtab,name,disco,pcdcen,STATUS_PTR))
/* Vtab Initialiser. */
#define astInitPcdMapVtab(vtab,name) astINVOKE(V,astInitPcdMapVtab_(vtab,name,STATUS_PTR))
/* Loader. */
#define astLoadPcdMap(mem,size,vtab,name,channel) \
astINVOKE(O,astLoadPcdMap_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
#endif
/* Interfaces to public member functions. */
/* -------------------------------------- */
/* Here we make use of astCheckPcdMap to validate PcdMap pointers
before use. This provides a contextual error report if a pointer
to the wrong sort of Object is supplied. */
#if defined(astCLASS) /* Protected */
#define astClearDisco(this) astINVOKE(V,astClearDisco_(astCheckPcdMap(this),STATUS_PTR))
#define astGetDisco(this) astINVOKE(V,astGetDisco_(astCheckPcdMap(this),STATUS_PTR))
#define astSetDisco(this,value) \
astINVOKE(V,astSetDisco_(astCheckPcdMap(this),value,STATUS_PTR))
#define astTestDisco(this) astINVOKE(V,astTestDisco_(astCheckPcdMap(this),STATUS_PTR))
#define astClearPcdCen(this,axis) \
astINVOKE(V,astClearPcdCen_(astCheckPcdMap(this),axis,STATUS_PTR))
#define astGetPcdCen(this,axis) \
astINVOKE(V,astGetPcdCen_(astCheckPcdMap(this),axis,STATUS_PTR))
#define astSetPcdCen(this,axis,value) \
astINVOKE(V,astSetPcdCen_(astCheckPcdMap(this),axis,value,STATUS_PTR))
#define astTestPcdCen(this,axis) \
astINVOKE(V,astTestPcdCen_(astCheckPcdMap(this),axis,STATUS_PTR))
#endif
#endif
|