cel.h File Reference

#include "prj.h"
#include "wcserr.h"

Go to the source code of this file.

Data Structures

struct  celprm
 Celestial transformation parameters. More...

Defines

#define CELLEN   (sizeof(struct celprm)/sizeof(int))
 Size of the celprm struct in int units.
#define celini_errmsg   cel_errmsg
 Deprecated.
#define celprt_errmsg   cel_errmsg
 Deprecated.
#define celset_errmsg   cel_errmsg
 Deprecated.
#define celx2s_errmsg   cel_errmsg
 Deprecated.
#define cels2x_errmsg   cel_errmsg
 Deprecated.

Enumerations

enum  cel_errmsg_enum {
  CELERR_SUCCESS = 0, CELERR_NULL_POINTER = 1, CELERR_BAD_PARAM = 2, CELERR_BAD_COORD_TRANS = 3,
  CELERR_ILL_COORD_TRANS = 4, CELERR_BAD_PIX = 5, CELERR_BAD_WORLD = 6
}

Functions

int celini (struct celprm *cel)
 Default constructor for the celprm struct.
int celfree (struct celprm *cel)
 Destructor for the celprm struct.
int celprt (const struct celprm *cel)
 Print routine for the celprm struct.
int celset (struct celprm *cel)
 Setup routine for the celprm struct.
int celx2s (struct celprm *cel, int nx, int ny, int sxy, int sll, const double x[], const double y[], double phi[], double theta[], double lng[], double lat[], int stat[])
 Pixel-to-world celestial transformation.
int cels2x (struct celprm *cel, int nlng, int nlat, int sll, int sxy, const double lng[], const double lat[], double phi[], double theta[], double x[], double y[], int stat[])
 World-to-pixel celestial transformation.

Variables

const char * cel_errmsg []

Detailed Description

These routines implement the part of the FITS World Coordinate System (WCS) standard that deals with celestial coordinates. They define methods to be used for computing celestial world coordinates from intermediate world coordinates (a linear transformation of image pixel coordinates), and vice versa. They are based on the celprm struct which contains all information needed for the computations. This struct contains some elements that must be set by the user, and others that are maintained by these routines, somewhat like a C++ class but with no encapsulation.

Routine celini() is provided to initialize the celprm struct with default values, celfree() reclaims any memory that may have been allocated to store an error message, and celprt() prints its contents.

A setup routine, celset(), computes intermediate values in the celprm struct from parameters in it that were supplied by the user. The struct always needs to be set up by celset() but it need not be called explicitly - refer to the explanation of celprm::flag.

celx2s() and cels2x() implement the WCS celestial coordinate transformations. In fact, they are high level driver routines for the lower level spherical coordinate rotation and projection routines described in sph.h and prj.h.

Define Documentation

#define CELLEN   (sizeof(struct celprm)/sizeof(int))

Size of the celprm struct in int units, used by the Fortran wrappers.

#define celini_errmsg   cel_errmsg

Deprecated:
Added for backwards compatibility, use cel_errmsg directly now instead.

#define celprt_errmsg   cel_errmsg

Deprecated:
Added for backwards compatibility, use cel_errmsg directly now instead.

#define celset_errmsg   cel_errmsg

Deprecated:
Added for backwards compatibility, use cel_errmsg directly now instead.

#define celx2s_errmsg   cel_errmsg

Deprecated:
Added for backwards compatibility, use cel_errmsg directly now instead.

#define cels2x_errmsg   cel_errmsg

Deprecated:
Added for backwards compatibility, use cel_errmsg directly now instead.

Enumeration Type Documentation

enum cel_errmsg_enum

Enumerator:
CELERR_SUCCESS 
CELERR_NULL_POINTER 
CELERR_BAD_PARAM 
CELERR_BAD_COORD_TRANS 
CELERR_ILL_COORD_TRANS 
CELERR_BAD_PIX 
CELERR_BAD_WORLD 

Function Documentation

int celini ( struct celprm *  cel  ) 

celini() sets all members of a celprm struct to default values. It should be used to initialize every celprm struct.

Parameters:
[out] cel Celestial transformation parameters.
Returns:
Status return value:
  • 0: Success.
  • 1: Null celprm pointer passed.

int celfree ( struct celprm *  cel  ) 

celfree() frees any memory that may have been allocated to store an error message in the celprm struct.

Parameters:
[in] cel Celestial transformation parameters.
Returns:
Status return value:
  • 0: Success.
  • 1: Null celprm pointer passed.

int celprt ( const struct celprm *  cel  ) 

celprt() prints the contents of a celprm struct using wcsprintf(). Mainly intended for diagnostic purposes.

Parameters:
[in] cel Celestial transformation parameters.
Returns:
Status return value:
  • 0: Success.
  • 1: Null celprm pointer passed.

int celset ( struct celprm *  cel  ) 

celset() sets up a celprm struct according to information supplied within it.

Note that this routine need not be called directly; it will be invoked by celx2s() and cels2x() if celprm::flag is anything other than a predefined magic value.

Parameters:
[in,out] cel Celestial transformation parameters.
Returns:
Status return value:
  • 0: Success.
  • 1: Null celprm pointer passed.
  • 2: Invalid projection parameters.
  • 3: Invalid coordinate transformation parameters.
  • 4: Ill-conditioned coordinate transformation parameters.
For returns > 1, a detailed error message is set in celprm::err if enabled, see wcserr_enable().

int celx2s ( struct celprm *  cel,
int  nx,
int  ny,
int  sxy,
int  sll,
const double  x[],
const double  y[],
double  phi[],
double  theta[],
double  lng[],
double  lat[],
int  stat[] 
)

celx2s() transforms $(x,y)$ coordinates in the plane of projection to celestial coordinates $(\alpha,\delta)$.

Parameters:
[in,out] cel Celestial transformation parameters.
[in] nx,ny Vector lengths.
[in] sxy,sll Vector strides.
[in] x,y Projected coordinates in pseudo "degrees".
[out] phi,theta Longitude and latitude $(\phi,\theta)$ in the native coordinate system of the projection [deg].
[out] lng,lat Celestial longitude and latitude $(\alpha,\delta)$ of the projected point [deg].
[out] stat Status return value for each vector element:
  • 0: Success.
  • 1: Invalid value of $(x,y)$.
Returns:
Status return value:
  • 0: Success.
  • 1: Null celprm pointer passed.
  • 2: Invalid projection parameters.
  • 3: Invalid coordinate transformation parameters.
  • 4: Ill-conditioned coordinate transformation parameters.
  • 5: One or more of the $(x,y)$ coordinates were invalid, as indicated by the stat vector.
For returns > 1, a detailed error message is set in celprm::err if enabled, see wcserr_enable().

int cels2x ( struct celprm *  cel,
int  nlng,
int  nlat,
int  sll,
int  sxy,
const double  lng[],
const double  lat[],
double  phi[],
double  theta[],
double  x[],
double  y[],
int  stat[] 
)

cels2x() transforms celestial coordinates $(\alpha,\delta)$ to $(x,y)$ coordinates in the plane of projection.

Parameters:
[in,out] cel Celestial transformation parameters.
[in] nlng,nlat Vector lengths.
[in] sll,sxy Vector strides.
[in] lng,lat Celestial longitude and latitude $(\alpha,\delta)$ of the projected point [deg].
[out] phi,theta Longitude and latitude $(\phi,\theta)$ in the native coordinate system of the projection [deg].
[out] x,y Projected coordinates in pseudo "degrees".
[out] stat Status return value for each vector element:
  • 0: Success.
  • 1: Invalid value of $(\alpha,\delta)$.
Returns:
Status return value:
  • 0: Success.
  • 1: Null celprm pointer passed.
  • 2: Invalid projection parameters.
  • 3: Invalid coordinate transformation parameters.
  • 4: Ill-conditioned coordinate transformation parameters.
  • 6: One or more of the $(\alpha,\delta)$ coordinates were invalid, as indicated by the stat vector.
For returns > 1, a detailed error message is set in celprm::err if enabled, see wcserr_enable().

Variable Documentation

const char* cel_errmsg[]

Generated on Mon Apr 2 17:55:23 2012 for WCSLIB 4.13.4 by  doxygen 1.5.6