WCSLIB 8.2.2
|
Spectral transformation parameters. More...
#include <spc.h>
Data Fields | |
int | flag |
char | type [8] |
char | code [4] |
double | crval |
double | restfrq |
double | restwav |
double | pv [7] |
double | w [6] |
int | isGrism |
int | padding1 |
struct wcserr * | err |
void * | padding2 |
int(* | spxX2P )(SPX_ARGS) |
int(* | spxP2S )(SPX_ARGS) |
int(* | spxS2P )(SPX_ARGS) |
int(* | spxP2X )(SPX_ARGS) |
Spectral transformation parameters.
The spcprm struct contains information required to transform spectral coordinates. It consists of certain members that must be set by the user (given) and others that are set by the WCSLIB routines (returned). Some of the latter are supplied for informational purposes while others are for internal use only.
int spcprm::flag |
char spcprm::type |
(Given) Four-letter spectral variable type, e.g "ZOPT" for CTYPEia
= 'ZOPT-F2W'
. (Declared as char[8] for alignment reasons.)
char spcprm::code |
(Given) Three-letter spectral algorithm code, e.g "F2W" for CTYPEia
= 'ZOPT-F2W'
.
double spcprm::crval |
(Given) Reference value (CRVALia
), SI units.
double spcprm::restfrq |
(Given) The rest frequency [Hz], and ...
double spcprm::restwav |
(Given) ... the rest wavelength in vacuo [m], only one of which need be given, the other should be set to zero. Neither are required if the and spectral variables are both wave-characteristic, or both velocity-characteristic, types.
double spcprm::pv |
(Given) Grism parameters for 'GRI
' and 'GRA
' algorithm codes:
The remaining members of the spcprm struct are maintained by spcset() and must not be modified elsewhere:
double spcprm::w |
(Returned) Intermediate values:
The remainder are grism intermediates.
int spcprm::isGrism |
(Returned) Grism coordinates?
int spcprm::padding1 |
(An unused variable inserted for alignment purposes only.)
struct wcserr * spcprm::err |
(Returned) If enabled, when an error status is returned, this struct contains detailed information about the error, see wcserr_enable().
void * spcprm::padding2 |
(An unused variable inserted for alignment purposes only.)
spcprm::spxX2P |
(Returned) The first and ...
spcprm::spxP2S |
(Returned) ... the second of the pointers to the transformation functions in the two-step algorithm chain in the pixel-to-spectral direction where the non-linear transformation is from to . The argument list, SPX_ARGS, is defined in spx.h.
spcprm::spxS2P |
(Returned) The first and ...
spcprm::spxP2X |
(Returned) ... the second of the pointers to the transformation functions in the two-step algorithm chain in the spectral-to-pixel direction where the non-linear transformation is from to . The argument list, SPX_ARGS, is defined in spx.h.