← Back to branch summary

~ubuntu-branches/ubuntu/utopic/wcslib/utopic

« back to all changes in this revision

Viewing changes to C/wcs.h

  • Committer: Package Import Robot
  • Author(s): Ole Streicher
  • Date: 2014-05-13 10:29:41 UTC
  • mfrom: (15.1.3 sid)
  • Revision ID: package-import@ubuntu.com-20140513102941-c8643128v6rews10
Tags: 4.23-1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
C/wcs.h
1
1
/*============================================================================
2
2
 
3
 
  WCSLIB 4.22 - an implementation of the FITS WCS standard.
 
3
  WCSLIB 4.23 - an implementation of the FITS WCS standard.
4
4
  Copyright (C) 1995-2014, Mark Calabretta
5
5
 
6
6
  This file is part of WCSLIB.
22
22
 
23
23
  Author: Mark Calabretta, Australia Telescope National Facility, CSIRO.
24
24
  http://www.atnf.csiro.au/people/Mark.Calabretta
25
 
  $Id: wcs.h,v 4.22 2014/04/12 15:03:52 mcalabre Exp $
 
25
  $Id: wcs.h,v 4.23 2014/05/13 05:50:51 mcalabre Exp $
26
26
*=============================================================================
27
27
*
28
 
* WCSLIB 4.22 - C routines that implement the FITS World Coordinate System
 
28
* WCSLIB 4.23 - C routines that implement the FITS World Coordinate System
29
29
* (WCS) standard.  Refer to
30
30
*
31
31
*   "Representations of world coordinates in FITS",
312
312
*   if any were specified on input).
313
313
*
314
314
*
 
315
* wcscompare() - Compare two wcsprm structs for equality
 
316
* ------------------------------------------------------
 
317
* wcscompare() compares two wcsprm structs for equality.
 
318
*
 
319
* Given:
 
320
*   cmp       int       A bit field controlling the strictness of the
 
321
*                       comparison.  When 0, all fields must be identical.
 
322
*
 
323
*                       The following constants may be or'ed together to
 
324
*                       relax the comparison:
 
325
*                         WCSCOMPARE_ANCILLARY: Ignore ancillary keywords
 
326
*                           that don't change the WCS transformation, such
 
327
*                           as DATE-OBS or EQUINOX.
 
328
*                         WCSCOMPARE_TILING: Ignore integral differences in
 
329
*                           CRPIXja.  This is the 'tiling' condition, where
 
330
*                           two WCSes cover different regions of the same
 
331
*                           map projection and align on the same map grid.
 
332
*                         WCSCOMPARE_CRPIX: Ignore any differences at all in
 
333
*                           CRPIXja.  The two WCSes cover different regions
 
334
*                           of the same map projection but may not align on
 
335
*                           the same grid map.  Overrides WCSCOMPARE_TILING.
 
336
*
 
337
*   wcs1      const struct wcsprm*
 
338
*                       The first wcsprm struct to compare.
 
339
*
 
340
*   wcs2      const struct wcsprm*
 
341
*                       The second wcsprm struct to compare.
 
342
*
 
343
* Returned:
 
344
*   equal     int*      Non-zero when the given structs are equal.
 
345
*
 
346
* Function return value:
 
347
*             int       Status return value:
 
348
*                         0: Success.
 
349
*                         1: Null pointer passed.
 
350
*
 
351
*
315
352
* wcscopy() macro - Copy routine for the wcsprm struct
316
353
* ----------------------------------------------------
317
354
* wcscopy() does a deep copy of one wcsprm struct to another.  As of
486
523
*   stat      int[ncoord]
487
524
*                       Status return value for each coordinate:
488
525
*                         0: Success.
489
 
*                         1+: A bit mask indicating invalid pixel coordinate
 
526
*                        1+: A bit mask indicating invalid pixel coordinate
490
527
*                            element(s).
491
528
*
492
529
* Function return value:
552
589
*   stat      int[ncoord]
553
590
*                       Status return value for each coordinate:
554
591
*                         0: Success.
555
 
*                         1+: A bit mask indicating invalid world coordinate
 
592
*                        1+: A bit mask indicating invalid world coordinate
556
593
*                            element(s).
557
594
*
558
595
* Function return value:
1346
1383
#define WCSSUB_STOKES    0x1010
1347
1384
 
1348
1385
 
 
1386
#define WCSCOMPARE_ANCILLARY 0x0001
 
1387
#define WCSCOMPARE_TILING    0x0002
 
1388
#define WCSCOMPARE_CRPIX     0x0004
 
1389
 
 
1390
 
1349
1391
extern const char *wcs_errmsg[];
1350
1392
 
1351
1393
enum wcs_errmsg_enum {
1369
1411
  WCSERR_NO_SOLUTION     = 11,  /* No solution found in the specified
1370
1412
                                   interval. */
1371
1413
  WCSERR_BAD_SUBIMAGE    = 12,  /* Invalid subimage specification. */
1372
 
  WCSERR_NON_SEPARABLE   = 13   /* Non-separable subimage coordinate
 
1414
  WCSERR_NON_SEPARABLE   = 13   /* Non-separable subimage coordinate
1373
1415
                                   system. */
1374
1416
};
1375
1417
 
1526
1568
int wcssub(int alloc, const struct wcsprm *wcssrc, int *nsub, int axes[],
1527
1569
           struct wcsprm *wcsdst);
1528
1570
 
 
1571
int wcscompare(int cmp, const struct wcsprm *wcs1, const struct wcsprm *wcs2,
 
1572
               int *equal);
 
1573
 
1529
1574
int wcsfree(struct wcsprm *wcs);
1530
1575
 
1531
1576
int wcsprt(const struct wcsprm *wcs);