vircam_pfits
[Groups of Support Routines]

Detailed Description

These are support routines used for extracting information from FITS headers.

Author:
Jim Lewis, CASU


Functions

int vircam_pfits_get_crval1 (const cpl_propertylist *plist, double *crval1)
 Get the value of crval1.
int vircam_pfits_get_crpix1 (const cpl_propertylist *plist, double *crpix1)
 Get the value of crpix1.
int vircam_pfits_get_crval2 (const cpl_propertylist *plist, double *crval2)
 Get the value of crval2.
int vircam_pfits_get_crpix2 (const cpl_propertylist *plist, double *crpix2)
 Get the value of crpix2.
int vircam_pfits_get_cd11 (const cpl_propertylist *plist, double *cd11)
 Get the value of cd1_1.
int vircam_pfits_get_cd12 (const cpl_propertylist *plist, double *cd12)
 Get the value of cd1_2.
int vircam_pfits_get_cd21 (const cpl_propertylist *plist, double *cd21)
 Get the value of cd2_1.
int vircam_pfits_get_cd22 (const cpl_propertylist *plist, double *cd22)
 Get the value of cd2_2.
int vircam_pfits_get_pv21 (const cpl_propertylist *plist, double *pv21)
 Get the value of pv2_1.
int vircam_pfits_get_pv23 (const cpl_propertylist *plist, double *pv23)
 Get the value of pv2_3.
int vircam_pfits_get_exptime (const cpl_propertylist *plist, float *exptime)
 Get the value of exposure time.
int vircam_pfits_get_mindit (const cpl_propertylist *plist, float *mindit)
 Get the value of mindit time.
int vircam_pfits_get_ditdelay (const cpl_propertylist *plist, float *ditdelay)
 Get the value of dit delay time.
int vircam_pfits_get_naxis1 (const cpl_propertylist *plist, long *naxis1)
 Get the value of naxis1.
int vircam_pfits_get_naxis2 (const cpl_propertylist *plist, long *naxis2)
 Get the value of naxis2.
int vircam_pfits_get_chipno (const cpl_propertylist *plist, int *chipno)
 Get the value of chipno.
int vircam_pfits_get_jxoff (const cpl_propertylist *plist, float *xoff)
 Get the value of the X jitter offset.
int vircam_pfits_get_jyoff (const cpl_propertylist *plist, float *yoff)
 Get the value of the Y jitter offset.
int vircam_pfits_get_airmass (const cpl_propertylist *plist, float *airmass)
 Get the value of the airmass.
int vircam_pfits_get_nusteps (const cpl_propertylist *plist, int *nusteps)
 Get the value of the number of microsteps in a sequence.
int vircam_pfits_get_ustepnum (const cpl_propertylist *plist, int *ustepnum)
 Get the value of the first run number in the current microstep sequence.
int vircam_pfits_get_jitternum (const cpl_propertylist *plist, int *jitternum)
 Get the value of the first run number in the current jitter sequence.
int vircam_pfits_get_ndit (const cpl_propertylist *plist, int *ndit)
 Get the value of NDIT.
int vircam_pfits_get_detlive (const cpl_propertylist *plist, int *detlive)
 Get the value of DET_LIVE.
int vircam_pfits_get_filter (const cpl_propertylist *plist, char *filt)
 Get the name of the current filter.
int vircam_pfits_get_saturation (const cpl_propertylist *plist, float *saturation)
 Get the saturation level for this detector.
int vircam_pfits_get_gain (const cpl_propertylist *plist, float *gain)
 Get the value of the detector gain.
int vircam_pfits_get_mjd (const cpl_propertylist *plist, double *mjd)
 Get the value of the modified Julian date.

Function Documentation

int vircam_pfits_get_airmass ( const cpl_propertylist *  plist,
float *  airmass 
)

Get the value of the airmass.

Parameters:
plist property list to read from
airmass requested value of the airmass
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 372 of file vircam_pfits.c.

Referenced by vircam_illum(), and vircam_photcal().

int vircam_pfits_get_cd11 ( const cpl_propertylist *  plist,
double *  cd11 
)

Get the value of cd1_1.

Parameters:
plist property list to read from
cd11 requested value of cd1_1
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 132 of file vircam_pfits.c.

int vircam_pfits_get_cd12 ( const cpl_propertylist *  plist,
double *  cd12 
)

Get the value of cd1_2.

Parameters:
plist property list to read from
cd12 requested value of cd1_2
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 146 of file vircam_pfits.c.

int vircam_pfits_get_cd21 ( const cpl_propertylist *  plist,
double *  cd21 
)

Get the value of cd2_1.

Parameters:
plist property list to read from
cd21 requested value of cd2_1
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 161 of file vircam_pfits.c.

int vircam_pfits_get_cd22 ( const cpl_propertylist *  plist,
double *  cd22 
)

Get the value of cd2_2.

Parameters:
plist property list to read from
cd22 requested value of cd2_2
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 175 of file vircam_pfits.c.

int vircam_pfits_get_chipno ( const cpl_propertylist *  plist,
int *  chipno 
)

Get the value of chipno.

Parameters:
plist property list to read from
chipno requested value of chipno
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 316 of file vircam_pfits.c.

int vircam_pfits_get_crpix1 ( const cpl_propertylist *  plist,
double *  crpix1 
)

Get the value of crpix1.

Parameters:
plist property list to read from
crpix1 requested value of crpix1
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 85 of file vircam_pfits.c.

Referenced by vircam_imdither().

int vircam_pfits_get_crpix2 ( const cpl_propertylist *  plist,
double *  crpix2 
)

Get the value of crpix2.

Parameters:
plist property list to read from
crpix2 requested value of crpix2
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 117 of file vircam_pfits.c.

Referenced by vircam_imdither().

int vircam_pfits_get_crval1 ( const cpl_propertylist *  plist,
double *  crval1 
)

Get the value of crval1.

Parameters:
plist property list to read from
crval1 requested value of crval1
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 68 of file vircam_pfits.c.

int vircam_pfits_get_crval2 ( const cpl_propertylist *  plist,
double *  crval2 
)

Get the value of crval2.

Parameters:
plist property list to read from
crval2 requested value of crval2
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 101 of file vircam_pfits.c.

int vircam_pfits_get_detlive ( const cpl_propertylist *  plist,
int *  detlive 
)

Get the value of DET_LIVE.

Parameters:
plist property list to read from
detlive requested value of DET_LIVE
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 489 of file vircam_pfits.c.

int vircam_pfits_get_ditdelay ( const cpl_propertylist *  plist,
float *  ditdelay 
)

Get the value of dit delay time.

Parameters:
plist property list to read from
ditdelay requested value of dit delay time
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 252 of file vircam_pfits.c.

Referenced by vircam_lincor().

int vircam_pfits_get_exptime ( const cpl_propertylist *  plist,
float *  exptime 
)

Get the value of exposure time.

Parameters:
plist property list to read from
exptime requested value of exptime
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 220 of file vircam_pfits.c.

Referenced by vircam_illum(), vircam_imcombine(), vircam_imdither(), vircam_lincor(), and vircam_photcal().

int vircam_pfits_get_filter ( const cpl_propertylist *  plist,
char *  filt 
)

Get the name of the current filter.

Parameters:
plist property list to read from
filt requested name of the filter
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 513 of file vircam_pfits.c.

Referenced by vircam_jmp_illum(), and vircam_jmp_photcal().

int vircam_pfits_get_gain ( const cpl_propertylist *  plist,
float *  gain 
)

Get the value of the detector gain.

Parameters:
plist property list to read from
gain requested value of the gain
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 559 of file vircam_pfits.c.

int vircam_pfits_get_jitternum ( const cpl_propertylist *  plist,
int *  jitternum 
)

Get the value of the first run number in the current jitter sequence.

Parameters:
plist property list to read from
jitternum requested value of the jitter sequence number
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 440 of file vircam_pfits.c.

int vircam_pfits_get_jxoff ( const cpl_propertylist *  plist,
float *  xoff 
)

Get the value of the X jitter offset.

Parameters:
plist property list to read from
xoff requested value of the x offset
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 340 of file vircam_pfits.c.

Referenced by vircam_imdither().

int vircam_pfits_get_jyoff ( const cpl_propertylist *  plist,
float *  yoff 
)

Get the value of the Y jitter offset.

Parameters:
plist property list to read from
yoff requested value of the y offset
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 356 of file vircam_pfits.c.

Referenced by vircam_imdither().

int vircam_pfits_get_mindit ( const cpl_propertylist *  plist,
float *  mindit 
)

Get the value of mindit time.

Parameters:
plist property list to read from
mindit requested value of mindit time
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 236 of file vircam_pfits.c.

Referenced by vircam_lincor().

int vircam_pfits_get_mjd ( const cpl_propertylist *  plist,
double *  mjd 
)

Get the value of the modified Julian date.

Parameters:
plist property list to read from
mjd requested value of the mjd
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 574 of file vircam_pfits.c.

int vircam_pfits_get_naxis1 ( const cpl_propertylist *  plist,
long *  naxis1 
)

Get the value of naxis1.

Parameters:
plist property list to read from
naxis1 requested value of naxis1
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 268 of file vircam_pfits.c.

Referenced by vircam_platesol().

int vircam_pfits_get_naxis2 ( const cpl_propertylist *  plist,
long *  naxis2 
)

Get the value of naxis2.

Parameters:
plist property list to read from
naxis2 requested value of naxis2
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 292 of file vircam_pfits.c.

Referenced by vircam_platesol().

int vircam_pfits_get_ndit ( const cpl_propertylist *  plist,
int *  ndit 
)

Get the value of NDIT.

Parameters:
plist property list to read from
ndit requested value of ndit
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 465 of file vircam_pfits.c.

int vircam_pfits_get_nusteps ( const cpl_propertylist *  plist,
int *  nusteps 
)

Get the value of the number of microsteps in a sequence.

Parameters:
plist property list to read from
nusteps requested value of the number of microsteps
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 388 of file vircam_pfits.c.

Referenced by vircam_jmp_ustep_seq().

int vircam_pfits_get_pv21 ( const cpl_propertylist *  plist,
double *  pv21 
)

Get the value of pv2_1.

Parameters:
plist property list to read from
pv21 requested value of pv2_1
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 190 of file vircam_pfits.c.

int vircam_pfits_get_pv23 ( const cpl_propertylist *  plist,
double *  pv23 
)

Get the value of pv2_3.

Parameters:
plist property list to read from
pv23 requested value of pv2_3
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 205 of file vircam_pfits.c.

int vircam_pfits_get_saturation ( const cpl_propertylist *  plist,
float *  saturation 
)

Get the saturation level for this detector.

Parameters:
plist property list to read from
saturation requested name of the filter
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 533 of file vircam_pfits.c.

int vircam_pfits_get_ustepnum ( const cpl_propertylist *  plist,
int *  ustepnum 
)

Get the value of the first run number in the current microstep sequence.

Parameters:
plist property list to read from
ustepnum requested value of the microstep sequence number
Return values:
VIR_OK if everything went right
VIR_FATAL if there was an error

Definition at line 414 of file vircam_pfits.c.

Referenced by vircam_jmp_dither_offsets(), and vircam_jmp_ustep_seq().

Generated on Wed Apr 10 04:01:58 2013 for VIRCAM Pipeline by  doxygen 1.5.1