FORS Pipeline Reference Manual  5.0.9
Data Structures | Macros | Functions | Variables
World_Coordinate_Systems

Data Structures

struct  _fors_cpl_wcs_
 

Macros

#define DEGRAD   57.2957795130823229
 
#define WCSLIB_ERRCODE_MAX   9
 

Functions

static fors_cpl_wcsfors_cpl_wcs_init (void)
 Create an empty wcs structure. More...
 
static char * fors_cpl_wcs_plist2fitsstr (const cpl_propertylist *self, int *nkeys)
 Convert a propertylist to a FITS string. More...
 
static cpl_propertylist * fors_cpl_wcs_fitsstr2plist (char *fitsstr)
 Convert a FITS string to a propertylist. More...
 
static int fors_ffhdr2str (fitsfile *fptr, int exclude_comm, char **exclist, int nexc, char **header, int *nkeys, int *status)
 
fors_cpl_wcsfors_cpl_wcs_new_from_propertylist (const cpl_propertylist *plist)
 
void fors_cpl_wcs_delete (fors_cpl_wcs *wcs)
 Destroy a WCS structure. More...
 
cpl_error_code fors_cpl_wcs_convert (const fors_cpl_wcs *wcs, const cpl_matrix *from, cpl_matrix **to, cpl_array **status, fors_cpl_wcs_trans_mode transform)
 

Variables

static char * wcslib_errmsgs [WCSLIB_ERRCODE_MAX+1]
 

Detailed Description

This module provides functions to manipulate FITS World Coordinate Systems

A fors_cpl_wcs is an object containing a pointer to the WCSLIB structure and the physical dimensions of the image from which the WCS was read. The functionality provided includes general transformations between physical and world coordinates as well as a few conveience routines for x,y <=> RA,Dec transformations.

Synopsis:
#include "fors_cpl_wcs.h"

Function Documentation

static fors_cpl_wcs * fors_cpl_wcs_init ( void  )
static

Create an empty wcs structure.

Returns
The output wcs structure

None

This is a static routine that creates an empty fors_cpl_wcs structure.

Definition at line 569 of file fors_cpl_wcs.c.

static char * fors_cpl_wcs_plist2fitsstr ( const cpl_propertylist *  self,
int *  nkeys 
)
static

Convert a propertylist to a FITS string.

Parameters
selfThe input propertylist
Returns
The output character string with the properties formatted as in a FITS header.
CPL_ERROR_NULL_INPUT The parameter self is a NULL pointer.

This converts a propertylist into a single string with all properties formatted as FITS cards. This is needed for wcspih. The output string must be freed by the calling routine.

Definition at line 613 of file fors_cpl_wcs.c.

static cpl_propertylist * fors_cpl_wcs_fitsstr2plist ( char *  fitsstr)
static

Convert a FITS string to a propertylist.

Parameters
fitsstrThe input FITS header string
Returns
The output propertylist.
CPL_ERROR_NULL_INPUT The parameter fitsstr is a NULL pointer.

This converts a single string formatted with FITS cards into a propertylist. This is needed for wcspih. The output propertylist must be freed by the calling routine

Definition at line 682 of file fors_cpl_wcs.c.

void fors_cpl_wcs_delete ( fors_cpl_wcs wcs)

Destroy a WCS structure.

Parameters
wcsThe WCS structure to destroy
Returns
Nothing.

The function destroys the WCS structure wcs and its whole contents.

Definition at line 367 of file fors_cpl_wcs.c.

Variable Documentation

char* wcslib_errmsgs[WCSLIB_ERRCODE_MAX+1]
static
Initial value:
= {
"",
"WCSLIB undefined input structure pointer",
"WCSLIB unable to allocate required memory",
"WCSLIB linear transformation matrix is singular",
"WCSLIB invalid coordinate axis types",
"WCSLIB invalid parameter value",
"WCSLIB invalid coordinate transformation parameters",
"WCSLIB Ill-conditioned coordinate transformation parameters",
"WCSLIB One or more input coordinates invalid",
"WCSLIB One or more input coordinates invalid"}

Definition at line 108 of file fors_cpl_wcs.c.