HAWKI Pipeline Reference Manual 1.8.12
Functions
Basic calibration Utilities

Functions

int hawki_bkg_imglist_calib (cpl_imagelist *ilist, cpl_imagelist *bkg)
 Apply the background subtraction to the images.
int hawki_bpm_calib (cpl_image *ima, const char *bpm, int idet)
 Apply the BPM correction to an image.
int hawki_flat_bpm_detector_calib (cpl_imagelist *ilist, cpl_image *flat, cpl_image *bpm)
 Apply the calibration to the images.
int hawki_flat_bpm_imglist_calib (cpl_imagelist *ilist, cpl_imagelist *flat, cpl_imagelist *bpm)
 Apply the calibration to the images.
int hawki_flat_dark_bpm_detector_calib (cpl_imagelist *ilist, cpl_image *flat, cpl_image *dark, cpl_image *bpm)
 Apply the calibration to the images.
int hawki_flat_dark_bpm_imglist_calib (cpl_imagelist *ilist, cpl_imagelist *flat, cpl_imagelist *dark, cpl_imagelist *bpm)
 Apply the calibration to the images.
cpl_imagelist * hawki_trim_detector_calib (cpl_imagelist *imalist, int nborder)
 Trim a list of hawki images (usually from one detector)

Function Documentation

int hawki_bkg_imglist_calib ( cpl_imagelist *  ilist,
cpl_imagelist *  bkg 
)

Apply the background subtraction to the images.

Parameters:
ilistthe input image list
bkgthe background images
Returns:
0 if everything is ok, -1 otherwise

Definition at line 226 of file hawki_calib.c.

int hawki_bpm_calib ( cpl_image *  ima,
const char *  bpm,
int  idet 
)

Apply the BPM correction to an image.

Parameters:
imathe image to correct
idetthe detector the image comes from
bpmthe bad pixels map
Returns:
0 if everything is ok, -1 otherwise

Definition at line 450 of file hawki_calib.c.

References hawki_get_ext_from_detector().

int hawki_flat_bpm_detector_calib ( cpl_imagelist *  ilist,
cpl_image *  flat,
cpl_image *  bpm 
)

Apply the calibration to the images.

Parameters:
ilistthe input image list
flatthe flat field
bpmthe bad pixels map
idetthe detector id
Returns:
0 if everything is ok, -1 otherwise

This function takes as an input a list of images which in principle should belong to the same HAWK-I detector. It also takes as an input an image for the flat, the dark and bpm for that detector. It is the responsability of the caller to ensure that the detector of all these inputs is the same. For dark and flat corrections the formula is as follows:

\[ bc = \frac{(raw-dark)}{flat}\]

Definition at line 354 of file hawki_calib.c.

int hawki_flat_bpm_imglist_calib ( cpl_imagelist *  ilist,
cpl_imagelist *  flat,
cpl_imagelist *  bpm 
)

Apply the calibration to the images.

Parameters:
ilistthe input image list
flatthe flat field
bpmthe bad pixels map
Returns:
0 if everything is ok, -1 otherwise

This function takes as an input an image list that contains four images, one for each HAWK-I detector and the same for the flat and bpm. It applies the 2 corrections (if images are not null) to each detector.

Definition at line 161 of file hawki_calib.c.

int hawki_flat_dark_bpm_detector_calib ( cpl_imagelist *  ilist,
cpl_image *  flat,
cpl_image *  dark,
cpl_image *  bpm 
)

Apply the calibration to the images.

Parameters:
ilistthe input image list
flatthe flat field
darkthe dark (scaled to exp time of the science images)
bpmthe bad pixels map
idetthe detector id.
Returns:
0 if everything is ok, -1 otherwise

This function takes as an input a list of images which in principle should belong to the same HAWK-I detector. It also takes as an input an image for the flat, the dark and bpm for that detector. It is the responsibility of the caller to ensure that the detector of all these inputs is the same. Take into account that the dark is just subtracted, no scaling is done. For dark and flat corrections the formula is as follows:

\[ bc = \frac{(raw-dark)}{flat}\]

Definition at line 276 of file hawki_calib.c.

int hawki_flat_dark_bpm_imglist_calib ( cpl_imagelist *  ilist,
cpl_imagelist *  flat,
cpl_imagelist *  dark,
cpl_imagelist *  bpm 
)

Apply the calibration to the images.

Parameters:
ilistthe input image list
flatthe flat field
darkthe dark (scaled to exp time of the science images)
bpmthe bad pixels map
Returns:
0 if everything is ok, -1 otherwise

This function takes as an input an image list that contains four images, one for each HAWK-I detector and the same for the flat, dark and bpm. It applies the 3 corrections (if images are not null) to each detector. Take into account that the dark is just subtracted, no scaling is done. For dark and flat corrections the formula is as follows:

\[ bc = \frac{(raw-dark)}{flat}\]

Definition at line 73 of file hawki_calib.c.

cpl_imagelist* hawki_trim_detector_calib ( cpl_imagelist *  imalist,
int  nborder 
)

Trim a list of hawki images (usually from one detector)

Parameters:
ilistThe image list
nborderThe number of pixels to trim in each border
Returns:
The trimmed images. NULL otherwise

Not that the original ilist is emptied, but the user is still responsible to deallocate it with cpl_imagelist_delete()

Definition at line 413 of file hawki_calib.c.